Download the PHP package cycle/active-record without Composer

Active Record Implementation for Cycle ORM

This library extends Cycle ORM by integrating the Active Record pattern, providing developers with an intuitive, object-centric way to interact with databases.

Unlike Cycle ORM's default Data Mapper pattern, which separates the in-memory object representations from database operations, Active Record combines data access and business logic in a single entity.

This allows for more straightforward and rapid development cycles, particularly for simpler CRUD operations, by enabling direct data manipulation through the object's properties and methods.

🚩 Prerequisites

Before you begin, ensure your development environment meets the following requirements:

• PHP Version: 8.2 or higher
• One of the Cycle ORM adapters:
  • spiral/cycle-bridge official Cycle ORM adapter for the Spiral Framework
  • yiisoft/yii-cycle — official Cycle ORM adapter for the Yii 3
  • wayofdev/laravel-cycle-orm-adapter — package managed by @wayofdev for the Laravel 10.x or higher.

💿 Installation

The preferred way to install this package is through Composer.

After package install you need to, optionally, register bootloader / service-provider in your application.

→ Spiral Framework

[!NOTE]
If you are installing the package on the Spiral Framework with the spiral-packages/discoverer package, then you don't need to register bootloader by yourself. It will be registered automatically.

Update Bootloader list in your application configuration:

For more information about bootloaders, refer to the Spiral Framework documentation.

→ Laravel

[!NOTE] If you are using Laravel, then you don't need to register service-provider by yourself. It will be registered automatically.

→ Yii 3

For configuration instructions refer to yii-cycle installation guide.

→ Other Frameworks

This package uses PSR-11 compatible container to resolve dependencies. After container initialization you need to pass container instance to the static facade:

📖 Usage

[!NOTE] For detailed usage instructions, refer to the documentation.

→ Basic Example

Define Entity with ActiveRecord

Create a new record

🧪 Running Tests

→ PHPUnit tests

To run tests, run the following command:

→ Mutation tests

To run mutation tests, using infection/infection:

→ Static Analysis

Code quality using PHPStan:

and using Psalm:

→ Coding Standards Fixing

Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:

→ Lint Yaml files

Lint all yaml files in project:

→ Lint Markdown files

Lint all yaml files in project:

→ Lint GitHub Actions

Lint all yaml files in project:

🔒 Security Policy

This project has a security policy.

🙌 Want to Contribute?

Thank you for considering contributing to the cycle community! We are open to all kinds of contributions. If you want to:

• 🤔 Suggest a feature
• 🐛 Report an issue
• 📖 Improve documentation
• 👨‍💻 Contribute to the code

You are more than welcome. Before contributing, kindly check our contribution guidelines.

🫡 Contributors

🌐 Social Links

• Twitter: Follow our organization @SpiralPHP.
• Discord: Join our community on Discord.

⚖️ License