PHPackages                             yiisoft/active-record - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. yiisoft/active-record

ActiveLibrary[Framework](/categories/framework)

yiisoft/active-record
=====================

Active record pattern implementation

1.0.2(2mo ago)11883.6k↑21.9%37[37 issues](https://github.com/yiisoft/active-record/issues)[7 PRs](https://github.com/yiisoft/active-record/pulls)13BSD-3-ClausePHPPHP 8.1 - 8.5CI passing

Since May 22Pushed 1mo ago21 watchersCompare

[ Source](https://github.com/yiisoft/active-record)[ Packagist](https://packagist.org/packages/yiisoft/active-record)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-active-record/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (38)Versions (11)Used By (13)

 [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft)

Yii Active Record
=================

[](#yii-active-record)

[![Latest Stable Version](https://camo.githubusercontent.com/ed38b797fede9c3441dd5052ed6407580396cb883131c14adc9383a2ba527f60/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f6163746976652d7265636f72642f76)](https://packagist.org/packages/yiisoft/active-record)[![Total Downloads](https://camo.githubusercontent.com/80c135fbbf1022deaad7839fa85f666ea813dabbfc3ceb00faf2134301c5259c/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f6163746976652d7265636f72642f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/active-record)[![Code Coverage](https://camo.githubusercontent.com/e417613a8a3e47016c46ebfb213abd00c3322aac5d2586ec0554cb678c45863f/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f6163746976652d7265636f72642f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/active-record)[![Mutation testing badge](https://camo.githubusercontent.com/9c19bb6d2a93147c31dfe1f54fd2c7c6de8e72598bbf39b7e8049c928c254d1f/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f66742532466163746976652d7265636f72642532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/active-record/master)[![Static analysis](https://github.com/yiisoft/active-record/actions/workflows/static.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/static.yml?query=branch%3Amaster)[![type-coverage](https://camo.githubusercontent.com/232beb6ca4d8df6d8943d5b7a38af235393190119a0543afb748774cea2fb54e/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f6163746976652d7265636f72642f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/active-record)[![psalm-level](https://camo.githubusercontent.com/78052265a6a2f75833b57f472498ffd1fbcb5a8376e9d6fd8fd189fabc119335/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f6163746976652d7265636f72642f6c6576656c2e737667)](https://shepherd.dev/github/yiisoft/active-record)

This package provides [Active Record pattern](https://en.wikipedia.org/wiki/Active_record_pattern) implementation.

Supported databases:

PackagesBuild status[Microsft SQL Server](https://github.com/yiisoft/db-mssql)[![Build status](https://github.com/yiisoft/active-record/actions/workflows/db-mssql.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/db-mssql.yml?query=branch%3Amaster)[MySQL](https://github.com/yiisoft/db-mysql)[![Build status](https://github.com/yiisoft/active-record/actions/workflows/db-mysql.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/db-mysql.yml?query=branch%3Amaster)[Oracle](https://github.com/yiisoft/db-oracle)[![Build status](https://github.com/yiisoft/active-record/actions/workflows/db-oracle.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/db-oracle.yml?query=branch%3Amaster)[PostgreSQL](https://github.com/yiisoft/db-pgsql)[![Build status](https://github.com/yiisoft/active-record/actions/workflows/db-pgsql.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/db-pgsql.yml?query=branch%3Amaster)[SQLite](https://github.com/yiisoft/db-sqlite)[![Build status](https://github.com/yiisoft/active-record/actions/workflows/db-sqlite.yml/badge.svg?branch=master)](https://github.com/yiisoft/active-record/actions/workflows/db-sqlite.yml?query=branch%3Amaster)Requirements
------------

[](#requirements)

- PHP 8.1 - 8.5.

Installation
------------

[](#installation)

The package could be installed with [Composer](https://getcomposer.org):

```
composer require yiisoft/active-record
```

Important

See also [installation notes](https://github.com/yiisoft/db/?tab=readme-ov-file#documentation) for `yiisoft/db`package.

After installing `yiisoft/active-record`, you also need to configure a database connection:

1. Configure the connection, follow [Yii Database](https://github.com/yiisoft/db/blob/master/docs/guide/en/README.md)guide.
2. [Define the Database Connection for Active Record](docs/define-connection.md)

General usage
-------------

[](#general-usage)

Defined your active record class (for more information, follow [Create Active Record Model](docs/create-model.md) guide):

```
final class User extends \Yiisoft\ActiveRecord\ActiveRecord
{
    public int $id;
    public string $username;
    public string $email;
    public string $status = 'active';

    public function tableName(): string
    {
        return '{{%user}}';
    }
}
```

For fast prototyping you can use dynamic properties by adding `#[\AllowDynamicProperties]` attribute:

```
/**
 * Database fields:
 * @property int $id
 * @property string $username
 * @property string $email
 * @property string $status
 **/
#[\AllowDynamicProperties]
final class User extends \Yiisoft\ActiveRecord\ActiveRecord
{
}
```

Now you can use the active record:

```
// Creating a new record
$user = new User();
$user->username = 'alexander-pushkin';
$user->email = 'pushkin@example.com';
$user->save();

// Retrieving a record
$user = User::query()->findByPk(1);

// Read properties
$username = $user->username;
$email = $user->email;
```

Documentation
-------------

[](#documentation)

- [Define the Database Connection for Active Record](docs/define-connection.md)
- [Create Active Record Model](docs/create-model.md)
- [Define Active Record Relations](docs/define-relations.md)
- [Extending Functionality With Traits](docs/traits/traits.md)
- [Using Dependency Injection With Active Record Model](docs/using-di.md)
- [Optimistic Locking](docs/optimistic-locking.md)
- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

License
-------

[](#license)

The Yii Active Record is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

Support the project
-------------------

[](#support-the-project)

[![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft)

Follow updates
--------------

[](#follow-updates)

[![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack)

###  Health Score

63

—

FairBetter than 99% of packages

Maintenance82

Actively maintained with recent releases

Popularity48

Moderate usage in the ecosystem

Community42

Growing community involvement

Maturity72

Established project with proven stability

 Bus Factor3

3 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~46 days

Total

3

Last Release

68d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe)

![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark)

![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire)

![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol)

---

Top Contributors

[![Tigrov](https://avatars.githubusercontent.com/u/8563175?v=4)](https://github.com/Tigrov "Tigrov (136 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (87 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (64 commits)")[![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (57 commits)")[![darkdef](https://avatars.githubusercontent.com/u/8342004?v=4)](https://github.com/darkdef "darkdef (29 commits)")[![machour](https://avatars.githubusercontent.com/u/304450?v=4)](https://github.com/machour "machour (11 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (7 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (6 commits)")[![hiqsol](https://avatars.githubusercontent.com/u/11820365?v=4)](https://github.com/hiqsol "hiqsol (6 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (5 commits)")[![fcaldarelli](https://avatars.githubusercontent.com/u/4108673?v=4)](https://github.com/fcaldarelli "fcaldarelli (4 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (4 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![niqingyang](https://avatars.githubusercontent.com/u/5036407?v=4)](https://github.com/niqingyang "niqingyang (3 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (2 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (2 commits)")[![Arhell](https://avatars.githubusercontent.com/u/26163841?v=4)](https://github.com/Arhell "Arhell (2 commits)")[![sarabisohrab](https://avatars.githubusercontent.com/u/26074239?v=4)](https://github.com/sarabisohrab "sarabisohrab (1 commits)")[![DikoIbragimov](https://avatars.githubusercontent.com/u/167644693?v=4)](https://github.com/DikoIbragimov "DikoIbragimov (1 commits)")

---

Tags

active-recordactiverecorddatabasehacktoberfestyii3active-recordyii

###  Code Quality

TestsPHPUnit

Static AnalysisRector

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/yiisoft-active-record/health.svg)

```
[![Health](https://phpackages.com/badges/yiisoft-active-record/health.svg)](https://phpackages.com/packages/yiisoft-active-record)
```

###  Alternatives

[yiisoft/yii

Yii Web Programming Framework

4.8k5.6M262](/packages/yiisoft-yii)[yiisoft/yii2-queue

Yii2 Queue Extension which supports queues based on DB, Redis, RabbitMQ, Beanstalk, SQS, and Gearman

1.1k10.4M155](/packages/yiisoft-yii2-queue)[yiisoft/yii2-redis

Redis Cache, Session and ActiveRecord for the Yii framework

48011.7M245](/packages/yiisoft-yii2-redis)[yiisoft/yii2-elasticsearch

Elasticsearch integration and ActiveRecord for the Yii framework

4371.9M15](/packages/yiisoft-yii2-elasticsearch)[yiisoft/yii2-coding-standards

Yii PHP Framework Version 2 - Coding standard tools

1831.0M165](/packages/yiisoft-yii2-coding-standards)[yiisoft/arrays

Yii Array Helper

562.0M56](/packages/yiisoft-arrays)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
