Класс yii\elasticsearch\ActiveRecord

class Customer extends \yii\elasticsearch\ActiveRecord
{
    public function attributes()
    {
        return ['id', 'name', 'address', 'registration_date'];
    }
}

public array|null getExplanation ( )

public array|null getHighlight ( )

public mixed getOldPrimaryKey ( $asArray = false )

public mixed getPrimaryKey ( $asArray = false )
public void setPrimaryKey ( $value )

public float getScore ( )

arrayAttributes() публичный метод

Список атрибутов, которые должны обрабатываться как массивы при получении через yii\elasticsearch\ActiveQuery::fields().

Если атрибуты не перечислены в этом методе, атрибуты, полученные через yii\elasticsearch\ActiveQuery::fields(), будут преобразовываться в скалярное значение, когда массив результатов содержит только одно значение.

public string[] arrayAttributes ( )
return	string[]	Список имён атрибутов. Должен быть подмножеством attributes().

attributes() публичный метод

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

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

Атрибуты — это имена полей соответствующего документа Elasticsearch. Поле primaryKey для документов Elasticsearch по умолчанию — поле _id, которое не является частью атрибутов. Вы можете определить сопоставление путей для поля _id таким образом, чтобы оно стало частью полей _source и, следовательно, стало частью атрибутов.

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

delete() публичный метод

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

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

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

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

public integer|boolean delete ( $options = [] )
$options	array	Параметры, предоставленные в этом параметре, передаются в Elasticsearch в качестве параметров запроса URI. Среди прочих: routing определяет размещение фрагментов для этой записи. parent задавая primaryKey другой записи, это определяет родительско-дочерние отношения timeout задаёт таймаут ожидания доступности фрагмента. replication тип репликации для операции удаления/индексации (синхронный или асинхронный). consistency согласованность записи при операции индексации/удаления. refresh обновляет соответствующие первичные и реплицированные фрагменты (а не весь индекс) сразу после выполнения операции, чтобы обновлённый документ отображался в результатах поиска немедленно. Для получения более подробной информации об этих параметрах, обратитесь к документации Elasticsearch. Следующие параметры относятся к Yii: optimistic_locking установите значение в true для включения оптимистической блокировки, чтобы предотвратить обновление, когда запись изменилась с момента загрузки из базы данных. Yii установит параметр version в значение, хранящееся в \yii\elasticsearch\version. Подробности см. в документации Elasticsearch. Убедитесь, что запись была получена с \yii\elasticsearch\version. Это справедливо только для записей, полученных с помощью get() и mget() по умолчанию. Для обычных запросов поле _version необходимо получить явно.
return	integer|boolean	Количество удалённых строк или false, если удаление не удалось по какой-либо причине. Обратите внимание, что количество удалённых строк может быть 0, даже если выполнение удаления прошло успешно.
throws	yii\db\StaleObjectException	если оптимистическая блокировка включена, а данные, которые необходимо удалить, устарели.
throws	yii\elasticsearch\Exception	в случае неудачи при удалении.

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

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

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

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

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

