Класс yii\db\ActiveRecord

<?php

class Customer extends \yii\db\ActiveRecord
{
    public static function tableName()
    {
        return 'customer';
    }
}

$user = new User();
$user->name = 'Qiang';
$user->save();  // a new row is inserted into user table

// the following will retrieve the user 'CeBe' from the database
$user = User::find()->where(['name' => 'CeBe'])->one();

// this will get related records from orders table when relation is defined
$orders = $user->orders;

attributes() public method

Возвращает список всех имен атрибутов модели.

Реализация по умолчанию вернёт все имена столбцов таблицы, связанной с этим классом AR.

public array attributes ( )
return	array	Список имён атрибутов.

delete() public method

Удаляет строку таблицы, соответствующую этому активному записям.

Этот метод выполняет следующие шаги в указанном порядке:

1. вызывает beforeDelete(). Если метод возвращает false, он пропустит остальные шаги;
2. удаляет запись из базы данных;
3. вызывает afterDelete().

На шаге 1 и 3 события с именами EVENT_BEFORE_DELETE и EVENT_AFTER_DELETE соответственно будут вызваны соответствующими методами.

public integer|false delete ( )
return	integer|false	Число строк, удалённых, или false если удаление не удалось по какой-либо причине. Обратите внимание, что возможно число строк, удалённых, равно 0, даже если выполнение удаления прошло успешно.
throws	yii\db\StaleObjectException	если включена оптимистическая блокировка и данные, подлежащие удалению, устарели.
throws	Exception	в случае, если удаление не удалось.

deleteAll() public static method

Удаляет строки в таблице, используя предоставленные условия.

Например, чтобы удалить всех клиентов, чья статуса равно 3:

Customer::deleteAll('status = 3');

Предупреждение: Если вы не указываете никаких условий, этот метод удалит все строки в таблице.

Обратите внимание, что этот метод не будет вызывать никаких событий. Если вам нужно, чтобы EVENT_BEFORE_DELETE или EVENT_AFTER_DELETE были вызваны, вам нужно сначала найти модели, а затем вызвать delete() для каждой из них. Например, эквивалентом примера выше будет:

$models = Customer::find()->where('status = 3')->all();
foreach ($models as $model) {
    $model->delete();
}

Для большого набора моделей вы можете рассмотреть использование yii\db\ActiveQuery::each(), чтобы сохранить использование памяти в допустимых пределах.

public static integer deleteAll ( $condition = null, $params = [] )
$condition	string|array	Условие, которое будет добавлено в часть WHERE SQL-запроса DELETE. Обратитесь к yii\db\Query::where() для получения информации о способе указания этого параметра.
$params	array	Параметры (имя => значение) для привязки к запросу.
return	integer	Число строк, удалённых

deleteInternal() protected method

Удаляет ActiveRecord без учёта транзакции.

protected integer|false deleteInternal ( )
return	integer|false	Число строк, удалённых, или false если удаление не удалось по какой-либо причине. Обратите внимание, что возможно число строк, удалённых, равно 0, даже если выполнение удаления прошло успешно.
throws	yii\db\StaleObjectException

equals() public method

Возвращает значение, указывающее, является ли данная активная запись такой же, как текущая.

Сравнение выполняется путём сравнения имён таблиц и значений первичного ключа двух активных записей. Если одна из записей является новой, они также считаются неравными.

public boolean equals ( $record )
$record	yii\db\ActiveRecord	Запись для сравнения
return	boolean	Являются ли две активные записи ссылками на одну и ту же строку в одной и той же таблице базы данных.

find() public static method

Создаёт экземпляр 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();

public static yii\db\ActiveQuery find ( )
return	yii\db\ActiveQuery	Новый созданный экземпляр yii\db\ActiveQuery.

findByCondition() protected static method

Находит экземпляр(ы) ActiveRecord по заданному условию.

Этот метод вызывается внутри findOne() и findAll().

