Developed with love by KnpLabs Hire us for your project!
39

neo4j-ogm-bundle

by klaussilveira

This bundle provides a simple integration of the Neo4j PHP Object Graph Mapper into Symfony2.

Neo4j OGM Bundle

This bundle provides a simple integration of the
"Neo4j PHP Object Graph Mapper" from
Louis-Philippe Huberdeau into Symfony2. The Neo4j OGM is an object management layer
built on top of Josh Adell's Neo4jPHP. It allows
manipulation of data inside the Neo4j graph database through the REST connectors.

Installation

To install this bundle, add this to your project's composer.json:

"require": {
    // ...
    "klaussilveira/neo4j-ogm-bundle": "dev-master",
}

Next, update your vendors by running:

$ composer update

Now enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Neo4j\OGM\OGMBundle\Neo4jOGMBundle(),
    );
}

And configure the bundle by adding the neo4j_ogm namespace into config.yml:

neo4j_ogm:
    host: 'localhost'
    port: 7474

Congratulations! You're ready to use Neo4j OGM into Symfony2.

Basic Usage

The only thing to do is to request the neo4j.manager service from the
container to get an instance of HireVoice\Neo4j\EntityManager.

<?php

$em = $this->container->get('neo4j.manager');
$repo = $em->getRepository('Entity\\User');
$john = $repo->findOneByFullName('John Doe');

$list = $em->createCypherQuery()
    ->startWithNode('john', $john)
    ->match('john -[:follow]-> followedBy <-[:follow]- similarInterest')
    ->match('similarInterest -[:follow]-> potentialMatch')
    ->end('potentialMatch', 'count(*)')
    ->order('count(*) DESC')
    ->limit(10)
    ->getList();

Configuration

You can easily configure the Neo4j OGM by changing neo4j_ogm on your config.yml:

neo4j_ogm:
    transport: 'curl'
    host: 'localhost'
    port: 7474
    username: 'test'
    password: '123456'
    proxy_dir: '/tmp'
    debug: true
Copyright (c) 2012 Klaus Silveira

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
neo4j_ogm:
transport: ~
host: ~
port: ~
debug: ~
username: ~
password: ~
proxy_dir: ~
annotation_reader: ~