См. также [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer deleteAll ( $condition = [] )
$condition	array	Условия, которые будут переданы методу where() при построении запроса. Обратитесь к yii\elasticsearch\ActiveQuery::where() для получения информации о том, как указать этот параметр.
return	integer	Количество удалённых строк
throws	yii\elasticsearch\Exception	при ошибке.

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

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

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

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

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

Метод принимает:

• скалярное значение (целое число или строка): запрос по одному значению первичного ключа и возвращает массив, содержащий соответствующую запись (или пустой массив, если не найдено).
• массив без ассоциативных пар: запрос по списку значений первичного ключа и возвращает соответствующие записи (или пустой массив, если не найдено ни одной). Обратите внимание, что пустое условие приведёт к пустому результату, так как оно будет интерпретироваться как поиск пустых значений первичных ключей, а не как пустое WHERE условие.
• ассоциативный массив пар имя-значение: запрос по набору значений атрибутов и возвращает массив записей, соответствующих всем им (или пустой массив, если не найдено ни одной). Обратите внимание, что ['id' => 1, 2] обрабатывается как массив без ассоциативных пар.

Этот метод автоматически вызовет метод all() и вернёт массив экземпляров \yii\elasticsearch\ActiveRecordInterface.

Примечание: Так как это метод короткой записи, использование более сложных условий, таких как ['!=', '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();

public static static[] findAll ( $condition )
$condition	mixed	Значение первичного ключа или набор значений столбцов
return	static[]	Массив экземпляров ActiveRecord или пустой массив, если ничего не найдено.

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

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

Метод принимает:

• скалярное значение (целое число или строка): поиск по одному значению первичного ключа и возврат соответствующей записи (или null, если запись не найдена).
• массив без ассоциативных пар: поиск по списку значений первичного ключа и возврат первой найденной записи (или null, если запись не найдена).
• ассоциативный массив пар «имя-значение»: поиск по набору значений атрибутов и возврат единственной записи, соответствующей всем им (или null, если запись не найдена). Обратите внимание, что ['id' => 1, 2] обрабатывается как массив без ассоциативных пар.

Этот метод автоматически вызовет метод one() и вернёт экземпляр \yii\elasticsearch\ActiveRecordInterface.

Примечание: Поскольку это метод сокращённой записи, использование более сложных условий, таких как ['!=', '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();

public static findOne ( $condition )
$condition	mixed	Значение первичного ключа или набор значений столбцов
return	static	Экземпляр ActiveRecord, соответствующий условию, или null, если ничего не найдено.

get() public static method

Получает запись по её первичному ключу.

public static static|null get ( $primaryKey, $options = [] )
$primaryKey	mixed	Значение первичного ключа
$options	array	Параметры, переданные в этом параметре, передаются в elasticsearch в качестве параметров запроса URI. Более подробную информацию об этих параметрах см. в документации elasticsearch.
return	static|null	Экземпляр записи или null, если запись не найдена.

getDb() public static method

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

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

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

getExplanation() public method (доступно начиная с версии 2.0.5)

public array|null getExplanation ( )
return	array|null	Описание для каждого соответствия, как было вычислено его значение.

getHighlight() public method

public array|null getHighlight ( )
return	array|null	Список массивов с выделенными фрагментами, индексированных по именам полей.

getOldPrimaryKey() public method

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

Это значение первичного ключа, которое заполняется в запись после выполнения метода поиска (например, find(), findOne()). Значение остаётся неизменным, даже если атрибут первичного ключа вручную присваивается с другим значением.

public mixed getOldPrimaryKey ( $asArray = false )
$asArray	boolean	Определяет, возвращать ли значение первичного ключа в виде массива. Если true, возвращаемое значение будет массивом, где имя столбца является ключом, а значение столбца — значением. Если это false (по умолчанию), для несоставного первичного ключа будет возвращено скалярное значение.
return	mixed	Старое значение первичного ключа. Возвращается массив (имя столбца => значение столбца), если первичный ключ составной или $asArray равно true. В противном случае возвращается строка (null возвращается, если значение ключа null).
throws	yii\db\Exception	если у модели AR нет первичного ключа

getPrimaryKey() public method

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

public mixed getPrimaryKey ( $asArray = false )
$asArray	boolean	Определяет, возвращать ли значение первичного ключа в виде массива. Если true, возвращаемое значение будет массивом с именами столбцов в качестве ключей и значениями столбцов. Обратите внимание, что для составных первичных ключей всегда возвращается массив независимо от этого параметра.
return	mixed	Значение первичного ключа. Возвращается массив (имя столбца => значение столбца), если первичный ключ составной или $asArray равно true. В противном случае возвращается строка (null возвращается, если значение ключа null).

getScore() public method

public float getScore ( )
return	float	Возвращает значение оценки этой записи при получении через запрос find().

index() public static method

public static string index ( )
return	string	Имя индекса, в котором хранится эта запись.

insert() public method

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

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

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 будут сгенерированы соответствующими методами.

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

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

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

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

public boolean insert ( $runValidation = true, $attributes = null, $options = ['op_type' => 'create'] )
$runValidation	boolean	Выполнять ли проверку перед сохранением записи. Если проверка не пройдена, запись не будет вставлена в базу данных.
$attributes	array	Список атрибутов, которые нужно сохранить. По умолчанию null, что означает, что будут сохранены все атрибуты.
$options	array	Параметры, переданные в этом параметре, передаются в elasticsearch в качестве параметров запроса URI. Среди них: routing определяет размещение фрагмента этой записи. parent задаёт первичный ключ другой записи, определяя родительско-дочерние отношения timestamp указывает временную метку для хранения вместе с документом. По умолчанию — время индексирования. Более подробную информацию об этих параметрах см. в документации elasticsearch. По умолчанию op_type задан как create.
return	boolean	Возвращает, действительны ли атрибуты и успешно ли вставлена запись.

instantiate() public static метод

Создаёт экземпляр активной записи.

Этот метод вызывается вместе с populateRecord() методом yii\elasticsearch\ActiveQuery. Он не предназначен для прямого создания новых записей.

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

public static static instantiate ( $row )
$row	массив	Данные строки для заполнения записи. Этот массив состоит из следующих ключей: _source: относится к атрибутам записи. _type: тип, в котором хранится эта запись. _index: индекс, в котором хранится эта запись.
return	static	Новая созданная активная запись

mget() public static метод

Получает список записей по их первичным ключам.

public static массив mget ( массив $primaryKeys, $options = [] )
$primaryKeys	массив	Массив значений первичного ключа
$options	массив	Параметры, передаваемые в этот параметр, передаются в elasticsearch в качестве параметров URI запроса. Для получения более подробной информации об этих параметрах, обратитесь к документации elasticsearch.
return	массив	Экземпляры записей или пустой массив, если ничего не найдено

optimisticLock() public метод

Этот метод не оказывает влияния в Elasticsearch ActiveRecord.

Elasticsearch ActiveRecord использует родное оптимистическое блокирование. Подробнее см. update().

public void optimisticLock ( )

populateRecord() public static метод

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

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

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

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

primaryKey() public static метод

Этот метод определяет атрибут, уникально идентифицирующий запись.

Первичный ключ для документов elasticsearch по умолчанию - поле _id. Это поле не является частью атрибутов ActiveRecord, поэтому вы никогда не должны добавлять _id в список атрибутов.

Вы можете переопределить этот метод, чтобы определить имя первичного ключа, когда вы определили отображение пути для поля _id, чтобы оно стало частью _source и, следовательно, частью атрибутов.

Обратите внимание, что elasticsearch поддерживает только один атрибут в качестве первичного ключа. Однако для соответствия сигнатуре ActiveRecordInterface этот метод возвращает массив вместо одной строки.

public static строка[] primaryKey ( )
return	строка[]	Массив атрибутов первичного ключа. Будет использоваться только первый элемент массива.

primaryKeysByCondition() защищённый статический метод (доступен с версии 2.0.4)

Выполняет быстрый и высокоэффективный запрос скролла/сканирования для получения списка первичных ключей, которые удовлетворяют заданному условию. Если условие является списком первичных ключей (например: ['_id' => ['1', '2', '3']]), запрос не выполняется по соображениям производительности.

См. также:

• updateAll()
• updateAllCounters()
• deleteAll()

protected static массив primaryKeysByCondition ( $condition )
$condition	массив	Обратитесь к yii\elasticsearch\ActiveQuery::where(), чтобы узнать, как указать этот параметр
return	массив	Первичные ключи, соответствующие заданным условиям

setPrimaryKey() public метод

Устанавливает первичный ключ

public void setPrimaryKey ( $value )
$value	смешанный тип
throws	yii\base\InvalidCallException	при неновом состоянии записи

type() public static метод

public static строка type ( )
return	строка	Имя типа этой записи.

unlinkAll() public метод

Уничтожает отношение в текущей модели.

Этот метод не поддерживается elasticsearch.

public void unlinkAll ( $name, $delete = false )
$name
$delete

update() public метод

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

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

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. По этой причине вы должны использовать следующий код, чтобы проверить, успешно ли выполнено update():

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

public целое|логическое update ( $runValidation = true, $attributeNames = null, $options = [] )
$runValidation	логическое	Выполнять ли проверку перед сохранением записи. Если проверка завершится неудачно, запись не будет добавлена в базу данных.
$attributeNames	массив	Список имен атрибутов, которые нужно сохранить. По умолчанию null, что означает, что будут сохранены все атрибуты, загруженные из БД.
$options	массив	Опции, переданные в этом параметре, передаются в Elasticsearch в качестве параметров запроса URI. Среди прочего: routing определить размещение фрагментов для этой записи. parent задавая первичный ключ другой записи, это определяет родительско-дочерние отношения timeout таймаут ожидания доступности фрагмента. replication тип репликации для операции удаления/индексации (синхронный или асинхронный). consistency согласованность записи при операции индексации/удаления. refresh немедленно обновляет соответствующие первичные и реплицированные фрагменты (не весь индекс), после того как операция произойдёт, так что обновлённый документ сразу появится в результатах поиска. detect_noop этот параметр станет частью тела запроса и предотвратит обновление индекса, когда ничего не изменилось. Дополнительную информацию об этих опциях см. в документации Elasticsearch. Следующие параметры специфичны для Yii: optimistic_locking установите это в true чтобы включить оптимистическую блокировку, предотвратите обновление, если запись изменилась с момента загрузки из базы данных. Yii установит параметр version в значение, хранящееся в \yii\elasticsearch\version. Подробнее см. в документации Elasticsearch. Убедитесь, что запись была извлечена с \yii\elasticsearch\version ранее. Это выполняется только для записей, извлеченных с помощью get() и mget() по умолчанию. Для обычных запросов поле _version необходимо явно извлечь.
return	целое|логическое	Количество изменённых строк, или false, если проверка не прошла или метод beforeSave() остановил процесс обновления.
throws	yii\db\StaleObjectException	если оптимистическая блокировка включена, и обновляемые данные устарели.
throws	yii\base\InvalidParamException	если \yii\elasticsearch\version недоступен и оптимистическая блокировка включена.
throws	yii\elasticsearch\Exception	в случае неудачи обновления.

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

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

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

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

См. также [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static целое updateAll ( $attributes, $condition = [] )
$attributes	массив	Значения атрибутов (имя-значение) для сохранения в таблице
$condition	массив	Условия, которые будут переданы методу where() при построении запроса. Обратитесь к yii\elasticsearch\ActiveQuery::where() для указания этого параметра.
return	целое	Количество обновлённых строк
throws	yii\elasticsearch\Exception	при ошибке.

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

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

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

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

См. также [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

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

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

См. также update().

protected целое|false updateInternal ( $attributes = null, $options = [] )
$attributes	массив	Атрибуты для обновления
$options	массив	Опции, переданные в этом параметре, передаются в Elasticsearch в качестве параметров запроса URI. Подробнее см. update().
return	целое|false	Количество изменённых строк, или false, если beforeSave() остановил процесс обновления.
throws	yii\db\StaleObjectException	если оптимистическая блокировка включена, и обновляемые данные устарели.
throws	yii\base\InvalidParamException	если \yii\elasticsearch\version недоступен и оптимистическая блокировка включена.
throws	yii\elasticsearch\Exception	в случае неудачи обновления.