protected static yii\db\ActiveQueryInterface findByCondition ( $condition )
$condition	mixed	Обратитесь к findOne() для получения объяснения этого параметра
return	yii\db\ActiveQueryInterface	Новый созданный экземпляр ActiveQuery.
throws	yii\base\InvalidConfigException	если первичный ключ не определён

findBySql() public static method

Создаёт экземпляр yii\db\ActiveQuery с заданным SQL-запросом.

Обратите внимание, что поскольку SQL-запрос уже указан, вызов дополнительных методов модификации запроса (таких как where(), order()) на созданном экземпляре yii\db\ActiveQuery не повлияет. Однако вызов with(), asArray() или indexBy() всё ещё допустим.

Ниже приведён пример:

$customers = Customer::findBySql('SELECT * FROM customer')->all();

public static yii\db\ActiveQuery findBySql ( $sql, $params = [] )
$sql	string	SQL-запрос для выполнения
$params	array	Параметры для привязки к SQL-запросу во время выполнения.
return	yii\db\ActiveQuery	Новый созданный экземпляр yii\db\ActiveQuery

getDb() public static method

Возвращает подключение к базе данных, используемое этим классом AR.

По умолчанию используется компонент приложения "db" в качестве подключения к базе данных. Вы можете переопределить этот метод, если хотите использовать другое подключение к базе данных.

public static yii\db\Connection getDb ( )
return	yii\db\Connection	Подключение к базе данных, используемое этим классом AR.

getTableSchema() public static method

Возвращает схему информации таблицы БД, связанной с этим классом AR.

public static yii\db\TableSchema getTableSchema ( )
возврат	yii\db\TableSchema	Информация о схеме таблицы БД, связанной с этим классом AR.
бросает	yii\base\InvalidConfigException	если таблица для класса AR не существует.

insert() общедоступный метод

Вставляет строку в связанную таблицу базы данных, используя значения атрибутов этой записи.

Этот метод выполняет следующие шаги в указанном порядке:

1. вызов beforeValidate(), когда $runValidation равно true. Если beforeValidate() возвращает false, остальные шаги будут пропущены;
2. вызов afterValidate(), когда $runValidation равно true. Если валидация не пройдена, остальные шаги будут пропущены;
3. вызов beforeSave(). Если beforeSave() возвращает false, остальные шаги будут пропущены;
4. вставка записи в базу данных. Если это завершается ошибкой, остальные шаги будут пропущены;
5. вызов afterSave();

На шагах 1, 2, 3 и 5 выше события EVENT_BEFORE_VALIDATE, EVENT_AFTER_VALIDATE, EVENT_BEFORE_INSERT и EVENT_AFTER_INSERT будут сгенерированы соответствующими методами.

В базу данных будут вставлены только изменённые значения атрибутов.

Если первичный ключ таблицы имеет автоинкремент и имеет значение null во время вставки, он будет заполнен фактическим значением после вставки.

Например, чтобы вставить запись о клиенте:

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

public boolean insert ( $runValidation = true, $attributes = null )
$runValidation	boolean	Выполнять ли валидацию (вызывая validate()) перед сохранением записи. По умолчанию true. Если валидация не пройдена, запись не будет сохранена в базе данных, и этот метод вернёт false.
$attributes	array	Список атрибутов, которые необходимо сохранить. По умолчанию null, что означает сохранение всех атрибутов, загруженных из БД.
возврат	boolean	Являются ли атрибуты валидными и запись успешно вставлена.
бросает	Exception	в случае неудачной вставки.

insertInternal() защищённый метод

Вставляет активную запись в БД без учёта транзакции.

protected boolean insertInternal ( $attributes = null )
$attributes	array	Список атрибутов, которые необходимо сохранить. По умолчанию null, что означает сохранение всех атрибутов, загруженных из БД.
возврат	boolean	Успешно ли выполнена вставка записи.

isTransactional() общедоступный метод

Возвращает значение, указывающее, является ли указанная операция транзакционной в текущем $scenario.

