lrezek/arachnid

PHP Object Graph Mapper for Neo4J.

dev-master 2015-04-09 03:28 UTC

Requires

• php: >=5.3.2
• doctrine/common: 2.4.2
• everyman/neo4jphp: >=0.1.0

Requires (Dev)

• mikey179/vfsstream: 1.4.0
• phpdocumentor/phpdocumentor: 2.*
• phpunit/phpunit: 4.0.19
• satooshi/php-coveralls: dev-master

MIT

• Lukas Rezek

• database
• doctrine
• graph
• neo4j
• entity-mapper

README

Arachnid is a Doctrine Style PHP object graph mapper for Neo4J. Spiders manage webs, Arachnid manages Neo4J Graphs.

This library is heavily based on the excellent work done by Louis-Philippe Huberdeau in his PHP OGM. The main difference is that this OGM allows you to define relationship objects as well as node objects, allowing you to attach properties to relationships very easily.

Arachnid is built on top of Josh Adell's Neo4J PHP Rest interface.

Installation through Composer

To install the library through composer, you simply need to add the following to composer.json and run composer update:

{
    "require": {
       "everyman/neo4jphp":"dev-master",
       "lrezek/arachnid":"dev-master"
    }
}

Once installed, you can use the Arachnid class (LRezek/Arachnid/Arachnid) as required.

Documentation and Testing

You can generate PHP Documentor docs by running vendor/bin/phpdoc while in the root folder of this repository.

You can run unit tests on the library by running vendor/bin/phpunit while in the root folder of this repository.

For full documentation, as well as usage examples, please refer to the wiki.