介面 yii\db\ActiveRecordInterface

傳回記錄中所有屬性名稱的清單。

從資料庫刪除記錄。

使用提供的條件刪除記錄。

警告：如果您未指定任何條件，此方法將刪除表格中的所有列。

例如，刪除所有狀態為 3 的客戶

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

傳回一個值，指示給定的 active record 是否與目前的 active record 相同。

兩個 new 記錄被認為不相等。

建立一個 yii\db\ActiveQueryInterface 實例，用於查詢目的。

傳回的 yii\db\ActiveQueryInterface 實例可以通過在呼叫 one() 或 all() 以傳回填充的 ActiveRecord 實例之前，呼叫 yii\db\ActiveQueryInterface 中定義的方法來進一步自訂。 例如，

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

傳回符合指定主鍵值或一組欄位值的 active record 模型清單。

此方法接受

• 純量值（整數或字串）：依單一主鍵值查詢，並傳回包含對應記錄的陣列（如果找不到則傳回空陣列）。
• 非關聯陣列：依主鍵值清單查詢，並傳回對應的記錄（如果找不到則傳回空陣列）。 請注意，空條件將導致空結果，因為它將被解釋為搜尋主鍵，而不是空的 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'));

透過主鍵或欄位值陣列，傳回單一 active record 模型實例。

此方法接受

• 純量值（整數或字串）：依單一主鍵值查詢，並傳回對應的記錄（如果找不到則傳回 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()）後填入記錄的主鍵值。 即使主鍵屬性是以不同的值手動指派，此值仍保持不變。

傳回主鍵值。

傳回具有指定名稱的關聯物件。

關聯是由 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，且記錄將在未驗證的情況下儲存。

將此 active record 的變更儲存到資料庫。

使用範例

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

使用提供的屬性值和條件更新記錄。

例如，將所有狀態為 2 的客戶的狀態變更為 1

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