README

Implementation of the PHP Content Repository API (PHPCR) using a relational database to persist data.

Jackalope uses Doctrine DBAL to abstract the database layer. It is currently tested to work with MySQL, PostgreSQL and SQLite.

For the moment, it is less feature complete, performant and robust than Jackalope-Jackrabbit but it can run on any server with PHP and an SQL database.

Discuss on jackalope-dev@googlegroups.com or visit #jackalope on irc.freenode.net

License

This code is dual licensed under the MIT license and the Apache License Version 2.0. Please see the file LICENSE in this folder.

Requirements

PHP version: See composer.json
One of the following databases, including the PDO extension for it:
- MySQL >= 5.1.5 (we need the ExtractValue function)
- PostgreSQL
- SQLite
- Oracle

Installation

The recommended way to install jackalope is through composer.

$ mkdir my-project
$ cd my-project
$ composer init
$ composer require jackalope/jackalope-doctrine-dbal

Create a repository

Set up a new database supported by Doctrine DBAL. You can use your favorite GUI frontend or use the following commands:

MySQL

Note that you need at least version 5.1.5 of MySQL, otherwise you will get SQLSTATE[42000]: Syntax error or access violation: 1305 FUNCTION cmf-app.EXTRACTVALUE does not exist

mysqladmin -u root -p  create database jackalope
echo "grant all privileges on jackalope.* to 'jackalope'@'localhost' identified by '1234test'; flush privileges;" | mysql -u root -p

Also note that with MySQL/MariaDB, you need to configure the encoding to be used (see "bootstrapping" below).

If you configured the encoding but still run into issues with the encoding, e.g. SQLSTATE[42000]: Syntax error or access violation: 1253 COLLATION 'utf8_bin' is not valid for CHARACTER SET 'utf8mb4', you can set the jackalope.case_sensitive_encoding parameter in the call to RepositoryFactoryDoctrineDBAL::getRepository.

PostgreSQL

psql -c "CREATE ROLE jackalope WITH ENCRYPTED PASSWORD '1234test' NOINHERIT LOGIN;" -U postgres
psql -c "CREATE DATABASE jackalope WITH OWNER = jackalope;" -U postgres

SQLite

Database is created automatically if you specify driver and path ("pdo_sqlite", "jackalope.db"). Database name is not needed.

For further details, please see the Doctrine configuration page.

Oracle

Disclaimer: There is no continuous integration with Oracle. Jackalope 1.8.0 was successfully tested by one of our users against Oracle 19c Enterprise Edition. If you plan to use Jackalope with an Oracle Database, we recommend that you set up the Jackalope test suite to ensure your version of Jackalope and Oracle work together nicely.

Note: A doctrine middleware is automatically added to the database connection to work around Oracle converting the lowercase table and field names to upper case in its results.

CLI Tool

We provide a couple of useful commands to interact with the repository.

NOTE: If you are using PHPCR with the Symfony framework, the DoctrinePHPCRBundle provides the commands in the normal Symfony console. Only do the below setup if you use Jackalope without the Symfony integration.

To use the console, copy cli-config.dist.php to cli-config.php and configure the connection parameters. Then you can run the commands from the jackalope directory with ./bin/jackalope

There is the Jackalope specific command jackalope:init:dbal which you need to run to initialize a database before you can use it.

You have many useful commands available from the phpcr-utils. To get a list of all commands, type:

$ ./bin/jackalope

To get more information on a specific command, use the help command. To learn more about the phpcr:workspace:export command for example, you would type:

$ ./bin/jackalope help phpcr:workspace:export

Bootstrapping

Before you can use Jackalope with a database, you need to prepare the database. Create a database as described above, then make sure the command line utility is set up (see above "CLI Tool"). Now you can run:

$ bin/jackalope jackalope:init:dbal

Once these steps are done, you can bootstrap the library. A minimalist sample code to get a PHPCR session with the doctrine-dbal backend:

// For further details, please see Doctrine configuration page.
// http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connection-details

use Doctrine\DBAL\DriverManager;
use Jackalope\RepositoryFactoryDoctrineDBAL;
use PHPCR\SimpleCredentials;

$driver    = 'pdo_mysql'; // pdo_pgsql | pdo_sqlite
$host      = 'localhost';
$user      = 'admin'; // only used for recording information about the node creator
$sqluser   = 'jackalope';
$sqlpass   = 'xxxx';
$database  = 'jackalope'; 
// $path      = 'jackalope.db'; // for SQLite
$workspace = 'default';
$charset   = 'utf8mb4'; // only for MySQL/MariaDB

