Yii2 framework backup

67 KiB

Raw Blame History

アクティブレコード

Note|注意: この節はまだ執筆中です。

アクティブレコードは、データベースに保存されているデータにアクセスするために、オブジェクト指向のインタフェイスを提供するものです。アクティブレコードクラスはデータベーステーブルと関連付けられます。アクティブレコードのインスタンスはそのテーブルの行に対応し、アクティブレコードのインスタンスの属性がその行のカラムの値を表現します。データベーステーブルに保存されたデータにアクセスしたり、データを操作したりするために、生の SQL 文を書くのではなく、アクティブレコードの属性にアクセスしたり、アクティブレコードのメソッドを使ったりするのです。

例えば、Customer が customer テーブルに関連付けられたアクティブレコードクラスであり、name が customer テーブルのカラムであると仮定しましょう。 customer テーブルに新しい行を挿入するために次のコードを書くことが出来ます。

$customer = new Customer();
$customer->name = 'Qiang';
$customer->save();

上記のコードは、MySQL では、次のように生の SQL 文を使うのと等価なものです。しかし、生の SQL 文の方は、直感的でなく、間違いも生じやすく、また、別の種類のデータベースを使う場合には、互換性の問題も生じ得ます。

$db->createCommand('INSERT INTO `customer` (`name`) VALUES (:name)', [
    ':name' => 'Qiang',
])->execute();

Yii は次のリレーショナルデータベースに対して、アクティブレコードのサポートを提供しています。

MySQL 4.1 以降: yii\db\ActiveRecord による。
PostgreSQL 7.3 以降: yii\db\ActiveRecord による。
SQLite 2 および 3: yii\db\ActiveRecord による。
Microsoft SQL Server 2008 以降: yii\db\ActiveRecord による。
Oracle: yii\db\ActiveRecord による。
CUBRID 9.3 以降: yii\db\ActiveRecord による。(cubrid PDO 拡張のバグのために、値を引用符で囲む機能が動作しません。そのため、サーバだけでなくクライアントも CUBRID 9.3 が必要になります)
Sphinx: yii\sphinx\ActiveRecord による。yii2-sphinx エクステンションが必要。
ElasticSearch: yii\elasticsearch\ActiveRecord による。yii2-elasticsearch エクステンションが必要。

これらに加えて、Yii は次の NoSQL データベースに対しても、アクティブレコードの使用をサポートしています。

Redis 2.6.12 以降: yii\redis\ActiveRecord による。yii2-redis エクステンションが必要。
MongoDB 1.3.0 以降: yii\mongodb\ActiveRecord による。yii2-mongodb エクステンションが必要。

このチュートリアルでは、主としてリレーショナルデータベースのためのアクティブレコードの使用方法を説明します。しかし、ここで説明するほとんどの内容は NoSQL データベースのためのアクティブレコードにも適用することが出来るものです。

アクティブレコードクラスを宣言する

まずは、yii\db\ActiveRecord を拡張してアクティブレコードクラスを宣言するところから始めましょう。すべてのアクティブレコードクラスはデータベーステーブルと関連付けられますので、クラスの中で yii\db\ActiveRecord::tableName() メソッドをオーバーライドして、どのテーブルが関連付けられるかを指定しなければなりません。

次の例では、customer というデータベーステーブルのための Customer という名前のアクティブレコードクラスを宣言しています。

namespace app\models;

use yii\db\ActiveRecord;

class Customer extends ActiveRecord
{
    const STATUS_INACTIVE = 0;
    const STATUS_ACTIVE = 1;
    
    /**
     * @return string このアクティブレコードクラスと関連付けられるテーブルの名前
     */
    public static function tableName()
    {
        return 'customer';
    }
}

アクティブレコードのインスタンスはモデルであると見なされます。この理由により、私たちは通常 app\models 名前空間 (あるいはモデルクラスを保管するための他の名前空間) の下にアクティブレコードクラスを置きます。

yii\db\ActiveRecord は yii\base\Model から拡張していますので、属性、検証規則、データのシリアライゼーションなど、モデルが持つ 全ての 機能を継承しています。

データベースに接続する

デフォルトでは、アクティブレコードは、db アプリケーションコンポーネントを yii\db\Connection として使用して、データベースのデータにアクセスしたり操作したりします。データベースアクセスオブジェクトで説明したように、次のようにして、アプリケーションの構成情報ファイルの中で db コンポーネントを構成することが出来ます。

return [
    'components' => [
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=testdb',
            'username' => 'demo',
            'password' => 'demo',
        ],
    ],
];

アクティブレコードクラスのために db とは異なるデータベース接続を使いたい場合は、yii\db\ActiveRecord::getDb() メソッドをオーバーライドしなければなりません。

class Customer extends ActiveRecord
{
    // ...

    public static function getDb()
    {
        // "db2" アプリケーションコンポーネントを使用
        return \Yii::$app->db2;
    }
}

データをクエリする

アクティブレコードクラスを宣言した後、それを使って対応するデータベーステーブルからデータをクエリすることが出来ます。このプロセスは通常次の三つのステップを踏みます。

yii\db\ActiveRecord::find() メソッドを呼んで、新しいクエリオブジェクトを作成する。
クエリ構築メソッドを呼んで、クエリオブジェクトを構築する。
クエリメソッドを呼んで、アクティブレコードのインスタンスの形でデータを取得する。

ご覧のように、このプロセスはクエリビルダによる手続きと非常によく似ています。唯一の違いは、new 演算子を使ってクエリオブジェクトを生成する代りに、yii\db\ActiveRecord::find() を呼んで yii\db\ActiveQuery クラスであるクエリオブジェクトを返すという点です。

以下の例は、アクティブクエリを使ってデータをクエリする方法を示すものです。

// ID が 123 である一人の顧客を返す
// SELECT * FROM `customer` WHERE `id` = 123
$customer = Customer::find()
    ->where(['id' => 123])
    ->one();

// アクティブな全ての顧客を返して、ID によって並べる
// SELECT * FROM `customer` WHERE `status` = 1 ORDER BY `id`
$customers = Customer::find()
    ->where(['status' => Customer::STATUS_ACTIVE])
    ->orderBy('id')
    ->all();

// アクティブな顧客の数を返す
// SELECT COUNT(*) FROM `customer` WHERE `status` = 1
$count = Customer::find()
    ->where(['status' => Customer::STATUS_ACTIVE])
    ->count();

// アクティブな全ての顧客を顧客IDによってインデックスされた配列として返す
// SELECT * FROM `customer`
$customers = Customer::find()
    ->indexBy('id')
    ->all();

上記において、$customer は Customer オブジェクトであり、$customers は Customer オブジェクトの配列です。これらは全て customer テーブルから取得されたデータを投入されます。

