接口 yii\db\ActiveRecordInterface

返回记录的所有属性名称列表。

从数据库中删除记录。

使用提供的条件删除记录。

警告：如果您未指定任何条件，则此方法将删除表中的所有行。

例如，要删除所有状态为3的客户

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

返回一个值，指示给定的活动记录是否与当前记录相同。

两条新记录被认为是不相等的。

为查询目的创建一个 yii\db\ActiveQueryInterface 实例。

返回的 yii\db\ActiveQueryInterface 实例可以通过调用 yii\db\ActiveQueryInterface 中定义的方法进一步自定义，然后才能调用one() 或all() 返回填充的ActiveRecord实例。例如，

// 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();

返回与指定的primaryKey值或一组列值匹配的活动记录模型列表。

此方法接受

• 标量值（整数或字符串）：按单个主键值查询并返回包含相应记录的数组（如果未找到则返回空数组）。
• 非关联数组：按主键值列表查询并返回相应的记录（如果未找到则返回空数组）。请注意，空条件将导致空结果，因为它将被解释为对主键的搜索，而不是空的 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] 被视为非关联数组。列名仅限于当前记录表的列，或者以其他方式进行过滤以限制为简单的过滤条件。
• 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()、findOne()）后填充到记录中的主键值。即使手动为主键属性分配了不同的值，该值也不会改变。

返回主键值。

返回具有指定名称的关系对象。

关系由一个 getter 方法定义，该方法返回一个实现 yii\db\ActiveQueryInterface 的对象（通常这将是一个关系 yii\db\ActiveQuery 对象）。它可以在 ActiveRecord 类本身或其某个行为中声明。

返回一个值，指示记录是否具有指定名称的属性。

使用此记录的属性值将记录插入数据库。

使用示例

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

返回一个值，指示给定的属性集是否代表此模型的主键。

建立两条记录之间的关系。

此关系是通过将一条记录中的外键值设置为另一条记录中相应的主键值来建立的。具有外键的记录将保存到数据库中，而无需执行验证。

如果关系涉及联接表，则将在联接表中插入一个新行，其中包含两条记录的主键值。

此方法要求主键值不为 null。

使用相关记录填充命名关系。

请注意，此方法不检查关系是否存在。

返回此AR类的主键**名称**。

请注意，即使记录只有一个主键，也应该返回一个数组。

有关主键**值**，请改用 getPrimaryKey()。

保存当前记录。

当 isNewRecord 为 true 时，此方法将调用 insert()，或当 isNewRecord 为 false 时调用 update()。

例如，要保存客户记录

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

设置命名的属性值。

另请参阅 hasAttribute()。

销毁两条记录之间的关系。

如果 $delete 为 true，则将删除具有关系外键的记录。否则，外键将设置为 null，并且记录将保存而无需验证。

将更改保存到此活动记录到数据库中。

使用示例

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

使用提供的属性值和条件更新记录。

例如，将所有状态为 2 的客户的状态更改为 1

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