public boolean isTransactional ( $operation )
$operation	integer	Операция для проверки. Возможные значения: OP_INSERT, OP_UPDATE и OP_DELETE.
возврат	boolean	Является ли указанная операция транзакционной в текущем $scenario.

loadDefaultValues() общедоступный метод

Загружает значения по умолчанию из схемы таблицы базы данных.

Вы можете вызвать этот метод для загрузки значений по умолчанию после создания нового экземпляра:

// class Customer extends \yii\db\ActiveRecord
$customer = new Customer();
$customer->loadDefaultValues();

public $this loadDefaultValues ( $skipIfSet = true )
$skipIfSet	boolean	Сохранять ли существующее значение. Это установит значения по умолчанию только для атрибутов, которые null.
возврат	$this	Экземпляр модели.

populateRecord() общедоступный статический метод

Заполняет объект активной записи данными из строки базы данных/хранилища.

Это внутренний метод, предназначенный для вызова для создания объектов активных записей после извлечения данных из базы данных. Он в основном используется yii\db\ActiveQuery для заполнения результатов запроса активными записями.

При ручном вызове этого метода вы должны вызвать afterFind() на созданной записи для активации события afterFind.

public static void populateRecord ( $record, $row )
$record	yii\db\BaseActiveRecord	Запись для заполнения. В большинстве случаев это будет экземпляр, созданный ранее методом instantiate().
$row	array	Значения атрибутов (имя => значение)

primaryKey() общедоступный статический метод

Возвращает имя(на) первичного ключа для этого класса AR.

Реализация по умолчанию вернёт первичный ключ(и), объявленные в таблице БД, связанной с этим классом AR.

Если таблица БД не объявляет первичный ключ, вы должны переопределить этот метод, чтобы вернуть атрибуты, которые вы хотите использовать в качестве первичных ключей для этого класса AR.

Обратите внимание, что даже для таблицы с единственным первичным ключом должен быть возвращён массив.

public static string[] primaryKey ( )
возврат	string[]	Первичные ключи связанной таблицы базы данных.

tableName() общедоступный статический метод

Объявляет имя таблицы базы данных, связанной с этим классом AR.

По умолчанию этот метод возвращает имя класса в качестве имени таблицы, вызывая yii\helpers\Inflector::camel2id() с префиксом yii\db\Connection::$tablePrefix. Например, если yii\db\Connection::$tablePrefix — tbl_, то Customer станет tbl_customer, а OrderItem станет tbl_order_item. Вы можете переопределить этот метод, если таблица имеет другое имя.

public static string tableName ( )
возврат	string	Имя таблицы

transactions() общедоступный метод

Объявляет, какие операции БД должны выполняться в транзакции в разных сценариях.

Поддерживаемые операции БД: OP_INSERT, OP_UPDATE и OP_DELETE, которые соответствуют методам insert(), update() и delete() соответственно. По умолчанию эти методы НЕ заключены в транзакцию БД.

В некоторых сценариях для обеспечения целостности данных вы можете заключить некоторые или все из них в транзакции. Вы можете сделать это, переопределив этот метод и вернув операции, которые должны быть транзакционными. Например,

return [
    'admin' => self::OP_INSERT,
    'api' => self::OP_INSERT | self::OP_UPDATE | self::OP_DELETE,
    // the above is equivalent to the following:
    // 'api' => self::OP_ALL,

];

Вышеуказанное объявление указывает, что в сценарии «admin» операция вставки (insert()) должна выполняться в транзакции; а в сценарии «api» все операции должны выполняться в транзакции.

public array transactions ( )
возврат	array	Объявления транзакционных операций. Ключи массива — имена сценариев, а значения массива — соответствующие операции транзакции.

update() общедоступный метод

Сохраняет изменения в активной записи в соответствующей таблице базы данных.

Этот метод выполняет следующие шаги в указанном порядке:

