Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roxblnfk/cycle-active-record
ActiveRecord based on Cycle ORM
https://github.com/roxblnfk/cycle-active-record
active-record cycle orm
Last synced: 3 months ago
JSON representation
ActiveRecord based on Cycle ORM
- Host: GitHub
- URL: https://github.com/roxblnfk/cycle-active-record
- Owner: roxblnfk
- License: mit
- Created: 2022-02-25T08:13:35.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-09T06:04:29.000Z (about 1 year ago)
- Last Synced: 2024-10-11T03:19:45.699Z (3 months ago)
- Topics: active-record, cycle, orm
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cycle Active Record
[](https://packagist.org/packages/roxblnfk/cycle-active-record)
[](https://packagist.org/packages/roxblnfk/cycle-active-record)
[](https://github.com/roxblnfk/cycle-active-record/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://packagist.org/packages/roxblnfk/cycle-active-record)
[](https://php.package.health/packages/roxblnfk/cycle-active-record/dev-master)
ActiveRecord pattern based on Cycle ORM. AR entities work fine with mappers, repositories, behaviors and other Cycle
features.
The package just adds to entity such proxy methods like `save` and `delete` using a class inheritance.
## Requirements
Make sure that your server is configured with following PHP version and extensions:
- PHP 8.0+
- One of the Cycle ORM adapters:
- [`spiral/cycle-bridge`](https://github.com/spiral/cycle-bridge) package for the
[Spiral Framework](https://github.com/spiral/framework)
- [`yiisoft/yii-cycle`](https://github.com/yiisoft/yii-cycle) ^2.0 package for the Yii 3
## Installation
You can install the package via composer:
```bash
composer require roxblnfk/cycle-active-record
```
After package install you need to register bootloader from the package.
> **Note**
> If you are installing the package on the Yii 3 or Spiral Framework with the
> [`spiral-packages/discoverer`](https://github.com/spiral-packages/discoverer) package,
> then you don't need to register bootloader by yourself. It will be registered automatically.
### Spiral Framework without discoverer
Update Bootloader list
```php
protected const LOAD = [
// ...
\Cycle\ActiveRecord\Boot\CycleActiveRecordBootloader::class,
];
```
### Custom application
After Container initialization just register it in AR static class:
```php
\Cycle\ActiveRecord\StaticOrigin::setContainer($container);
```
## Example
Entity:
```php
use Cycle\ActiveRecord\ActiveRecord;
use Cycle\Annotated\Annotation\Column;
use Cycle\Annotated\Annotation\Entity;
#[Entity(table: 'user')]
class User extends ActiveRecord
{
#[Column(type: 'primary', typecast: 'int')]
public int $id;
public function __construct(
#[Column(type: 'string')]
public string $name
) {}
}
```
Usage:
```php
$user1 = new User('Lia');
$user2 = new User('Zaza');
// Persisting
$user1->prepare();
$user2->save(); // Save current and prepared entities
// Find and delete
User::findByPK(10)?->delete();
// Delete multiple
$user1->prepareDeletion();
$user2->delete();
// Use SelectQuery
User::find()->where('id', '>', '10')->fetchData();
```
## Testing
```bash
composer test
```
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.