Wallogit.com
2017 © Pedro Peláez
This bundle integrates Neo4j OGM library into Symfony with basic user provider and form integration
Provides integration Neo4j PHP Object Graph Mapper with Symfony, (*1)
To install this bundle just add following line to "require" section of your composer.json file:
"id009/neo4jbundle": "dev-master", (*2)
Run php composer.phar update command. After updating is finished, register the bundle in your AppKernel.php:, (*3)
```php // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new id009\Neo4jBundle\id009Neo4jBundle(), ); // ... }, (*4)
Configuration ------------- To finish bundle installation, you need configuration that sets up entity managers and connections. Quite full configuration shown below. ```yml id009_neo4j: connections: default: host: localhost port: 7474 username: user password: pass entity_managers: default: debug: true #For pathfinding algorithms refer to Everyman\Neo4j\PathFinder pathfinder_algorithm: allSimplePaths pathfinder_maxdepth: 5
But in most common cases you'll need something looks like this:, (*5)
```yml id009_neo4j: connections: default: entity_managers: default:, (*6)
And that's all. In configuration above host is localhost and port is 7474 by default. Debug mode is taken from global debug parameter.
Now, after the bundle is installed and configured properly, you can start using it.
Basics
------
Please, refer to [Neo4j PHP Object Graph Mapper](https://github.com/lphuberdeau/Neo4j-PHP-OGM) readme to understand how OGM works.
If you have a deal with Doctrine ORM Bundle you'll see that basic usage of Neo4j Bundle is pretty straightforward:
```php
// Your controller...
$em = $this->get('id009_neo4j.entity_manager');
// Now you have an instance of HireVoice\Neo4j\EntityManager class. You can do whatever you want with it.
$em->getRepository('Acme\AcmeBundle\Entity')->findOneByUsername('ivanpetrov99'); // and so on...
This bundle provides basic OGMUser class and Security provider, working the same as the entity provider described in the cookbook. Basic security configuration shown below. ```yml providers: neo4j_provider: neo4j: {class: id009\Neo4jBundle\Security\User\OGMUser}, (*7)
Forms ----- The bundle wouldn't be useful enough without integration with Symfony forms. So lets get down to it. For instance you have a Person and City classes as shown below. ```php // Acme\AcmeBundle\Entity\Person /** * @OGM\Entity */ class Person { //... /** * @OGM\ManyToOne */ protected $city; //... } // Acme\AcmeBundle\Entity\City /** * @OGM\Entity */ class City { //... }
It's a good idea to have a form type to select City when editing Person, isn't it? Here is an example:, (*8)
```php // Acme\AcmeBundle\Form\Type\PersonType, (*9)
public function buildForm(FormBuilderInterface $builder, array $options) { //..., (*10)
$builder->add('city', null, array(
'class' => 'Acme\AcmeBundle\Entity\City'
));
//...
}, (*11)
Form type will be automatically detected as `neo4j_entity` with options `array('multiple' => false, 'expanded' => false)`, and it will be rendered as dropdown list.
Events
------
OGM provides three types of events:
* Entity create
* Relation create
* Query run
Please, refer to [HireVoice\Neo4j\EntityManager](https://github.com/lphuberdeau/Neo4j-PHP-OGM/blob/master/lib/HireVoice/Neo4j/EntityManager.php) for details on these events.
If you want to subscribe on these events you can create your own Subscriber class that implements `Symfony\Component\EventDispatcher\EventSubscriberInterface`. But for convenience the bundle has an abstract class `id009\Neo4jBundle\Event\AbstractSubscriber`, and you can inherit your subscribers from it. For example:
```php
namespace Acme\AcmeBundle\Event
//...
class MySubscriber extends AbstractSubscriber
{
public function onEntityCreate($entity)
{
//...
}
public function onRelationCreate($relation, $a, $b, $relationship)
{
//...
}
public function onQueryRun($query, $parameters, $time)
{
//...
}
}
Now, after your subscriber is done, register it in your services.yml file:, (*12)
```yml acme_acmebundle.event.subscriber: class: 'Acme\AcmeBundle\Event\MySubscriber' tags: - {name: id009_neo4j.subscriber} ````, (*13)
If you have several entity manager within your project just add attribute manager with entity manager name to the tag, (*14)
Alex Belyaev @lex009, (*15)
You are always welcome to contribute!, (*16)
I would appreciate any feedback., (*17)
MIT, (*18)
This bundle integrates Neo4j OGM library into Symfony with basic user provider and form integration
MIT
graph neo4j ogm