Абстрактный класс yii\mongodb\ActiveRecord

attributes() public method

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

Этот метод должен быть переопределен дочерними классами для определения доступных атрибутов. Примечание: атрибут первичного ключа "_id" должен всегда присутствовать в возвращаемом массиве. Например:

public function attributes()
{
    return ['_id', 'name', 'address', 'status'];
}

public array attributes ( )
return	array	Список имён атрибутов.
throws	yii\base\InvalidConfigException	если метод не реализован

collectionName() public static method

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

Имя коллекции может быть строкой или массивом:

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

По умолчанию этот метод возвращает имя класса как имя коллекции, вызывая yii\helpers\Inflector::camel2id(). Например, 'Customer' становится 'customer', а 'OrderItem' становится 'order_item'. Вы можете переопределить этот метод, если коллекция не имеет такого имени.

public static string|array collectionName ( )
return	string|array	Имя коллекции

delete() public method

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

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

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

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

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

deleteAll() public static method

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

ПРЕДУПРЕЖДЕНИЕ: Если вы не зададите никаких условий, этот метод удалит все строки в коллекции.

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

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

public static integer deleteAll ( $condition = [], $options = [] )
$condition	array	Описание объектов для удаления. Обратитесь к yii\mongodb\Query::where() для получения информации о том, как задать этот параметр.
$options	array	Список параметров в формате: имяПараметра => значениеПараметра.
return	integer	Число удалённых документов.

deleteInternal() protected method

См. также yii\mongodb\ActiveRecord::delete().

protected void deleteInternal ( )
throws	yii\db\StaleObjectException

equals() public method

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

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

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

find() public static method

Создаёт экземпляр \yii\mongodb\ActiveQueryInterface для целей запроса.

Возвращаемый экземпляр \yii\mongodb\ActiveQueryInterface можно далее настраивать, вызывая методы, определённые в \yii\mongodb\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\mongodb\ActiveQuery find ( )
return	yii\mongodb\ActiveQuery	Экземпляр yii\mongodb\ActiveQuery, который был только что создан.

getCollection() public static method

Возвращает экземпляр Mongo коллекции для этого класса AR.

public static yii\mongodb\Collection getCollection ( )
return	yii\mongodb\Collection	Экземпляр коллекции.

getDb() public static method

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

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

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

insert() public method

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

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

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

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

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

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

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

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

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

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

См. также yii\mongodb\ActiveRecord::insert().

protected void insertInternal ( $attributes = null )
$attributes

primaryKey() public static метод

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

Реализация по умолчанию вернёт ['_id'].

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

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

toArray() public метод

Преобразует модель в массив.

Этот метод сначала определит, какие поля должны быть включены в результирующий массив, вызвав resolveFields(). Затем он преобразует модель в массив с этими полями. Если $recursive равно true, любые вложенные объекты также будут преобразованы в массивы.

Если модель реализует интерфейс \yii\mongodb\Linkable, результирующий массив также будет содержать элемент _link, который ссылается на список ссылок, как указано в интерфейсе.

public array toArray ( array $fields = [], array $expand = [], $recursive = true )
$fields	array	Запрашиваемые поля. Если пусто, будут возвращены все поля, как указано в fields().
$expand	array	Дополнительные запрашиваемые поля для экспорта. Будут рассмотрены только поля, объявленные в extraFields().
$recursive	boolean	Выполнять ли рекурсивное возвращение массива представлений вложенных объектов.
return	array	Массивовое представление объекта

updateAll() public static метод

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

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

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

public static integer updateAll ( $attributes, $condition = [], $options = [] )
$attributes	array	Значения атрибутов (имя-значение) для сохранения в коллекции
$condition	array	Описание объектов для обновления. Обратитесь к yii\mongodb\Query::where() для получения информации о способе указания этого параметра.
$options	array	Список опций в формате: имяОпции => значениеОпции.
return	integer	Количество обновлённых документов.

updateAllCounters() public static метод

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

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

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

public static integer updateAllCounters ( $counters, $condition = [], $options = [] )
$counters	array	Обновляемые счётчики (имя атрибута => приращение значения). Используйте отрицательные значения, если хотите уменьшить счётчики.
$condition	array	Описание объектов для обновления. Обратитесь к yii\mongodb\Query::where() для получения информации о способе указания этого параметра.
$options	array	Список опций в формате: имяОпции => значениеОпции.
return	integer	Количество обновлённых документов.

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

См. также yii\mongodb\ActiveRecord::update().

protected void updateInternal ( $attributes = null )
$attributes
throws	yii\db\StaleObjectException