Skip to content
cyclePublic

Repository files navigation

PHP DataMapper ORM and Data Modelling Engine

Documentation Sponsor Discord

Psalm Level Type Coverage Codecov


Cycle is PHP DataMapper, ORM and Data Modelling engine designed to safely work in classic and daemonized 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.

Get Started

Installation

The package requires PHP 8.2+.

composer require cycle/orm

PHP Latest Version on Packagist License Total Downloads

See the documentation to configure the database connection and the mapping schema, and the comparison with Eloquent and Doctrine.

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();

Agent skills

Cycle ORM comes with the cycle-orm Agent Skill from cycle/skills: it teaches coding agents such as Claude Code and Codex to work with the ORM runtime — bootstrap the ORM, query through repositories and Select, save entities with the EntityManager, and write custom repositories, scopes, mappers and typecasters. Install the llm/skills Composer plugin, and it copies the skill into .agents/skills/ on every composer install and update:

composer require --dev llm/skills

Entity mapping with PHP attributes is covered by the cycle-orm-attributes skill that comes with cycle/annotated.

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

Component Current Status
cycle/active-record License PHP Stable Release Total Downloads
cycle/schema-builder License PHP Stable Release Total Downloads
cycle/schema-renderer License PHP Stable Release Total Downloads
cycle/schema-provider License PHP Stable Release Total Downloads
cycle/annotated License PHP Stable Release Total Downloads
cycle/migrations License PHP Stable Release Total Downloads
cycle/entity-behavior License PHP Stable Release Total Downloads
cycle/entity-behavior-uuid License PHP Stable Release Total Downloads
cycle/database License PHP Stable Release Total Downloads
cycle/schema-migrations-generator License PHP Stable Release Total Downloads
cycle/orm-promise-mapper License PHP Stable Release Total Downloads

Releases

Sponsor this project

Used by

Contributors

Languages