https://github.com/dantleech/doctrine-cr
Doctrine Content Repository
https://github.com/dantleech/doctrine-cr
Last synced: 5 months ago
JSON representation
Doctrine Content Repository
- Host: GitHub
- URL: https://github.com/dantleech/doctrine-cr
- Owner: dantleech
- License: mit
- Created: 2016-05-02T15:55:24.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-14T16:41:27.000Z (about 10 years ago)
- Last Synced: 2025-06-11T16:50:49.266Z (about 1 year ago)
- Language: PHP
- Size: 66.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Doctrine Content Repository
===========================
[](https://travis-ci.org/dantleech/doctrine-content-repository)
[](https://styleci.io/repos/)
What is this?
-------------
This allows you to organize Doctrine Entities in a tree hierarchy and identify
them with a UUID (universally unique identifier), for example:
```bash
/
page-1/ [Acme\Entity\Page]
page-2/ [Acme\Entity\Page]
block-1/ [Acme\Entity\Block]
block-2/ [Acme\Entity\Block]
comment-1/ [Acme\Entity\Comment]
foo/ [Acme\Entity\Foobar]
```
It is similar in concept to the
[PHPCR-ODM](https://github.com/doctrine/phpcr-odm) but uses the standard
Doctrine ORM.
You can access entities by path:
```php
$page1 = $entityManager->find(null, '/page-1');
$comment = $entityManager->find(null, '/page-1/comment1');
```
You can also access by UUID:
```php
$page1 = $entityManager->find(null, '6cb68641-f995-43d4-b698-5d61ae78fa90');
```
and traverse the tree:
```
$page1 = $entityManager->find(null, '/page-1');
foreach ($page1->getChildren() as $child) {
$parent = $child->getParent();
}
```
Note that the above methods are not part of an interface, but are using mapped
properties - the DoctrineCR, like Doctrine itself, does not impose any
restrictions upon your domain model.
Another tree extension?
-----------------------
This extension is different in that enables each node to be of a different
object class and allows nodes to be referenced by a single UUID regardless of
which table they reside in.
Configuration
-------------
```php
use Metadata\MetadataFactory;
use DTL\DoctrineCR\Metadata\Driver\XmlDriver;
use DTL\DoctrineCR\Metadata\Locator\DoctrineLocator;
use DTL\DoctrineCR\Path\Storage\DbalStorage;
use DTL\DoctrineCR\Path\PathManager;
$metadataFactory = new MetadataFactory(
new XmlDriver(
new DoctrineLocator($container['orm.file_locator'])
)
);
};
$pathStorage = new DbalStorage($container['dbal.connection']);
$pathManager = new PathManager($pathStorage);
$dcrSubscriber = new DcrSubscriber(
$pathManager,
$metadataFactory,
$ormEntityManager, // should do a minor refactor to remove this dep
);
$ormEntityManager->getEventManager()->addEventSubscriber($dcrSubscriber);
// create our new hierarchically aware entity manager
$wrappedEntityManager = new ObjectManager($pathManager, $ormEntityManager);
$wrappedEntityManager->find(null, '/foo/bar');
$wrappedEntityManager->move('/foobar', '/barfoo');
$wrappedEntityManager->persist($document);
$wrappedEntityManager->remove('/foobar');
// etc.
```
How does it work?
-----------------
Basically we store all the paths and UUIDs in a lookup table. Mapping is
applied to your domain models (Entities) indicating which fields should be
mapped with the Doctrine CR fields such as "children", "parent", "path",
"uuid", etc. (UUID is mandatory).
DoctrineCR then includes an event subscriber which will listen to load and
persist events sent from the standard Doctrine `EntityManager` in addition to
decorating that same `EventManager` - adding the possiblity to lookup any
(managed) Entity by UUID and perform tree specific operations such as moving.