インターフェース yii\db\ActiveRecordInterface

レコードのすべての属性名のリストを返します。

データベースからレコードを削除します。

指定された条件を使用してレコードを削除します。

警告：条件を指定しない場合、このメソッドはテーブル内のすべての行を削除します。

たとえば、ステータスが3のすべての顧客を削除するには

Customer::deleteAll([status = 3]);

与えられたアクティブレコードが現在のものと同じかどうかを示す値を返します。

2つの新しいレコードは等しくないものと見なされます。

クエリの目的でyii\db\ActiveQueryInterfaceインスタンスを作成します。

返されたyii\db\ActiveQueryInterfaceインスタンスは、yii\db\ActiveQueryInterfaceで定義されているメソッドを呼び出すことで、さらにカスタマイズできます。たとえば、one()またはall()が呼び出されて、アクティブなレコードインスタンスが設定される前に。

// find the customer whose ID is 1
$customer = Customer::find()->where(['id' => 1])->one();

// find all active customers and order them by their age:
$customers = Customer::find()
    ->where(['status' => 1])
    ->orderBy('age')
    ->all();

このメソッドは、リレーショナルクエリを作成するために、yii\db\BaseActiveRecord::hasOne() および yii\db\BaseActiveRecord::hasMany() によっても呼び出されます。

このメソッドをオーバーライドして、カスタマイズされたクエリを返すことができます。たとえば、

class Customer extends ActiveRecord
{
    public static function find()
    {
        // use CustomerQuery instead of the default ActiveQuery
        return new CustomerQuery(get_called_class());
    }
}

次のコードは、すべてのクエリにデフォルトの条件を適用する方法を示しています。

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

// Use andWhere()/orWhere() to apply the default condition
// SELECT FROM customer WHERE `deleted`=:deleted AND age>30
$customers = Customer::find()->andWhere('age>30')->all();

// Use where() to ignore the default condition
// SELECT FROM customer WHERE age>30
$customers = Customer::find()->where('age>30')->all();

指定されたプライマリキーの値または一連の列の値に一致するアクティブレコードモデルのリストを返します。

このメソッドは以下を受け入れます。

• スカラー値（整数または文字列）：単一のプライマリキー値でクエリを実行し、対応するレコードを含む配列を返します（見つからない場合は空の配列）。
• 非連想配列：プライマリキー値のリストでクエリを実行し、対応するレコードを返します（見つからない場合は空の配列）。空の条件は、空の `WHERE` 条件ではなく、プライマリキーの検索として解釈されるため、空の結果になることに注意してください。
• 名前と値のペアの連想配列：属性値のセットでクエリを実行し、それらすべてに一致するレコードの配列を返します（見つからない場合は空の配列）。 `['id' => 1, 2]` は非連想配列として扱われることに注意してください。カラム名は、SQL DBMS の場合は現在のレコードテーブルのカラムに限定されるか、そうでない場合は単純なフィルタ条件に限定されるようにフィルタリングされます。
• yii\db\Expression：式は直接使用されます。（@since 2.0.37）

このメソッドは自動的に all() メソッドを呼び出し、ActiveRecord インスタンスの配列を返します。

注意：これは簡略化されたメソッドであるため、 `['!=', 'id', 1]` のようなより複雑な条件を使用することはできません。より複雑な条件を指定する必要がある場合は、find() を where() と組み合わせて使用してください。

使用例については、次のコードを参照してください。

// find the customers whose primary key value is 10
$customers = Customer::findAll(10);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => 10])->all();

// find the customers whose primary key value is 10, 11 or 12.
$customers = Customer::findAll([10, 11, 12]);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => [10, 11, 12]])->all();

// find customers whose age is 30 and whose status is 1
$customers = Customer::findAll(['age' => 30, 'status' => 1]);

// the above code is equivalent to:
$customers = Customer::find()->where(['age' => 30, 'status' => 1])->all();

このメソッドにユーザー入力を渡す必要がある場合は、入力値がスカラーであるか、配列条件の場合は、配列構造が外部から変更されないようにしてください。

// yii\web\Controller ensures that $id is scalar
public function actionView($id)
{
    $model = Post::findOne($id);
    // ...
}

// explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
$model = Post::findOne(Yii::$app->request->get('id'));

プライマリキーまたは列の値の配列で、単一のアクティブレコードモデルインスタンスを返します。

このメソッドは以下を受け入れます。

• スカラー値（整数または文字列）：単一のプライマリキー値でクエリを実行し、対応するレコードを返します（見つからない場合は null）。
• 非連想配列：プライマリキー値のリストでクエリを実行し、最初のレコードを返します（見つからない場合は null）。
• 名前と値のペアの連想配列：属性値のセットでクエリを実行し、それらすべてに一致する単一のレコードを返します（見つからない場合は null）。 `['id' => 1, 2]` は非連想配列として扱われることに注意してください。カラム名は、SQL DBMS の場合は現在のレコードテーブルのカラムに限定されるか、そうでない場合は単純なフィルタ条件に限定されるようにフィルタリングされます。
• yii\db\Expression：式は直接使用されます。（@since 2.0.37）

