Interface yii\db\ActiveRecordInterface

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

从数据库删除记录。

使用提供的条件删除记录。 WARNING：如果未指定任何条件，则此方法将删除表中的所有行。

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

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

返回一个表示给定的记录是否与当前记录相同的值。 两个 new 记录被认为是不相等的。

创建用来查询的 yii\db\ActiveQueryInterface 实例。

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

// 找到 ID 为 1 的客户
$customer = Customer::find()->where(['id' => 1])->one();

// 查找所有活跃客户并按其年龄排序
$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]);
    }
}

// 使用 andWhere()/orWhere() 应用默认条件
// SELECT FROM customer WHERE `deleted`=:deleted AND age>30
$customers = Customer::find()->andWhere('age>30')->all();

// 使用 where() 忽略默认条件
// SELECT FROM customer WHERE age>30
$customers = Customer::find()->where('age>30')->all();

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

The method accepts:

• 标量值（integer 或 string）：通过单个主键值进行查询并返回包含相应记录的数组 （如果未找到则返回空数组）。
• 非关联数组：按主键值列表查询并返回相应记录 （如果没有找到则返回空数组）。 注意，空条件将导致空结果， 因为它将被解释为搜索结果主键而不是空的 WHERE 条件。
• 一个键值对关联数组：通过一组属性值进行查询， 并返回所有属性值匹配的记录数组（如果没有找到则返回空数组） 请注意，['id' => 1, 2] 被视为非关联数组。 列名仅限于 SQL DBMS 的当前记录表列，否则将过滤以限制为简单的过滤条件。

此方法将自动调用 all() 方法并返回 ActiveRecord 实例的数组。

Note：因为只是一种简单的方法，所以使用更复杂的条件，比如 ['!=', 'id', 1] 将不起作用。 如果需要指定更复杂的条件，请将 find() 与 where() 组合使用。

有关于用法示例，请参阅以下代码：

// 找到主键值为 10 的客户
$customers = Customer::findAll(10);

// 上面的代码相当于：
$customers = Customer::find()->where(['id' => 10])->all();

// 找到主键值为 10，11 或 12 的客户。
$customers = Customer::findAll([10, 11, 12]);

// 上面的代码相当于：
$customers = Customer::find()->where(['id' => [10, 11, 12]])->all();

// 找到年龄为 30 岁且状态为 1 的客户
$customers = Customer::findAll(['age' => 30, 'status' => 1]);

// 上面的代码相当于：
$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);
    // ...
}

// 显式指定要搜索的列，在此处传递标量或数组将始终导致查找单个记录
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// 不要使用以下代码！可以通过任意列值注入数组条件来过滤！
$model = Post::findOne(Yii::$app->request->get('id'));

通过主键或列值数组返回单个活动记录模型实例。

该方法接受：

• 标量值（integer 或 string）：按单个主键值查询并返回记录 （如果未找到就返回 null）。
• 一个非关联数组：按主键值列表查询并返回第一条记录 （如果未找到就返回 null）。
• 一个键值对：通过一组属性值进行查询，并返回匹配所有属性值的单个记录（如果未找到就返回 null）。 注意，['id' => 1, 2] 被视为非关联数组。 列名仅限于 SQL DBMS 的当前记录列表，或者过滤为限制为简单的过滤条件。

该方法将自动调用 one() 方法并且返回 ActiveRecord 实例。

Note: 因为只是一种简单的方法，所以使用更复杂的条件，比如 ['!=', 'id', 1] 将不起作用。 如果需要指定更复杂的条件，请将 find() 与 where() 组合使用。

有关用法的示例，请参阅以下代码：

// 找到主键值为 10 的单个客户
$customer = Customer::findOne(10);

// 上面的代码相当于：
$customer = Customer::find()->where(['id' => 10])->one();

// 找到主键值为 10，11 或 12 的客户。
$customers = Customer::findOne([10, 11, 12]);

// 上面的代码相当于：
$customers = Customer::find()->where(['id' => [10, 11, 12]])->one();

// 找到第一个年龄为 30 岁且状态为 1 的客户
$customer = Customer::findOne(['age' => 30, 'status' => 1]);

// 上面的代码相当于：
$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);
    // ...
}

// 显示指定要搜索的列，在此处传递标量或数组将始终导致查询单个记录
$model = Post::findOne(['id' => Yii::$app->request->get('id')]);

// 不要使用以下代码！可以通过任意列值注入数组条件来过滤！
$model = Post::findOne(Yii::$app->request->get('id'));

返回指定的属性值。 如果此记录是查询的结果并且未加载该属性， 将会返回 null。

参见 hasAttribute().

返回此 AR 类使用的连接。

返回一个表示当前记录是否为新纪录的值（未保存在数据库中）。

返回旧的主键值。 这是指在执行 find 方法， （例如 find()，findOne()）后填充到记录中的主键值。 即使主键属性是手动指定的不同的值，该值仍然保持不变。

返回主键的值。

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

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

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

用法示例：

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

返回一个表明给定的属性集是否是该模型的主键的值。

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

通过将一个记录中的外键值设置为另外一个记录中相应的主键值， 从而建立该关系。 具有外键的记录将被保存到数据库中而不进行验证。

如果这个关系涉及到一个连接表， 那么一个新的行将被插入到包含来自两个记录的主键值的连接表中。

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

使用相关记录填充命名关系。 注意，此方法不会检查关系是否存在。

返回此 AR 类的主键 name(s)。

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

对于主键 value 请参阅 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 为真，则删除具有关系外键的记录。 否则，外键将被设置为 null，并且将保存记录而不进行验证。

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

用法示例：

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

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

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

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