Info|情報: yii\db\ActiveQuery は yii\db\Query から拡張しているため、クエリビルダの節で説明されたクエリ構築メソッドとクエリメソッドの全てを使うことが出来ます。

プライマリキーの値や一群のカラムの値でクエリをすることはよく行われる仕事ですので、Yii はこの目的のために、二つのショートカットメソッドを提供しています。

yii\db\ActiveRecord::findOne(): クエリ結果の最初の行を一つのアクティブレコードインスタンスに投入して返す。
yii\db\ActiveRecord::findAll(): 全ての クエリ結果をアクティブレコードインスタンスの配列に投入して返す。

どちらのメソッドも、次のパラメータ形式のどれかを取ることが出来ます。

スカラ値: 値は検索時に求められるプライマリキーの値として扱われます。 Yii は、データベースのスキーマ情報を読んで、どのカラムがプライマリキーのカラムであるかを自動的に判断します。
スカラ値の配列: 配列は検索時に求められるプライマリキーの値の配列として扱われます。
連想配列: キーはカラム名であり、値は検索時に求められる対応するカラムの値です。詳細については、ハッシュ形式を参照してください。

次のコードは、これらのメソッドの使用方法を示すものです。

// ID が 123 である一人の顧客を返す
// SELECT * FROM `customer` WHERE `id` = 123
$customer = Customer::findOne(123);

// ID が 100, 101, 123, 124 のどれかである顧客を全て返す
// SELECT * FROM `customer` WHERE `id` IN (100, 101, 123, 124)
$customers = Customer::findAll([100, 101, 123, 124]);

// ID が 123 であるアクティブな顧客を返す
// SELECT * FROM `customer` WHERE `id` = 123 AND `status` = 1
$customer = Customer::findOne([
    'id' => 123,
    'status' => Customer::STATUS_ACTIVE,
]);

// アクティブでない全ての顧客を返す
// SELECT * FROM `customer` WHERE `status` = 0
$customer = Customer::findAll([
    'status' => Customer::STATUS_INACTIVE,
]);

Note|注意: yii\db\ActiveRecord::findOne() も yii\db\ActiveQuery::one() も、生成される SQL 文に LIMIT 1 を追加しません。あなたのクエリが多数のデータ行を返すかもしれない場合は、パフォーマンスを向上させるために、例えば Customer::find()->limit(1)->one() のように、limit(1) を明示的に呼ぶべきです。。

クエリ構築メソッドを使う以外に、生の SQL を書いてデータをクエリして結果をアクティブレコードオブジェクトに投入することも出来ます。 yii\db\ActiveRecord::queryBySql() メソッドを呼ぶことによってそうすることが出来ます。

// アクティブでない全ての顧客を返す
$sql = 'SELECT * FROM customer WHERE status=:status';
$customers = Customer::findBySql($sql, [':status' => Customer::STATUS_INACTIVE])->all();

yii\db\ActiveRecord::queryBySql() を呼んだ後では、無視されますので、クエリ構築メソッドを追加で呼び出してはいけません。

データにアクセスする

既に述べたように、データベースから取得されたデータはアクティブレコードのインスタンスに投入されます。そして、クエリ結果の各行がアクティブレコードの一つのインスタンスに対応します。アクティブレコードインスタンスの属性にアクセスすることによって、カラムの値にアクセスすることが出来ます。例えば、

// "id" と "email" は "customer" テーブルのカラム名
$customer = Customer::findOne(123);
$id = $customer->id;
$email = $customer->email;

Note|注意: アクティブレコードの属性の名前は、関連付けられたテーブルのカラムの名前に従って、大文字と小文字を区別して名付けられます。 Yii は、関連付けられたテーブルの全てのカラムに対して、アクティブレコードの属性を自動的に定義します。これらの属性は、すべて、再宣言してはいけません。

アクティブレコードの属性はテーブルのカラムに従って命名されるため、テーブルのカラム名がアンダースコアで単語を分ける方法で命名されている場合は、$customer->first_name のような属性名を使って PHP コードを書くことになります。コードスタイルの一貫性が気になるのであれば、テーブルのカラム名を (例えば camelCase を使う名前に) 変更しなければなりません。

データ変換

入力または表示されるデータの形式が、データベースにデータを保存するときに使われるものと異なる場合がよくあります。例えば、データベースでは顧客の誕生日を UNIX タイムスタンプで保存している (まあ、あまり良い設計ではありませんが) けれども、ほとんどの場合において誕生日を 'YYYY/MM/DD' という形式の文字列として操作したい、というような場合です。この目的を達するために、次のように、Customer アクティブレコードクラスにおいてデータ変換メソッドを定義することが出来ます。

class Customer extends ActiveRecord
{
    // ...

    public function getBirthdayText()
    {
        return date('Y/m/d', $this->birthday);
    }
    
    public function setBirthdayText($value)
    {
        $this->birthday = strtotime($value);
    }
}

このようにすれば、PHP コードにおいて、$customer->birthday にアクセスする代りに、$customer->birthdayText にアクセスすれば、顧客の誕生日を 'YYYY/MM/DD' の形式で入力および表示することが出来ます。

データを配列に取得する

データをアクティブレコードオブジェクトの形で取得するのは便利であり柔軟ですが、大きなメモリ使用量を要するために、大量のデータを取得しなければならない場合は、必ずしも望ましい方法ではありません。そういう場合は、クエリメソッドを実行する前に yii\db\ActiveQuery::asArray() を呼ぶことによって、PHP 配列を使ってデータを取得することが出来ます。

// すべての顧客を返す
// 各顧客は連想配列として返される
$customers = Customer::find()
    ->asArray()
    ->all();

Note|注意: このメソッドはメモリを節約してパフォーマンスを向上させますが、低レベルの DB 抽象レイヤに近いものであり、あなたはアクティブレコードの機能をほとんど失うことになります。非常に重要な違いがカラムの値のデータタイプにあります。アクティブレコードインスタンスとしてデータを返す場合、カラムの値は実際のカラムの型に従って自動的に型キャストされます。一方、配列としてデータを返す場合は、実際のカラムの型に関係なく、カラムの値は文字列になります。なぜなら、何も処理をしない場合の PDO の結果は文字列だからです。

データをバッチモードで取得する

クエリビルダにおいて、大量のデータをデータベースから検索する場合に、メモリ使用量を最小化するために バッチクエリ を使うことが出来るということを説明しました。おなじテクニックをアクティブレコードでも使うことが出来ます。例えば、

