Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@roxblnfk
roxblnfk committed Jan 7, 2025
1 parent 86ba97e commit 67a8359
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Cycle ORM

[![Latest Stable Version](https://poser.pugx.org/cycle/orm/version)](https://packagist.org/packages/cycle/orm)
[![Build Status](https://github.com/cycle/orm/workflows/build/badge.svg)](https://github.com/cycle/orm/actions)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/orm/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/cycle/orm/?branch=2.x)
[![Codecov](https://codecov.io/gh/cycle/orm/graph/badge.svg)](https://codecov.io/gh/cycle/orm)
<a href="https://discord.gg/TFeEmCs"><img src="https://img.shields.io/badge/discord-chat-magenta.svg"></a>
[![Discord](https://img.shields.io/static/v1?label=Discord&message=chat&logo=Discord&color=%235865F2)](https://discord.gg/qF3HpXhMEP)
[![Meta Storm Plugin](https://img.shields.io/static/v1?&label=Powered+by&message=Meta+Storm+Plugin&logo=phpstorm&color=aa55ee)](https://github.com/xepozz/meta-storm-idea-plugin)

<img src="https://cycle-orm.dev/cycle.png" height="135px" alt="Cycle ORM" align="left"/>

Expand All @@ -20,7 +20,7 @@ objects, support annotation declarations, and proxies via extensions.
## Features

- ORM with has-one, has-many, many-through-many and polymorphic relations
- Plain Old PHP objects, [AR](https://github.com/cycle/docs/blob/2.x/docs/en/advanced/active-record.md), Custom objects
- Plain Old PHP objects, [AR](https://github.com/https://github.com/cycle/active-record), Custom objects
or [same entity type for multiple repositories](https://github.com/cycle/orm/tree/2.x/tests/ORM/Functional/Driver/Common/Classless)
- eager and lazy loading, query builder with multiple fetch strategies
- embedded entities, lazy/eager loaded embedded partials
Expand All @@ -39,17 +39,19 @@ objects, support annotation declarations, and proxies via extensions.

## Extensions

| Component | Current Status |
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| cycle/schema-builder | [![Latest Stable Version](https://poser.pugx.org/cycle/schema-builder/version)](https://packagist.org/packages/cycle/schema-builder) [![Build Status](https://github.com/cycle/schema-builder/workflows/build/badge.svg)](https://github.com/cycle/schema-builder/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/schema-builder/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/cycle/schema-builder/?branch=2.x) [![Codecov](https://codecov.io/gh/cycle/schema-builder/graph/badge.svg)](https://codecov.io/gh/cycle/schema-builder) |
| cycle/schema-renderer | [![Latest Stable Version](https://poser.pugx.org/cycle/schema-renderer/version)](https://packagist.org/packages/cycle/schema-renderer) [![Build Status](https://github.com/cycle/schema-renderer/workflows/build/badge.svg)](https://github.com/cycle/schema-renderer/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/schema-renderer/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/cycle/schema-renderer/?branch=1.x) [![Codecov](https://codecov.io/gh/cycle/schema-renderer/graph/badge.svg)](https://codecov.io/gh/cycle/schema-renderer) |
| cycle/annotated | [![Latest Stable Version](https://poser.pugx.org/cycle/annotated/version)](https://packagist.org/packages/cycle/annotated) [![Build Status](https://github.com/cycle/annotated/workflows/build/badge.svg)](https://github.com/cycle/annotated/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/annotated/badges/quality-score.png?b=3.x)](https://scrutinizer-ci.com/g/cycle/annotated/?branch=3.x) [![Codecov](https://codecov.io/gh/cycle/annotated/graph/badge.svg)](https://codecov.io/gh/cycle/annotated) |
| cycle/migrations | [![Latest Stable Version](https://poser.pugx.org/cycle/migrations/version)](https://packagist.org/packages/cycle/migrations) [![Build Status](https://github.com/cycle/migrations/workflows/build/badge.svg)](https://github.com/cycle/migrations/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/migrations/badges/quality-score.png?b=3.x)](https://scrutinizer-ci.com/g/cycle/migrations/?branch=3.x) [![Codecov](https://codecov.io/gh/cycle/migrations/graph/badge.svg)](https://codecov.io/gh/cycle/migrations) |
| cycle/entity-behavior | [![Latest Stable Version](https://poser.pugx.org/cycle/entity-behavior/version)](https://packagist.org/packages/cycle/entity-behavior) [![Build Status](https://github.com/cycle/entity-behavior/workflows/build/badge.svg)](https://github.com/cycle/entity-behavior/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/entity-behavior/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/cycle/entity-behavior/?branch=1.x) [![Codecov](https://codecov.io/gh/cycle/entity-behavior/graph/badge.svg)](https://codecov.io/gh/cycle/entity-behavior) |
| cycle/entity-behavior-uuid | [![Latest Stable Version](https://poser.pugx.org/cycle/entity-behavior-uuid/version)](https://packagist.org/packages/cycle/entity-behavior-uuid) [![Build Status](https://github.com/cycle/entity-behavior-uuid/workflows/build/badge.svg)](https://github.com/cycle/entity-behavior-uuid/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/entity-behavior-uuid/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/cycle/entity-behavior-uuid/?branch=1.x) [![Codecov](https://codecov.io/gh/cycle/entity-behavior-uuid/graph/badge.svg)](https://codecov.io/gh/cycle/entity-behavior-uuid) |
| cycle/database | [![Latest Stable Version](https://poser.pugx.org/cycle/database/version)](https://packagist.org/packages/cycle/database) [![Build Status](https://github.com/cycle/database/workflows/build/badge.svg)](https://github.com/cycle/database/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/database/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/cycle/database/?branch=2.x) [![Codecov](https://codecov.io/gh/cycle/database/graph/badge.svg)](https://codecov.io/gh/cycle/database) |
| cycle/schema-migrations-generator | [![Latest Stable Version](https://poser.pugx.org/cycle/schema-migrations-generator/version)](https://packagist.org/packages/cycle/schema-migrations-generator) [![Build Status](https://github.com/cycle/schema-migrations-generator/workflows/build/badge.svg)](https://github.com/cycle/schema-migrations-generator/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/schema-migrations-generator/badges/quality-score.png?b=2.x)](https://scrutinizer-ci.com/g/cycle/schema-migrations-generator/?branch=2.x) [![Codecov](https://codecov.io/gh/cycle/schema-migrations-generator/graph/badge.svg)](https://codecov.io/gh/cycle/schema-migrations-generator) |
| cycle/orm-promise-mapper | [![Latest Stable Version](https://poser.pugx.org/cycle/orm-promise-mapper/version)](https://packagist.org/packages/cycle/orm-promise-mapper) [![Build Status](https://github.com/cycle/orm-promise-mapper/workflows/build/badge.svg)](https://github.com/cycle/orm-promise-mapper/actions) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/cycle/orm-promise-mapper/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/cycle/orm-promise-mapper/?branch=1.x) [![Codecov](https://codecov.io/gh/cycle/orm-promise-mapper/graph/badge.svg)](https://codecov.io/gh/cycle/orm-promise-mapper) |
| Component | Current Status |
|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [cycle/active-record](https://github.com/cycle/active-record) | ![License](https://img.shields.io/packagist/l/cycle/active-record.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/active-record.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/active-record) [![Stable Release](https://poser.pugx.org/cycle/active-record/version?style=flat-square)](https://packagist.org/packages/cycle/active-record) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/active-record.svg?style=flat-square)](https://packagist.org/packages/cycle/active-record/stats) |
| [cycle/schema-builder](https://github.com/cycle/schema-builder) | ![License](https://img.shields.io/packagist/l/cycle/schema-builder.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/schema-builder.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/schema-builder) [![Stable Release](https://poser.pugx.org/cycle/schema-builder/version?style=flat-square)](https://packagist.org/packages/cycle/schema-builder) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/schema-builder.svg?style=flat-square)](https://packagist.org/packages/cycle/schema-builder/stats) |
| [cycle/schema-renderer](https://github.com/cycle/schema-renderer) | ![License](https://img.shields.io/packagist/l/cycle/schema-renderer.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/schema-renderer.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/schema-renderer) [![Stable Release](https://poser.pugx.org/cycle/schema-renderer/version?style=flat-square)](https://packagist.org/packages/cycle/schema-renderer) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/schema-renderer.svg?style=flat-square)](https://packagist.org/packages/cycle/schema-renderer/stats) |
| [cycle/schema-provider](https://github.com/cycle/schema-provider) | ![License](https://img.shields.io/packagist/l/cycle/schema-provider.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/schema-provider.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/schema-provider) [![Stable Release](https://poser.pugx.org/cycle/schema-provider/version?style=flat-square)](https://packagist.org/packages/cycle/schema-provider) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/schema-provider.svg?style=flat-square)](https://packagist.org/packages/cycle/schema-provider/stats) |
| [cycle/annotated](https://github.com/cycle/annotated) | ![License](https://img.shields.io/packagist/l/cycle/annotated.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/annotated.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/annotated) [![Stable Release](https://poser.pugx.org/cycle/annotated/version?style=flat-square)](https://packagist.org/packages/cycle/annotated) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/annotated.svg?style=flat-square)](https://packagist.org/packages/cycle/annotated/stats) |
| [cycle/migrations](https://github.com/cycle/migrations) | ![License](https://img.shields.io/packagist/l/cycle/migrations.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/migrations.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/migrations) [![Stable Release](https://poser.pugx.org/cycle/migrations/version?style=flat-square)](https://packagist.org/packages/cycle/migrations) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/migrations.svg?style=flat-square)](https://packagist.org/packages/cycle/migrations/stats) |
| [cycle/entity-behavior](https://github.com/cycle/entity-behavior) | ![License](https://img.shields.io/packagist/l/cycle/entity-behavior.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/entity-behavior.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/entity-behavior) [![Stable Release](https://poser.pugx.org/cycle/entity-behavior/version?style=flat-square)](https://packagist.org/packages/cycle/entity-behavior) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/entity-behavior.svg?style=flat-square)](https://packagist.org/packages/cycle/entity-behavior/stats) |
| [cycle/entity-behavior-uuid](https://github.com/cycle/entity-behavior-uuid) | ![License](https://img.shields.io/packagist/l/cycle/entity-behavior-uuid.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/entity-behavior-uuid.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/entity-behavior-uuid) [![Stable Release](https://poser.pugx.org/cycle/entity-behavior-uuid/version?style=flat-square)](https://packagist.org/packages/cycle/entity-behavior-uuid) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/entity-behavior-uuid.svg?style=flat-square)](https://packagist.org/packages/cycle/entity-behavior-uuid/stats) |
| [cycle/database](https://github.com/cycle/database) | ![License](https://img.shields.io/packagist/l/cycle/database.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/database.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/database) [![Stable Release](https://poser.pugx.org/cycle/database/version?style=flat-square)](https://packagist.org/packages/cycle/database) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/database.svg?style=flat-square)](https://packagist.org/packages/cycle/database/stats) |
| [cycle/schema-migrations-generator](https://github.com/cycle/schema-migrations-generator) | ![License](https://img.shields.io/packagist/l/cycle/schema-migrations-generator.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/schema-migrations-generator.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/schema-migrations-generator) [![Stable Release](https://poser.pugx.org/cycle/schema-migrations-generator/version?style=flat-square)](https://packagist.org/packages/cycle/schema-migrations-generator) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/schema-migrations-generator.svg?style=flat-square)](https://packagist.org/packages/cycle/schema-migrations-generator/stats) |
| [cycle/orm-promise-mapper](https://github.com/cycle/orm-promise-mapper) | ![License](https://img.shields.io/packagist/l/cycle/orm-promise-mapper.svg?style=flat-square&label=) [![PHP](https://img.shields.io/packagist/php-v/cycle/orm-promise-mapper.svg?style=flat-square&logo=php)](https://packagist.org/packages/cycle/orm-promise-mapper) [![Stable Release](https://poser.pugx.org/cycle/orm-promise-mapper/version?style=flat-square)](https://packagist.org/packages/cycle/orm-promise-mapper) [![Total Downloads](https://img.shields.io/packagist/dt/cycle/orm-promise-mapper.svg?style=flat-square)](https://packagist.org/packages/cycle/orm-promise-mapper/stats) |

## Example:

Expand Down Expand Up @@ -78,5 +80,5 @@ $em->run();

## License:

The MIT License (MIT). Please see [`LICENSE`](./LICENSE) for more information.
Cycle ORM is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
Maintained by [Spiral Scout](https://spiralscout.com).

0 comments on commit 67a8359

Please sign in to comment.