1. вызов beforeValidate(), когда $runValidation является true. Если beforeValidate() возвращает false, остальные шаги будут пропущены;
2. вызов afterValidate(), когда $runValidation является true. Если валидация не пройдена, остальные шаги будут пропущены;
3. вызов beforeSave(). Если beforeSave() возвращает false, остальные шаги будут пропущены;
4. сохранение записи в базе данных. Если это не удается, остальные шаги будут пропущены;
5. вызов afterSave();

На шагах 1, 2, 3 и 5 события EVENT_BEFORE_VALIDATE, EVENT_AFTER_VALIDATE, EVENT_BEFORE_UPDATE и EVENT_AFTER_UPDATE будут подняты соответствующими методами.

В базу данных будут сохранены только измененные значения атрибутов.

Например, для обновления записи клиента:

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

Обратите внимание, что обновление может не повлиять ни на одну строку в таблице. В этом случае этот метод вернет 0. По этой причине вы должны использовать следующий код для проверки успешности обновления():

if ($customer->update() !== false) {
    // update successful
} else {
    // update failed
}

public целое число|false update ( $runValidation = true, $attributeNames = null )
$runValidation	boolean	Выполнять ли валидацию (вызов validate()) перед сохранением записи. По умолчанию true. Если валидация не пройдена, запись не будет сохранена в базе данных, и этот метод вернет false.
$attributeNames	массив	Список атрибутов, которые необходимо сохранить. По умолчанию null, что означает, что будут сохранены все атрибуты, загруженные из БД.
return	целое число|false	Количество измененных строк или false, если валидация не пройдена или beforeSave() прервал процесс обновления.
throws	yii\db\StaleObjectException	если включена опция оптимистической блокировки и обновляемые данные устарели.
throws	Исключение	в случае неудачи обновления.

updateAll() public static method

Обновляет всю таблицу, используя предоставленные значения атрибутов и условия.

Например, чтобы изменить статус на 1 для всех клиентов, статус которых равен 2:

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

Предупреждение: Если вы не укажете никаких условий, этот метод обновит все строки в таблице.

Обратите внимание, что этот метод не будет вызывать никакие события. Если вам нужно, чтобы EVENT_BEFORE_UPDATE или EVENT_AFTER_UPDATE были вызваны, вам нужно сначала найти модели и затем вызвать update() для каждой из них. Например, эквивалентом примера выше будет:

$models = Customer::find()->where('status = 2')->all();
foreach ($models as $model) {
    $model->status = 1;
    $model->update(false); // skipping validation as no user input is involved
}

Для большого набора моделей вы можете рассмотреть использование yii\db\ActiveQuery::each() для поддержания приемлемого использования памяти.

public static целое число updateAll ( $attributes, $condition = '', $params = [] )
$attributes	массив	Значения атрибутов (имя-значение) для сохранения в таблице
$condition	строка|массив	Условия, которые будут добавлены в часть WHERE запроса UPDATE. Обратитесь к yii\db\Query::where() для указания этого параметра.
$params	массив	Параметры (имя => значение) для связывания с запросом.
return	целое число	Количество обновленных строк

updateAllCounters() public static method

Обновляет всю таблицу, используя предоставленные изменения счетчиков и условия.

Например, чтобы увеличить возраст всех клиентов на 1:

Customer::updateAllCounters(['age' => 1]);

Обратите внимание, что этот метод не будет вызывать никаких событий.

public static целое число updateAllCounters ( $counters, $condition = '', $params = [] )
$counters	массив	Счетчики для обновления (имя атрибута => значение приращения). Используйте отрицательные значения, если хотите уменьшить счетчики.
$condition	строка|массив	Условия, которые будут добавлены в часть WHERE запроса UPDATE. Обратитесь к yii\db\Query::where() для указания этого параметра.
$params	массив	Параметры (имя => значение) для связывания с запросом. Не используйте имена параметров как :bp0, :bp1, и т.д., потому что они используются внутри этого метода.
return	целое число	Количество обновленных строк