// 一度に 10 人の顧客を読み出す
foreach (Customer::find()->batch(10) as $customers) {
    // $customers は 10 以下の Customer オブジェクトの配列
}
// 一度に 10 人の顧客を読み出して、一人ずつ反復する
foreach (Customer::find()->each(10) as $customer) {
    // $customer は Customer オブジェクト
}
// イーガーローディングをするバッチクエリ
foreach (Customer::find()->with('orders')->each() as $customer) {
}

データを保存する

アクティブレコードを使えば、次のステップを踏んで簡単にデータをデータベースに保存することが出来ます。

アクティブレコードのインスタンスを準備する
アクティブレコードの属性に新しい値を割り当てる
yii\db\ActiveRecord::save() を呼んでデータをデータベースに保存する

例えば、

// 新しいデータ行を挿入する $customer = new Customer(); $customer->name = 'James'; $customer->email = 'james@example.com'; $customer->save();

// 既存のデータ行を更新する $customer = Customer::findOne(123); $customer->email = 'james@newexample.com'; $customer->save();


[[yii\db\ActiveRecord::save()|save()]] メソッドは、アクティブレコードインスタンスの状態に従って、データ行を挿入するか、または、更新することが出来ます。
インスタンスが `new` 演算子によって新しく作成されたものである場合は、[[yii\db\ActiveRecord::save()|save()]] を呼び出すと、新しい行が挿入されます。
インスタンスがクエリメソッドの結果である場合は、[[yii\db\ActiveRecord::save()|save()]] を呼び出すと、そのインスタンスと関連付けられた行が更新されます。

アクティブレコードインスタンスの二つの状態は、その [[yii\db\ActiveRecord::isNewRecord|isNewRecord]] プロパティの値をチェックすることによって区別することが出来ます。
下記のように、このプロパティは [[yii\db\ActiveRecord::save()|save()]] によっても内部的に使用されています。

