cycle/orm

PHP DataMapper ORM and Data Modelling Engine

v2.9.0 2024-06-05 13:14 UTC

Requires

• php: >=8.0
• ext-pdo: *
• cycle/database: ^2.8.1
• doctrine/instantiator: ^1.3.1 || ^2.0
• spiral/core: ^2.8 || ^3.0

Requires (Dev)

• doctrine/collections: ^1.6 || ^2.0
• illuminate/collections: ^8.0
• loophp/collection: ^6.0 || ^7.0
• mockery/mockery: ^1.1
• phpunit/phpunit: ^9.5
• ramsey/uuid: ^4.0
• spiral/tokenizer: ^2.8 || ^3.0
• symfony/var-dumper: ^5.2 || ^6.0 || ^7.0
• vimeo/psalm: 5.21

MIT

• Anton Titov (wolfy-j)
• Aleksei Gagarin (roxblnfk)
• Pavel Butchnev (butschster)
• Maksim Smakouz (msmakouz)

README

Cycle is PHP DataMapper, ORM and Data Modelling engine designed to safely work in classic and demonized PHP applications (like RoadRunner). The ORM provides flexible configuration options to model datasets, powerful query builder and supports dynamic mapping schema. The engine can work with plain PHP objects, support annotation declarations, and proxies via extensions.

Website and Documentation | Comparison with Eloquent and Doctrine

Features

• ORM with has-one, has-many, many-through-many and polymorphic relations
• Plain Old PHP objects, AR, Custom objects or same entity type for multiple repositories
• eager and lazy loading, query builder with multiple fetch strategies
• embedded entities, lazy/eager loaded embedded partials
• runtime configuration with/without code-generation
• column-to-field mapping, single table inheritance, value objects support
• hackable: persist strategies, mappers, relations, transactions
• works with directed graphs and cyclic graphs using command chains
• designed to work in long-running applications: immutable service core, disposable UoW
• supports MySQL, MariaDB, PostgresSQL, SQLServer, SQLite
• schema scaffolding, introspection, migrations and debugging
• supports global query scopes, UUIDs as PK, soft deletes, auto timestamps and macros
• custom column types, FKs to non-primary columns
• use with or without annotations, proxy classes, and auto-migrations
• compatible with Doctrine Collections, Illuminate Collections and custom collections
• compatible with Doctrine Annotations, PHP8 attributes

Extensions

Example:

// load all active users and pre-load their paid orders sorted from newest to olders
// the pre-load will be complete using LEFT JOIN
$users = $orm->getRepository(User::class)
    ->select()
    ->where('active', true)
    ->load('orders', [
        'method' => Select::SINGLE_QUERY,
        'load'   => function($q) {
            $q->where('paid', true)->orderBy('timeCreated', 'DESC');
        }
    ])
    ->fetchAll();

$em = new EntityManager($orm);

foreach($users as $user) {
    $em->persist($user);
}

$em->run();

License:

The MIT License (MIT). Please see LICENSE for more information. Maintained by Spiral Scout.