https://github.com/neo4j-php/cypher-entity-manager

Framework agnostic cypher entity manager
https://github.com/neo4j-php/cypher-entity-manager

cypher entity-manager neo4j php

Last synced: 1 day ago
JSON representation

Framework agnostic cypher entity manager

• Host: GitHub
• URL: https://github.com/neo4j-php/cypher-entity-manager
• Owner: neo4j-php
• License: mit
• Created: 2022-09-14T22:03:51.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-03T10:44:37.000Z (10 months ago)
• Last Synced: 2024-09-19T07:14:09.387Z (6 days ago)
• Topics: cypher, entity-manager, neo4j, php
• Language: PHP
• Homepage: https://syndesi.github.io/cypher-entity-manager/
• Size: 252 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub](https://img.shields.io/github/license/neo4j-php/cypher-entity-manager)](https://github.com/neo4j-php/cypher-entity-manager/blob/main/LICENSE)

![Neo4j Version Support](https://img.shields.io/badge/Neo4j-4.4%2B-blue)

![Packagist PHP Version Support (specify version)](https://img.shields.io/packagist/php-v/syndesi/cypher-entity-manager/dev-main)

![Packagist Version](https://img.shields.io/packagist/v/syndesi/cypher-entity-manager)

![Packagist Downloads](https://img.shields.io/packagist/dm/syndesi/cypher-entity-manager)

[![Unit Tests](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-unit-test.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-unit-test.yml)

[![Mutant Test](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-mutant-test.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-mutant-test.yml)

[![Leak Tests](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-leak-test.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-leak-test.yml)

[![PHPStan](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-phpstan.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-phpstan.yml)

[![Psalm](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-psalm.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-psalm.yml)

[![Code Style](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-code-style.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-code-style.yml)

[![YML lint](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-yml-lint.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-yml-lint.yml)

[![Markdown lint](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-markdown-lint.yml/badge.svg)](https://github.com/neo4j-php/cypher-entity-manager/actions/workflows/ci-markdown-lint.yml)

[![Test Coverage](https://api.codeclimate.com/v1/badges/ecd3da92ddb4d8ac99a5/test_coverage)](https://codeclimate.com/github/Syndesi/cypher-entity-manager/test_coverage)

[![Maintainability](https://api.codeclimate.com/v1/badges/ecd3da92ddb4d8ac99a5/maintainability)](https://codeclimate.com/github/Syndesi/cypher-entity-manager/maintainability)

# Syndesi's Cypher Entity Manager

This library provides an entity manager for Cypher data types.  

This basically means, that you do not have to write create/merge/delete statements for your nodes, relations etc. per

hand. Instead, you just call `$em->create($node)`, `$em->merge($node)`, `$em->delete($node)` and at the end

`$em->flush()`.

- [Documentation](https://neo4j-php.github.io/cypher-entity-manager)

- [Packagist](https://packagist.org/packages/syndesi/cypher-entity-manager)

## Installation

To install this library, run the following code:

```bash

composer require syndesi/cypher-entity-manager

```

This is all, now you can use the library :D

## Using the library

```php

use Syndesi\CypherDataStructures\Type\Node;

use Syndesi\CypherEntityManager\Type\EntityManager;

/**

 * note: the container should be provided by your framework. manual configuration is possible, see documentation

 * @var EntityManagerInterface $em 

 */

$em = $container->get(EntityManager::class);

$node = new Node();

$node

    ->addLabel('NodeLabel')

    ->addIdentifier('id', 123)

    ->addProperty('someProperty', 'someValue')

    ->addIdentifier('id');

// create a node:

$em->create($node);

$em->flush();

// update a node:

$node->addProperty('newProperty', 'Hello world :D');

$em->merge($node);

$em->flush();

// delete a node:

$em->delete($node);

$em->flush();

```