// Bootstrap Doctrine
$connection = DriverManager::getConnection([
    'driver'    => $driver,
    'host'      => $host,
    'user'      => $sqluser,
    'password'  => $sqlpass,
    'dbname'    => $database,
    // 'path'   => $path, // for SQLite
    'charset    => $charset, // only for MySQL/MariaDB
]);

$factory = new RepositoryFactoryDoctrineDBAL();
$repository = $factory->getRepository(
    ['jackalope.doctrine_dbal_connection' => $connection]
);

// Dummy credentials to comply with the API
$credentials = new SimpleCredentials($user, null);
$session = $repository->login($credentials, $workspace);

To use a workspace different than default you need to create it first. To create a new workspace, run the command bin/jackalope phpcr:workspace:create <myworkspace>. You can also use the PHPCR API to create workspaces from your code.

Usage

The entry point is to create the repository factory. The factory specifies the storage backend as well. From this point on, there are no differences in the usage (except for supported features, that is).

// See Bootstrapping for how to get the session.

$rootNode = $session->getNode('/');
$whitewashing = $rootNode->addNode('www-whitewashing-de');

$session->save();

$posts = $whitewashing->addNode('posts');

$session->save();

$post = $posts->addNode('welcome-to-blog');

$post->addMixin('mix:title');
$post->setProperty('jcr:title', 'Welcome to my Blog!');
$post->setProperty('jcr:description', 'This is the first post on my blog! Do you like it?');

$session->save();

See PHPCR Tutorial for a more detailed tutorial on how to use the PHPCR API.

Performance tweaks

If you know that you will need many child nodes of a node you are about to request, use the depth hint on Session::getNode. This will prefetch the children to reduce the round trips to the database. It is part of the PHPCR standard. You can also globally set a fetch depth, but that is Jackalope specific: Call Session::setSessionOption with Session::OPTION_FETCH_DEPTH to something bigger than 1.

Use Node::getNodeNames if you only need to know the names of child nodes, but don't need the actual nodes. Note that you should not use the typeFilter on getNodeNames with jackalope. Using the typeFilter with getNodes to only fetch the nodes of types that interest you can make a lot of sense however.

Advanced configuration

Logging

Jackalope supports logging, for example to investigate the number and type of queries used. To enable logging, provide a logger instance to the repository factory:

use Jackalope\RepositoryFactoryDoctrineDBAL;
use Jackalope\Transport\Logging\DebugStack;

$factory = new RepositoryFactoryDoctrineDBAL();
$logger = new DebugStack();

$parameters = [
    'jackalope.doctrine_dbal_connection' => $connection,
    'jackalope.logger' => $logger,
];

$repository = $factory->getRepository($parameters);

//...

// at the end, output debug information
var_dump($logger->calls);

You can also wrap a PSR-3 compatible logger like monolog with the Psr3Logger class.

Note that when using jackalope in Symfony2, the logger is integrated in the debug toolbar.

Custom UUID generator

By default, Jackalope uses the UUIDHelper class from phpcr-utils. If you want to use something else, you can provide a closure that returns UUIDs as parameter jackalope.uuid_generator to $factory->getRepository($parameters)

Implementation notes

See doc/architecture.md for an introduction how Jackalope is built. Have a look at the source files and generate the phpdoc.

Running the tests

Jackalope-doctrine-dbal is integrated with the phpcr-api-tests suite that tests all PHPCR functionality.

If you want to run the tests, please see the README file in the tests folder.

Things left to do

The best overview of what needs to be done are the skipped API tests. Have a look at ImplementationLoader to see what is currently not working and start hacking :-)

Also have a look at the issue trackers of this project and the base jackalope/jackalope.

Contributors

Christian Stocker chregu@liip.ch
David Buchmann david@liip.ch
Tobias Ebnöther ebi@liip.ch
Roland Schilter roland.schilter@liip.ch
Uwe Jäger uwej711@googlemail.com
Lukas Kahwe Smith smith@pooteeweet.org
Benjamin Eberlei kontakt@beberlei.de
Daniel Barsotti daniel.barsotti@liip.ch
and many others

jackalope / jackalope-doctrine-dbal

Maintainers

Details