Jackalope Transport library

dev-master / 1.0.x-dev 2015-07-26 11:10 UTC

This package is auto-updated.

Last update: 2024-02-12 18:27:23 UTC


A powerful implementation of the PHPCR API.

Jackalope binding for MongoDB. Still under heavy development. Not yet production ready!

Check here to see which parts of the PHPCR API test suite are disabled.

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

License: This code is licenced under the apache license. Please see the file LICENSE in this folder.


  • php >= 5.3
  • phpunit >= 3.6 (if you want to run the tests)
  • composer


If you do not yet have composer, install it like this

curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin

To install jackalope itselves, run the following in the parent directory of where you want jackalope

git clone git://github.com/jackalope/jackalope-mongodb.git
cd jackalope-mongodb
php /usr/local/bin/composer.phar install --dev

Note that the --dev parameter is only needed if you want to be able to run the test suite. If you already installed jackalope without the test suite, you need to remove composer.lock before running composer again with the --dev parameter.

phpunit Tests

If you want to run the tests , please see the README file in the tests folder and check if you told composer to install the suggested dependencies (see Installation)


Jackalope relies on autoloading. Namespaces and folders are compliant with PSR-0. You should use the autoload file generated by composer: vendor/.composer/autoload.php

If you want to integrate jackalope into other PSR-0 compliant code and use your own classloader, find the mapping in vendor/.composer/autoload_namespaces.php

Before you can use jackalope with a database, you need to set up the database.