このメソッドは自動的に one() メソッドを呼び出し、ActiveRecord インスタンスを返すことに注意してください。

注意：これは簡略化されたメソッドであるため、 `['!=', 'id', 1]` のようなより複雑な条件を使用することはできません。より複雑な条件を指定する必要がある場合は、find() を where() と組み合わせて使用してください。

使用例については、次のコードを参照してください。

// find a single customer whose primary key value is 10
$customer = Customer::findOne(10);

// the above code is equivalent to:
$customer = Customer::find()->where(['id' => 10])->one();

// find the customers whose primary key value is 10, 11 or 12.
$customers = Customer::findOne([10, 11, 12]);

// the above code is equivalent to:
$customers = Customer::find()->where(['id' => [10, 11, 12]])->one();

// find the first customer whose age is 30 and whose status is 1
$customer = Customer::findOne(['age' => 30, 'status' => 1]);

// the above code is equivalent to:
$customer = Customer::find()->where(['age' => 30, 'status' => 1])->one();

このメソッドにユーザー入力を渡す必要がある場合は、入力値がスカラーであるか、配列条件の場合は、配列構造が外部から変更されないようにしてください。

// yii\web\Controller ensures that $id is scalar
public function actionView($id)
{
    $model = Post::findOne($id);
    // ...
}

// explicitly specifying the colum to search, passing a scalar or array here will always result in finding a single record
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// do NOT use the following code! it is possible to inject an array condition to filter by arbitrary column values!
$model = Post::findOne(Yii::$app->request->get('id'));

指定された属性値を返します。

このレコードがクエリの結果であり、属性がロードされていない場合は、null が返されます。

hasAttribute() も参照してください。

このARクラスで使用される接続を返します。

現在のレコードが新しい（データベースに保存されていない）かどうかを示す値を返します。

古いプライマリキーの値を返します。

これは、find メソッド（例：find()、findOne()）を実行した後にレコードに設定されるプライマリキー値を指します。プライマリキー属性に異なる値を手動で割り当てても、値は変更されません。

プライマリキーの値を返します。

指定された名前のリレーションオブジェクトを返します。

リレーションは、yii\db\ActiveQueryInterface を実装するオブジェクト（通常はリレーショナル yii\db\ActiveQuery オブジェクト）を返す getter メソッドによって定義されます。これは、ActiveRecord クラス自体またはそのビヘイビアのいずれかで宣言できます。

レコードに指定された名前の属性があるかどうかを示す値を返します。

このレコードの属性値を使用して、レコードをデータベースに挿入します。

使用例

$customer = new Customer;
$customer->name = $name;
$customer->email = $email;
$customer->insert();

指定された属性のセットがこのモデルのプライマリキーを表しているかどうかを示す値を返します。

2つのレコード間の関係を確立します。

リレーションシップは、あるレコードの外部キーの値を、別のレコードの対応する主キーの値に設定することによって確立されます。外部キーを持つレコードは、バリデーションを実行せずにデータベースに保存されます。

リレーションシップがジャンクションテーブルを伴う場合、両方のレコードからの主キーの値を含む新しい行がジャンクションテーブルに挿入されます。

このメソッドでは、主キーの値が null でないことが必要です。

関連レコードで指定された名前のリレーションを設定します。

このメソッドは、リレーションが存在するかどうかをチェックしないことに注意してください。

このARクラスのプライマリキー名を返します。

レコードに主キーが1つしかない場合でも、配列が返される必要があることに注意してください。

主キーの値については、代わりに getPrimaryKey() を参照してください。

現在のレコードを保存します。

このメソッドは、isNewRecord が true の場合は insert() を呼び出し、isNewRecord が false の場合は update() を呼び出します。

例えば、顧客レコードを保存するには

$customer = new Customer; // or $customer = Customer::findOne($id);
$customer->name = $name;
$customer->email = $email;
$customer->save();

指定された属性値を設定します。

hasAttribute() も参照してください。

2つのレコード間の関係を破棄します。

$delete が true の場合、リレーションシップの外部キーを持つレコードは削除されます。それ以外の場合、外部キーは null に設定され、レコードはバリデーションなしで保存されます。

このアクティブレコードへの変更をデータベースに保存します。

使用例

$customer = Customer::findOne($id);
$customer->name = $name;
$customer->email = $email;
$customer->update();

指定された属性値と条件を使用してレコードを更新します。

例えば、ステータスが2のすべての顧客のステータスを1に変更する場合。

Customer::updateAll(['status' => 1], ['status' => '2']);