```php
public function save($runValidation = true, $attributeNames = null)
{
    if ($this->getIsNewRecord()) {
        return $this->insert($runValidation, $attributeNames);
    } else {
        return $this->update($runValidation, $attributeNames) !== false;
    }
}

Tip|ヒント: yii\db\ActiveRecord::insert() または yii\db\ActiveRecord::update() を直接に呼んでも、行を挿入または更新することが出来ます。

データの検証

yii\db\ActiveRecord は yii\base\Model を拡張したものですので、同じデータ検証機能を共有しています。例えば、yii\base\Model::rules() メソッドをオーバーライドして検証規則を宣言することが出来ます。 yii\db\ActiveRecord::rules() メソッドをオーバーライドすることによって検証規則を宣言し、myii\db\ActiveRecord::validate() メソッドを呼不ことによってテータの検証を実行することが出来ます。

yii\db\ActiveRecord::save() を呼ぶと、デフォルトでは yii\db\ActiveRecord::validate() を自動的に呼びます。検証が通った時だけ、実際にデータが保存されます。検証が通らなかった時は単に false が返され、yii\db\ActiveRecord::errors プロパティをチェックして検証エラーメッセージを取得することが出来ます。

Tip|情報: データが検証を必要としないことが確実である場合 (例えば、データが信頼できるソースに由来するものである場合) は、検証をスキップするために save(false) を呼ぶことが出来ます。

一括代入

通常のモデルと同じように、アクティブレコードのインスタンスも一括代入機能を享受することが出来ます。この機能を使うと、下記で示されているように、一つの PHP 文で、アクティブレコードインスタンスの複数の属性に値を割り当てることが出来ます。ただし、安全な属性だけが一括代入が可能であることを記憶しておいてください。

$values = [
    'name' => 'James',
    'email' => 'james@example.com',
];

$customer = new Customer();

$customer->attributes = $values;
$customer->save();

カウンタを更新する

データベーステーブルのあるカラムの値を増加・減少させるのは、よくある仕事です。私たちはそのようなカラムをカウンタカラムと呼んでいます。 yii\db\ActiveRecord::updateCounters() を使って一つまたは複数のカウンタカラムを更新することが出来ます。例えば、

$post = Post::findOne(100);

// UPDATE `post` SET `view_count` = `view_count` + 1 WHERE `id` = 100
$post->updateCounters(['view_count' => 1]);

Note|注意: カウンタカラムを更新するのに yii\db\ActiveRecord::save() を使うと、不正確な結果になってしまう場合があります。というのは、同じカウンタの値を読み書きする複数のリクエストによって、同一のカウンタが保存される可能性があるからです。

ダーティな属性

yii\db\ActiveRecord::save() を呼んでアクティブレコードインスタンスを保存すると、ダーティな属性 だけが保存されます。属性は、DB からロードされた後、または、最後に保存された後にその値が変更されると、ダーティ であると見なされます。ただし、データ検証は、アクティブレコードインスタンスがダーティな属性を持っているかどうかに関係なく実施されることに注意してください。

アクティブレコードはダーティな属性のリストを自動的に保守します。そうするために、一つ前のバージョンの属性値を保持して、最新のバージョンと比較します。 yii\db\ActiveRecord::getDirtyAttributes() を呼ぶと、現在ダーティである属性を取得することが出来ます。また、yii\db\ActiveRecord::markAttributeDirty() を呼んで、ある属性をダーティであると明示的にマークすることも出来ます。

最新の修正を受ける前の属性値を知りたい場合は、yii\db\ActiveRecord::getOldAttributes() または yii\db\ActiveRecord::getOldAttribute() を呼ぶことが出来ます。

デフォルト属性値

あなたのテーブルのカラムの中には、データベースでデフォルト値が定義されているものもあるかも知れません。そして、場合によっては、アクティブレコードインスタンスのウェブフォームに、そういうデフォルト値をあらかじめ投入したいことがあるでしょう。同じデフォルト値を繰り返して書くことを避けるために、yii\db\ActiveRecord::loadDefaultValues() を呼んで、DB で定義されたデフォルト値を対応するアクティブレコードの属性に投入することが出来ます。

$customer = new Customer();
$customer->loadDefaultValues();
// $customer->xyz には、"xyz" カラムを定義するときに宣言されたデフォルト値が割り当てられる

複数の行を更新する

上述のメソッドは、すべて、個別のアクティブレコードインスタンスに対して作用し、個別のテーブル行を挿入したり更新したりするものです。複数の行を同時に更新するためには、代りに、スタティックなメソッドである yii\db\ActiveRecord::updateAll() を呼ばなければなりません。

// UPDATE `customer` SET `status` = 1 WHERE `email` LIKE `%@example.com`
Customer::updateAll(['status' => Customer::STATUS_ACTIVE], ['like', 'email', '@example.com']);

同様に、yii\db\ActiveRecord::updateAllCounters() を呼んで、複数の行のカウンタカラムを同時に更新することが出来ます。

// UPDATE `customer` SET `age` = `age` + 1
Customer::updateAllCounters(['age' => 1]);

データを削除する

一行のデータを削除するためには、最初にその行に対応するアクティブレコードインスタンスを取得して、次に yii\db\ActiveRecord::delete() メソッドを呼びます。

$customer = Customer::findOne(123);
$customer->delete();

yii\db\ActiveRecord::deleteAll() を呼んで、複数またはすべてのデータ行を削除することが出来ます。例えば、

Customer::deleteAll(['status' => Customer::STATUS_INACTIVE]);

Note|注意: yii\db\ActiveRecord::deleteAll() を呼ぶときは、十分に注意深くしてください。なぜなら、条件の指定を間違うと、あなたのテーブルからすべてのデータを完全に消し去ってしまうことになるからです。

アクティブレコードのライフサイクル

アクティブレコードがさまざまな目的で使用される場合のそれぞれのライフサイクルを理解しておくことは重要なことです。それぞれのライフサイクルにおいては、特定の一続きのメソッドが呼び出されます。そして、これらのメソッドをオーバーライドして、ライフサイクルをカスタマイズするチャンスを得ることが出来ます。また、ライフサイクルの中でトリガされる特定のアクティブレコードイベントに反応して、あなたのカスタムコードを挿入することも出来ます。これらのイベントが特に役に立つのは、アクティブレコードのライフサイクルをカスタマイズする必要のあるアクティブレコードビヘイビアを開発する際です。

次に、さまざまなアクティブレコードのライフサイクルと、そのライフサイクルに含まれるメソッドやイベントを要約します。

新しいインスタンスのライフサイクル

new 演算子によって新しいアクティブレコードインスタンスを作成する場合は、次のライフサイクルを経ます。

クラスのコンストラクタ。
yii\db\ActiveRecord::init(): yii\db\ActiveRecord::EVENT_INIT イベントをトリガ。

データをクエリする際のライフサイクル

クエリメソッドのどれか一つによってデータをクエリする場合は、新しくデータを投入されるアクティブレコードは次のライフサイクルを経ます。

クラスのコンストラクタ。
yii\db\ActiveRecord::init(): yii\db\ActiveRecord::EVENT_INIT イベントをトリガ。
yii\db\ActiveRecord::afterFind(): yii\db\ActiveRecord::EVENT_AFTER_FIND イベントをトリガ。

データを保存する際のライフサイクル

yii\db\ActiveRecord::save() を呼んでアクティブレコードインスタンスを挿入または更新する場合は、次のライフサイクルを経ます。

yii\db\ActiveRecord::beforeValidate(): yii\db\ActiveRecord::EVENT_BEFORE_VALIDATE イベントをトリガ。このメソッドが false を返すか、yii\base\ModelEvent::isValid が false であった場合、残りのステップはスキップされる。
データ検証を実行。データ検証が失敗した場合、3 以降のステップはスキップされる。
yii\db\ActiveRecord::afterValidate(): yii\db\ActiveRecord::EVENT_AFTER_VALIDATE イベントをトリガ。
yii\db\ActiveRecord::beforeSave(): yii\db\ActiveRecord::EVENT_BEFORE_INSERT または yii\db\ActiveRecord::EVENT_BEFORE_UPDATE イベントをトリガ。このメソッドが false を返すか、yii\base\ModelEvent::isValid が false であった場合、残りのステップはスキップされる。
実際のデータの挿入または更新を実行する。
yii\db\ActiveRecord::afterSave(): yii\db\ActiveRecord::EVENT_AFTER_INSERT または yii\db\ActiveRecord::EVENT_AFTER_UPDATE イベントをトリガ。

データを削除する際のライフサイクル

yii\db\ActiveRecord::delete() を呼んでアクティブレコードインスタンスを削除する際は、次のライフサイクルを経ます。

yii\db\ActiveRecord::beforeDelete(): yii\db\ActiveRecord::EVENT_BEFORE_DELETE イベントをトリガ。このメソッドが false を返すか、yii\base\ModelEvent::isValid が false であった場合は、残りのステップはスキップされる。
実際のデータの削除を実行する。
yii\db\ActiveRecord::afterDelete(): yii\db\ActiveRecord::EVENT_AFTER_DELETE イベントをトリガ。

Note|注意: 次のメソッドは、どれを呼んでも、上記のライフサイクルを開始させません。

yii\db\ActiveRecord::updateAll()

yii\db\ActiveRecord::deleteAll()

yii\db\ActiveRecord::updateCounters()

yii\db\ActiveRecord::updateAllCounters()

トランザクションを扱う

アクティブレコードを扱う際には、二つの方法でトランザクションを処理することができます。

最初の方法は、次に示すように、アクティブレコードのメソッドの呼び出しを明示的にトランザクションのブロックで囲む方法です。

$customer = Customer::findOne(123);

Customer::getDb()->transaction(function($db) use ($customer) {
    $customer->id = 200;
    $customer->save();
    // ... 他の DB 操作 ...
});

// あるいは、別の方法

$transaction = Customer::getDb()->beginTransaction();
try {
    $customer->id = 200;
    $customer->save();
    // ... 他の DB 操作 ...
    $transaction->commit();
} catch(\Exception $e) {
    $transaction->rollBack();
    throw $e;
}

第二の方法は、トランザクションのサポートが必要な DB 操作を yii\db\ActiveRecord::transactions() メソッドに列挙するという方法です。

class Post extends \yii\db\ActiveRecord
{
    public function transactions()
    {
        return [
            'admin' => self::OP_INSERT,
            'api' => self::OP_INSERT | self::OP_UPDATE | self::OP_DELETE,
            // 上は次と等価
            // 'api' => self::OP_ALL,
        ];
    }
}

yii\db\ActiveRecord::transactions() メソッドは、キーが scenario の名前であり、値がトランザクションで囲まれるべき操作である配列を返さなくてはなりません。次の定数を使って、異なる DB 操作を参照しなければなりません。

yii\db\ActiveRecord::OP_INSERT: yii\db\ActiveRecord::insert() によって実行される挿入の操作。
yii\db\ActiveRecord::OP_UPDATE: yii\db\ActiveRecord::update() によって実行される更新の操作。
yii\db\ActiveRecord::OP_DELETE: yii\db\ActiveRecord::delete() によって実行される削除の操作。

複数の操作を示すためには、| を使って上記の定数を連結してください。ショートカット定数 yii\db\ActiveRecord::OP_ALL を使って、上記の三つの操作すべてを示すことも出来ます。

楽観的ロック

楽観的ロックは、一つのデータ行が複数のユーザによって更新されるときに発生しうる衝突を回避するための方法です。例えば、ユーザ A とユーザ B が同時に同じ wiki 記事を編集しており、ユーザ A が自分の編集結果を保存した後に、ユーザ B も自分の編集結果を保存しようとして「保存」ボタンをクリックする場合を考えてください。ユーザ B は、実際には古くなったバージョンの記事に対する操作をしようとしていますので、彼が記事を保存するのを防止して、彼に何らかのヒントメッセージを表示する方策を取ることが望まれます。

楽観的ロックは、あるカラムを使って各行のバージョン番号を記録するという方法によって、上記の問題を解決します。行が古くなったバージョン番号とともに保存されようとすると、yii\db\StaleObjectException 例外が投げられて、行が保存されるのが防止されます。楽観的ロックは、 yii\db\ActiveRecord::update() または yii\db\ActiveRecord::delete() メソッドを使って既存の行を更新または削除しようとする場合にだけサポートされます。

楽観的ロックを使用するためには、次のようにします。

アクティブレコードクラスと関連付けられている DB テーブルに、各行のバージョン番号を保存するカラムを作成します。カラムは長倍精度整数 (big integer) タイプでなければなりません (MySQL では BIGINT DEFAULT 0 です)。
yii\db\ActiveRecord::optimisticLock() メソッドをオーバーライドして、このカラムの名前を返すようにします。
ユーザ入力を収集するウェブフォームに、更新されるレコードの現在のバージョン番号を保持する隠しフィールドを追加します。
アクティブレコードを使って行の更新を行うコントローラアクションにおいて、\yii\db\StaleObjectException 例外を捕捉して、衝突を解決するために必要なビジネスロジック (例えば、変更をマージしたり、データの陳腐化を知らせたり) を実装します。

例えば、バージョン番号のカラムが version と名付けられているとすると、次のようなコードによって楽観的ロックを実装することが出来ます。

// ------ ビューのコード -------

use yii\helpers\Html;

// ... 他の入力フィールド
echo Html::activeHiddenField($model, 'version');


// ------ コントローラのコード -------

use yii\db\StaleObjectException;

public function actionUpdate($id)
{
    $model = $this->findModel($id);

    try {
        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['view', <?= $urlParams ?>]);
        } else {
            return $this->render('update', [
                'model' => $model,
            ]);
        }
    } catch (StaleObjectException $e) {
        // 衝突を解決するロジック
    }
}

リレーショナルデータを扱う

個々のデータベーステーブルを扱うだけでなく、アクティブレコードは関連したテーブルのデータも一緒に読み出して、主たるデータを通して簡単にアクセス出来るようにすることが出来ます。例えば、一人の顧客は一つまたは複数の注文を発することがあり得ますので、顧客のデータは注文のデータと関連を持っていることになります。このリレーションが適切に宣言されていれば、$customer->orders という式を使って顧客の注文情報にアクセスすることが出来ます。$customer->orders は、顧客の注文情報を Order アクティブレコードインスタンスの配列として返してくれます。

リレーションを宣言する

アクティブレコードを使ってリレーショナルデータを扱うためには、最初に、アクティブレコードクラスの中でリレーションを宣言する必要があります。これは、以下のように、関心のあるそれぞれのリレーションについて リレーションメソッド を宣言するだけの簡単な作業です。

class Customer extends ActiveRecord
{
    public function getOrders()
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id']);
    }
}

class Order extends ActiveRecord
{
    public function getCustomer()
    {
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
}

上記のコードでは、Customer クラスのために orders リレーションを宣言し、Order クラスのために customer リレーションを宣言しています。

各リレーションメソッドは getXyz という名前にしなければなりません。ここで xyz (最初の文字は小文字です) が リレーション名 と呼ばれます。リレーション名は 大文字と小文字を区別する ことに注意してください。

リレーションを宣言する際には、次の情報を指定しなければなりません。

リレーションの多重性: yii\db\ActiveRecord::hasMany() または yii\db\ActiveRecord::hasOne() のどちらかを呼ぶことによって指定されます。上記の例では、リレーションの宣言において、顧客は複数の注文を持つが、一方、注文は一人の顧客しか持たないということが容易に読み取れます。
関連するアクティブレコードクラスの名前: yii\db\ActiveRecord::hasMany() または yii\db\ActiveRecord::hasOne() の最初のパラメータとして指定されます。クラス名を取得するのに Xyz::className() を呼ぶのが推奨されるプラクティスです。そうすれば、IDE の自動補完のサポートを得ることことが出来るだけでなく、コンパイル段階でエラーを検出することが出来ます。
二つのデータタイプ間のリンク: 二つのデータタイプの関連付けに用いられるカラムを指定します。配列の値は主たるデータ (リレーションを宣言しているアクティブレコードクラスによって表されるデータ) のカラムであり、配列のキーは関連するデータのカラムです。

リレーショナルデータにアクセスする

リレーションを宣言した後は、リレーション名を通じてリレーショナルデータにアクセスすることが出来ます。これは、リレーションメソッドによって定義されるオブジェクトプロパティにアクセスするのと同様です。このため、これを リレーションプロパティ と呼びます。例えば、

// SELECT * FROM `customer` WHERE `id` = 123
$customer = Customer::findOne(123);

// SELECT * FROM `order` WHERE `customer_id` = 123
// $orders is an array of Order objects
$orders = $customer->orders;

Info|情報: xyz という名前のリレーションを getter メソッド getXyz() によって宣言すると、xyz をオブジェクトプロパティのようにアクセスすることが出来るようになります。名前は大文字と小文字を区別することに注意してください。

リレーションが yii\db\ActiveRecord::hasMany() によって宣言されている場合は、このリレーションプロパティにアクセスすると、関連付けられたアクティブレコードインスタンスの配列が返されます。リレーションが yii\db\ActiveRecord::hasOne() によって宣言されている場合は、このリレーションプロパティにアクセスすると、関連付けられたアクティブレコードインスタンスか、関連付けられたデータが見つからないときは null が返されます。

リレーションプロパティに最初にアクセスしたときは、上記の例で示されているように、SQL 文が実行されます。同じプロパティに再びアクセスしたときは、以前の結果が返されて、SQL 文が追加で実行されることはありません。 SQL 文の再実行を強制するためには、まず、リレーションプロパティの割り当てを解除 (unset) します : unset($customer->orders)。

動的なリレーショナルクエリ

リレーションメソッドは yii\db\ActiveQuery のインスタンスを返すため、DB クエリを実行する前に、クエリ構築メソッドを使ってこのクエリを更に修正することが出来ます。例えば、

$customer = Customer::findOne(123);

// SELECT * FROM `order` WHERE `subtotal` > 200 ORDER BY `id`
$orders = $customer->getOrders()
    ->where(['>', 'subtotal', 200])
    ->orderBy('id')
    ->all();

さらに進んで、もっと簡単に動的なリレーショナルクエリを実行できるように、リレーションの宣言をパラメータ化したい場合もあるでしょう。例えば、bigOrders リレーションを下記のように宣言することが出来ます。

class Customer extends ActiveRecord
{
    public function getBigOrders($threshold = 100)
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id'])
            ->where('subtotal > :threshold', [':threshold' => $threshold])
            ->orderBy('id');
    }
}

これによって、次のリレーショナルクエリを実行することが出来るようになります。

// SELECT * FROM `order` WHERE `subtotal` > 200 ORDER BY `id`
$orders = $customer->getBigOrders(200)->all();

// SELECT * FROM `order` WHERE `subtotal` > 100 ORDER BY `id`
$orders = $customer->bigOrders;

Note|注意: リレーションメソッドが yii\db\ActiveQuery インスタンスを返すのに対して、リレーションプロパティにアクセスすると yii\db\ActiveRecord のインスタンスまたはその配列が返されます。この点は通常のオブジェクトプロパティと異なります。通常のオブジェクトプロパティは、プロパティを定義する getter メソッドと同じ型の値を持ちます。

リレーショナルプロパティにアクセスする場合と異なって、リレーショナルメソッドを使って動的なリレーショナルクエリを実行する場合は、前に同じ動的リレーショナルクエリが実行されている場合であっても、毎回、SQL 文が実行されます。

中間テーブルによるリレーション

データベースの設計において、二つの関連するテーブル間の多重性が many-to-many である場合は、中間テーブルが通常は導入されます。例えば、order テーブルと item テーブルは、order_item と言う名前の中間テーブルによって関連付けることが出来ます。このようにすれば、一つの注文を複数の商品に対応させ、また、一つの商品を複数の注文に対応させることが出来ます。

このようなリレーションを宣言するときは、yii\db\ActiveQuery::via() または yii\db\ActiveQuery::viaTable() のどちらかを呼んで中間テーブルを指定します。 yii\db\ActiveQuery::via() と yii\db\ActiveQuery::viaTable() の違いは、前者が既存のリレーション名の形式で中間テーブルを指定するのに対して、後者は中間テーブルを直接に指定する、という点です。例えば、

class Order extends ActiveRecord
{
    public function getItems()
    {
        return $this->hasMany(Item::className(), ['id' => 'item_id'])
            ->viaTable('order_item', ['order_id' => 'id']);
    }
}

あるいは、また、

class Order extends ActiveRecord
{
    public function getOrderItems()
    {
        return $this->hasMany(OrderItem::className(), ['order_id' => 'id']);
    }

    public function getItems()
    {
        return $this->hasMany(Item::className(), ['id' => 'item_id'])
            ->via('orderItems');
    }
}

中間テーブルを使って宣言されたリレーションの使い方は、通常のリレーションと同じです。例えば、

// SELECT * FROM `order` WHERE `id` = 100
$order = Order::findOne(100);

// SELECT * FROM `order_item` WHERE `order_id` = 100
// SELECT * FROM `item` WHERE `item_id` IN (...)
// 商品オブジェクトの配列を返す
$items = $order->items;

レイジーローディングとイーガーローディング

前に述べたように、関連オブジェクトに最初にアクセスしたときに、アクティブレコードは DB クエリを実行して関連データを読み出し、それを関連オブジェクトに投入します。同じ関連オブジェクトに再度アクセスしても、クエリは実行されません。これを レイジーローディング と呼びます。例えば、

// 実行される SQL: SELECT * FROM customer WHERE id=1
$customer = Customer::findOne(1);
// 実行される SQL: SELECT * FROM order WHERE customer_id=1
$orders = $customer->orders;
// SQL は実行されない
$orders2 = $customer->orders;

レイジーローディングは非常に使い勝手が良いものです。しかし、次のシナリオでは、パフォーマンスの問題を生じ得ます。

// 実行される SQL: SELECT * FROM customer WHERE id=1
$customers = Customer::find()->limit(100)->all();

foreach ($customers as $customer) {
    // 実行される SQL: SELECT * FROM order WHERE customer_id=...
    $orders = $customer->orders;
    // ... $orders を処理 ...
}

データベースに 100 人以上の顧客が登録されていると仮定した場合、上記のコードで何個の SQL クエリが実行されるでしようか? 101 です。最初の SQL クエリが 100 人の顧客を返します。次に、100 人の顧客全てについて、それぞれ、顧客の注文を返すための SQL クエリが実行されます。

上記のパフォーマンスの問題を解決するためには、yii\db\ActiveQuery::with() を呼んでいわゆる イーガーローディング を使うことが出来ます。

// 実行される SQL: SELECT * FROM customer LIMIT 100;
//                 SELECT * FROM orders WHERE customer_id IN (1,2,...)
$customers = Customer::find()->limit(100)
    ->with('orders')->all();

foreach ($customers as $customer) {
    // SQL は実行されない
    $orders = $customer->orders;
    // ... $orders を処理 ...
}

ご覧のように、同じ仕事をするのに必要な SQL クエリがたった二つになります。

Info|情報: 一般化して言うと、N 個のリレーションのうち M 個のリレーションが via() または viaTable() によって定義されている場合、この N 個のリレーションをイーガーロードしようとすると、合計で 1+M+N 個の SQL クエリが実行されます。主たるテーブルの行を返すために一つ、via() または viaTable() の呼び出しに対応する M 個の中間テーブルのそれぞれに対して一つずつ、そして、N 個の関連テーブルのそれぞれに対して一つずつ、という訳です。

Note|注意: イーガーローディングで select() をカスタマイズしようとする場合は、関連モデルにリンクするカラムを必ず含めてください。そうしないと、関連モデルは読み出されません。例えば、

$orders = Order::find()->select(['id', 'amount'])->with('customer')->all();
// $orders[0]->customer は常に null になる。この問題を解決するためには、次のようにしなければならない。
$orders = Order::find()->select(['id', 'amount', 'customer_id'])->with('customer')->all();

場合によっては、リレーショナルクエリをその場でカスタマイズしたいことがあるでしょう。これは、レイジーローディングでもイーガーローディングでも、可能です。例えば、

$customer = Customer::findOne(1);
// レイジーローディング: SELECT * FROM order WHERE customer_id=1 AND subtotal>100
$orders = $customer->getOrders()->where('subtotal>100')->all();

// イーガーローディング: SELECT * FROM customer LIMIT 100
//                       SELECT * FROM order WHERE customer_id IN (1,2,...) AND subtotal>100
$customers = Customer::find()->limit(100)->with([
    'orders' => function($query) {
        $query->andWhere('subtotal>100');
    },
])->all();

逆リレーション

リレーションは、たいていの場合、ペアで定義することが出来ます。例えば、Customer が orders という名前のリレーションを持ち、Order が customer という名前のリレーションを持つ、ということがあります。

class Customer extends ActiveRecord
{
    ....
    public function getOrders()
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id']);
    }
}

class Order extends ActiveRecord
{
    ....
    public function getCustomer()
    {
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
}

次に例示するクエリを実行すると、注文 (order) のリレーションとして取得した顧客 (customer) が、最初にその注文をリレーションとして取得した顧客とは別の Customer オブジェクトになってしまうことに気付くでしょう。また、customer->orders にアクセスすると一個の SQL が実行され、order->customer にアクセスするともう一つ別の SQL が実行されるということにも気付くでしょう。

// SELECT * FROM customer WHERE id=1
$customer = Customer::findOne(1);
// "等しくない" がエコーされる
// SELECT * FROM order WHERE customer_id=1
// SELECT * FROM customer WHERE id=1
if ($customer->orders[0]->customer === $customer) {
    echo '等しい';
} else {
    echo '等しくない';
}

冗長な最後の SQL 文の実行を避けるためには、次のように、yii\db\ActiveQuery::inverseOf() メソッドを呼んで、customer と oerders のリレーションに対して逆リレーションを宣言することが出来ます。

class Customer extends ActiveRecord
{
    ....
    public function getOrders()
    {
        return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('customer');
    }
}

こうすると、上記と同じクエリを実行したときに、次の結果を得ることが出来ます。

// SELECT * FROM customer WHERE id=1
$customer = Customer::findOne(1);
// "等しい" がエコーされる
// SELECT * FROM order WHERE customer_id=1
if ($customer->orders[0]->customer === $customer) {
    echo '等しい';
} else {
    echo '等しくない';
}

上記では、レイジーローディングにおいて逆リレーションを使う方法を示しました。逆リレーションはイーガーローディングにも適用されます。

// SELECT * FROM customer
// SELECT * FROM order WHERE customer_id IN (1, 2, ...)
$customers = Customer::find()->with('orders')->all();
// "等しい" がエコーされる
if ($customers[0]->orders[0]->customer === $customers[0]) {
    echo '等しい';
} else {
    echo '等しくない';
}

Note|注意: 逆リレーションはピボットテーブルを含むリレーションに対しては定義することが出来ません。つまり、リレーションが yii\db\ActiveQuery::via() または yii\db\ActiveQuery::viaTable() によって定義されている場合は、yii\db\ActiveQuery::inverseOf() を追加で呼ぶことは出来ません。

リレーションを使ってテーブルを結合する

リレーショナルデータベースを扱う場合、複数のテーブルを結合して、JOIN SQL 文にさまざまなクエリ条件とパラメータを指定することは、ごく当り前の仕事です。その目的を達するために、[[yii\db\ActiveQuery::join()]] を明示的に呼んで JOIN クエリを構築する代りに、既存のリレーション定義を再利用して [[yii\db\ActiveQuery::joinWith()]] を呼ぶことが出来ます。例えば、

// 全ての注文を検索して、注文を顧客 ID と注文 ID でソートする。同時に "customer" をイーガーロードする。
$orders = Order::find()->joinWith('customer')->orderBy('customer.id, order.id')->all();
// 書籍を含む全ての注文を検索し、"books" をイーガーロードする。
$orders = Order::find()->innerJoinWith('books')->all();

上記において、[[yii\db\ActiveQuery::innerJoinWith()|innerJoinWith()]] メソッドは、結合タイプを INNER JOIN とする [[yii\db\ActiveQuery::joinWith()|joinWith()]] へのショートカットです。

一個または複数のリレーションを結合することが出来ます。リレーションにクエリ条件をその場で適用することも出来ます。また、サブリレーションを結合することも出来ます。例えば、

// 複数のリレーションを結合
// 書籍を含む注文で、過去 24 時間以内に登録した顧客によって発行された注文を検索する
$orders = Order::find()->innerJoinWith([
    'books',
    'customer' => function ($query) {
        $query->where('customer.created_at > ' . (time() - 24 * 3600));
    }
])->all();
// サブリレーションとの結合: 書籍および書籍の著者を結合
$orders = Order::find()->joinWith('books.author')->all();

舞台裏では、Yii は最初に JOIN SQL 文を実行して、その JOIN SQL に適用された条件を満たす主たるモデルを取得します。そして、次にリレーションごとのクエリを実行して、対応する関連レコードを投入します。

[[yii\db\ActiveQuery::joinWith()|joinWith()]] と [[yii\db\ActiveQuery::with()|with()]] の違いは、前者が主たるモデルクラスのテーブルと関連モデルクラスのテーブルを結合して主たるモデルを読み出すのに対して、後者は主たるモデルクラスのテーブルに対してだけクエリを実行して主たるモデルを読み出す、という点にあります。

この違いによって、[[yii\db\ActiveQuery::joinWith()|joinWith()]] では、JOIN SQL 文だけに指定できるクエリ条件を適用することが出来ます。例えば、上記の例のように、関連モデルに対する条件によって主たるモデルをフィルタすることが出来ます。主たるモデルを関連テーブルのカラムを使って並び替えることも出来ます。

[[yii\db\ActiveQuery::joinWith()|joinWith()]] を使うときは、カラム名の曖昧さを解決することについて、あなたが責任を負わなければなりません。上記の例では、order テーブルと item テーブルがともに id という名前のカラムを持っているため、item.id と order.id を使って、id カラムの参照の曖昧さを解決しています。

デフォルトでは、リレーションを結合すると、リレーションがイーガーロードされることにもなります。このデフォルトの動作は、指定されたリレーションをイーガーロードするかどうかを規定する $eagerLoading パラメータを渡して、変更することが出来ます。

また、デフォルトでは、[[yii\db\ActiveQuery::joinWith()|joinWith()]] は関連テーブルを結合するのに LEFT JOIN を使います。結合タイプをカスタマイズするために $joinType パラメータを渡すことが出来ます。 INNER JOIN タイプのためのショートカットとして、[[yii\db\ActiveQuery::innerJoinWith()|innerJoinWith()]] を使うことが出来ます。

下記に、いくつかの例を追加します。

// 書籍を含む注文を全て検索するが、"books" はイーガーロードしない。
$orders = Order::find()->innerJoinWith('books', false)->all();
// これも上と等価
$orders = Order::find()->joinWith('books', false, 'INNER JOIN')->all();

二つのテーブルを結合するとき、場合によっては、JOIN クエリの ON の部分で何らかの追加条件を指定する必要があります。これは、次のように、[[yii\db\ActiveQuery::onCondition()]] メソッドを呼んで実現することが出来ます。

class User extends ActiveRecord
{
    public function getBooks()
    {
        return $this->hasMany(Item::className(), ['owner_id' => 'id'])->onCondition(['category_id' => 1]);
    }
}

上記においては、[[yii\db\ActiveRecord::hasMany()|hasMany()]] メソッドが [[yii\db\ActiveQuery]] のインスタンスを返しています。そして、それに対して [[yii\db\ActiveQuery::onCondition()|onCondition()]] が呼ばれて、category_id が 1 である品目だけが返されるべきことを指定しています。

[[yii\db\ActiveQuery::joinWith()|joinWith()]] を使ってクエリを実行すると、指定された ON 条件が対応する JOIN クエリの ON の部分に挿入されます。例えば、

// SELECT user.* FROM user LEFT JOIN item ON item.owner_id=user.id AND category_id=1
// SELECT * FROM item WHERE owner_id IN (...) AND category_id=1
$users = User::find()->joinWith('books')->all();

[[yii\db\ActiveQuery::with()]] を使ってイーガーロードする場合や、レイジーロードする場合には、JOIN クエリは使われないため、ON 条件が対応する SQL 文の WHERE の部分に挿入されることに注意してください。例えば、

// SELECT * FROM user WHERE id=10
$user = User::findOne(10);
// SELECT * FROM item WHERE owner_id=10 AND category_id=1
$books = $user->books;

DBMS 間のリレーション

アクティブレコードは、異なる DBMS に属するエンティティ間、例えば、リレーショナルデータベースのテーブルと MongoDB のコレクションの間に、リレーションを確立することを可能にしています。そのようなリレーションでも、何も特別なコードは必要ありません。

// リレーショナルデータベースのアクティブレコード
class Customer extends \yii\db\ActiveRecord
{
    public static function tableName()
    {
        return 'customer';
    }

    public function getComments()
    {
        // リレーショナルデータベースに保存されている Customer は、MongoDB コレクションに保存されている複数の Comment を持つ
        return $this->hasMany(Comment::className(), ['customer_id' => 'id']);
    }
}

// MongoDb のアクティブレコード
class Comment extends \yii\mongodb\ActiveRecord
{
    public static function collectionName()
    {
        return 'comment';
    }

    public function getCustomer()
    {
        // MongoDB コレクションに保存されている Comment は、リレーショナルデータベースに保存されている一つの Customer を持つ
        return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
    }
}

アクティブレコードの全ての機能、例えば、イーガーローディングやレイジーローディング、関連付けの確立や破棄などが、DBMS 間のリレーションでも利用可能です。

Note|注意: DBMS ごとのアクティブレコードの実装には、DBMS 固有のメソッドや機能が含まれる場合があり、そういうものは DBMS 間のリレーションには適用できないということを忘れないでください。例えば、[[yii\db\ActiveQuery::joinWith()]] の使用が MongoDB コレクションに対するリレーションでは動作しないことは明白です。

スコープ

[[yii\db\ActiveRecord::find()|find()]] または [[yii\db\ActiveRecord::findBySql()|findBySql()]] を呼ぶと、[[yii\db\ActiveQuery|ActiveQuery]] のインスタンスが返されます。そして、追加のクエリメソッド、例えば、[[yii\db\ActiveQuery::where()|where()]] や [[yii\db\ActiveQuery::orderBy()|orderBy()]] を呼んで、クエリ条件をさらに指定することが出来ます。

別々の場所で同じ一連のクエリメソッドを呼びたいということがあり得ます。そのような場合には、いわゆる スコープ を定義することを検討すべきです。スコープは、本質的には、カスタムクエリクラスの中で定義されたメソッドであり、クエリオブジェクトを修正する一連のメソッドを呼ぶものです。スコープを定義しておくと、通常のクエリメソッドを呼ぶ代りに、スコープを使うことが出来るようになります。

スコープを定義するためには二つのステップが必要です。最初に、モデルのためのカスタムクエリクラスを作成して、このクラスの中に必要なスコープメソッドを定義します。例えば、Comment モデルのために CommentQuery クラスを作成して、次のように、active() というスコープメソッドを定義します。

namespace app\models;

use yii\db\ActiveQuery;

class CommentQuery extends ActiveQuery
{
    public function active($state = true)
    {
        $this->andWhere(['active' => $state]);
        return $this;
    }
}

重要な点は、以下の通りです。

クラスは yii\db\ActiveQuery (または、yii\mongodb\ActiveQuery などの、その他の ActiveQuery) を拡張したものにしなければなりません。
メソッドは public で、メソッドチェーンが出来るように $this を返さなければなりません。メソッドはパラメータを取ることが出来ます。
クエリ条件を修正する方法については、[[yii\db\ActiveQuery]] のメソッド群を参照するのが非常に役に立ちます。

次に、[[yii\db\ActiveRecord::find()]] をオーバーライドして、通常の [[yii\db\ActiveQuery|ActiveQuery]] の代りに、カスタムクエリクラスを使うようにします。上記の例のためには、次のコードを書く必要があります。

namespace app\models;

use yii\db\ActiveRecord;

class Comment extends ActiveRecord
{
    /**
     * @inheritdoc
     * @return CommentQuery
     */
    public static function find()
    {
        return new CommentQuery(get_called_class());
    }
}

以上です。これで、カスタムスコープメソッドを使用することが出来ます。

$comments = Comment::find()->active()->all();
$inactiveComments = Comment::find()->active(false)->all();

リレーションを定義するときにもスコープを使用することが出来ます。例えば、

class Post extends \yii\db\ActiveRecord
{
    public function getActiveComments()
    {
        return $this->hasMany(Comment::className(), ['post_id' => 'id'])->active();

    }
}

または、リレーショナルクエリを実行するときに、その場でスコープを使うことも出来ます。

$posts = Post::find()->with([
    'comments' => function($q) {
        $q->active();
    }
])->all();

デフォルトスコープ

あなたが Yii 1.1 を前に使ったことがあれば、デフォルトスコープ と呼ばれる概念を知っているかも知れません。デフォルトスコープは、全てのクエリに適用されるスコープです。デフォルトスコープは、[[yii\db\ActiveRecord::find()]] をオーバライドすることによって、簡単に定義することが出来ます。例えば、

public static function find()
{
    return parent::find()->where(['deleted' => false]);
}

ただし、すべてのクエリにおいて、デフォルトの条件を上書きしないために、[[yii\db\ActiveQuery::where()|where()]] を使わず、[[yii\db\ActiveQuery::andWhere()|andWhere()]] または [[yii\db\ActiveQuery::orWhere()|orWhere()]] を使うべきであることに注意してください。

67 KiB Raw Blame History