doctrine/phpcr-odm

PHP Doctrine Content Repository Object Document Mapper (ODM) provides transparent persistence for PHP objects.

2.0.1 2024-05-05 10:06 UTC

Requires

• php: ^8.1
• doctrine/collections: ^2.0
• doctrine/common: ^2.4 || ^3.0
• doctrine/data-fixtures: ^1.0
• doctrine/event-manager: ^1.0 || ^2.0
• doctrine/instantiator: ^1.0.1 || ^2.0
• doctrine/persistence: ^3.0
• phpcr/phpcr: ^2.1.1
• phpcr/phpcr-implementation: ^2.1
• phpcr/phpcr-utils: ^1.3.0 || ^2.0
• psr/cache: ^1.0 || ^2.0 || ^3.0
• symfony/console: ^3.4 || ^4.3 || ^5.0 || ^6.0 || ^7.0

Requires (Dev)

• liip/rmt: ^1.7.3
• phpunit/phpunit: ^9.6.15
• symfony/cache: ^5.4 || ^6.0.19 || ^7.0
• symfony/phpunit-bridge: ^5.4.21 || ^6.0.19 || ^7.0
• symfony/yaml: ^5.4 || ^6.0.19 || ^7.0

Suggests

• jackalope/jackalope-doctrine-dbal: ^1.3 || ^2.0
• jackalope/jackalope-jackrabbit: ^1.3 || ^2.0
• symfony/yaml: ^5.4 || ^6.0 || ^7.0

Conflicts

• jackalope/jackalope: <1.3.7
• jackalope/jackalope-doctrine-dbal: <1.1.5
• jackalope/jackalope-jackrabbit: <1.3
• jms/serializer: <1.3.0

MIT

• Jordi Boggiano
• David Buchmann
• Lukas Kahwe Smith

• php
• data
• object
• odm
• mapping
• mapper
• content

README

Requirements

• libxml version >= 2.7.0 (due to a bug in libxml http://bugs.php.net/bug.php?id=36501)
• composer
• See also the require section of composer.json

Documentation

Please refer to doctrine-project.org for the documentation.

Contributing

Pull requests are welcome. Please include tests to prevent regressions whenever possible.

Thanks to everyone who has contributed already.

Running the tests

There are separate test setups for the doctrine-dbal and the jackrabbit PHPCR implementations. Before installing the composer dependencies, you will need to prepare the database for storage and choose a phpcr/phpcr-implementation. Doing so will change the composer.json file - please make sure you do not check in this change into version control.

Setting up to test with Jackrabbit

1. Make sure you have java and wget installed, then run this script to install and start jackrabbit:

       tests/script_jackrabbit.sh
   

2. Require the PHPCR implementation:

        composer require jackalope/jackalope-jackrabbit --no-update
   

3. Now you can install all dependencies with:

       composer install
   

4. Now you can run the tests:

   vendor/bin/phpunit -c tests/phpunit_jackrabbit.xml.dist
   

   You can also copy the phpunit dist file to ./phpunit.xml to have it selected by default, or if you need to customize any configuration options.

Setting up to test with Doctrine-DBAL

1. For doctrine-dbal, make sure that MySQL is installed. If the connection parameters in cli-config.doctrine_dbal.php.dist are not correct, manually create cli-config.php and adjust the options as needed. Then run the script to initialize the repository in the database:

       tests/script_doctrine_dbal.sh
   

2. Require the PHPCR implementation

       composer require jackalope/jackalope-doctrine-dbal --no-update
   

3. Now you can install all dependencies with:

       composer install
   

4. Now you can run the tests:

   vendor/bin/phpunit -c tests/phpunit_doctrine_dbal.xml.dist
   

   You can also copy the phpunit dist file to ./phpunit.xml to have it selected by default, or if you need to customize any configuration options.