yiisoft/yii2-collection

Active Record Collection implementation for the Yii framework

Maintainers

Package info

github.com/yiisoft/yii2-collection

Forum

Wiki

Type:yii2-extension

pkg:composer/yiisoft/yii2-collection

Fund package maintenance!

cebe

Open Collective

Statistics

Installs: 3 056

Dependents: 0

Suggesters: 0

Stars: 68

Open Issues: 10

dev-master / 2.0.x-dev 2026-02-09 14:14 UTC

This package is auto-updated.

Last update: 2026-03-09 14:20:13 UTC


README

ActiveRecord Collection Extension for Yii 2


This extension provides a generic data collection as well as a collection for the ActiveRecord DB layer of Yii 2.

Development is currently in experimental state. It is not ready for production use and may change significantly.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

Latest Stable Version Total Downloads Build Status codecov

Installation

Important

  • The minimum required PHP version is PHP 7.4.
  • It works best with PHP 8.

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiisoft/yii2-collection

or add

"yiisoft/yii2-collection": "~1.0.0"

to the require section of your composer.json.

Configuration

To use this extension, you have to attach the yii\collection\CollectionBehavior to the ActiveQuery instance of your ActiveRecord classes by overriding the find() method:

/**
 * {@inheritdoc}
 * @return \yii\db\ActiveQuery|\yii\collection\CollectionBehavior
 */
public static function find()
{
    $query = parent::find();
    $query->attachBehavior('collection', \yii\collection\CollectionBehavior::class);
    return $query;
}