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() public method

A list of attributes that should be treated as array valued when retrieved through yii\elasticsearch\ActiveQuery::fields().

If not listed by this method, attributes retrieved through yii\elasticsearch\ActiveQuery::fields() will converted to a scalar value when the result array contains only one value.

public string[] arrayAttributes ( )
return	string[]	List of attribute names. Must be a subset of attributes().

attributes() public method

Returns the list of all attribute names of the model.

This method must be overridden by child classes to define available attributes.

Attributes are names of fields of the corresponding elasticsearch document. The primaryKey for elasticsearch documents is the _id field by default which is not part of the attributes. You may define path mapping for the _id field so that it is part of the _source fields and thus becomes part of the attributes.

public string[] attributes ( )
return	string[]	List of attribute names.
throws	yii\base\InvalidConfigException	if not overridden in a child class.

delete() public method

Deletes the table row corresponding to this active record.

This method performs the following steps in order:

1. call beforeDelete(). If the method returns false, it will skip the rest of the steps;
2. delete the record from the database;
3. call afterDelete().

In the above step 1 and 3, events named EVENT_BEFORE_DELETE and EVENT_AFTER_DELETE will be raised by the corresponding methods.

public integer|boolean delete ( $options = [] )
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. These are among others: routing define shard placement of this record. parent by giving the primaryKey of another record this defines a parent-child relation timeout timeout waiting for a shard to become available. replication the replication type for the delete/index operation (sync or async). consistency the write consistency of the index/delete operation. refresh refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. Please refer to the elasticsearch documentation for more details on these options. The following parameters are Yii specific: optimistic_locking set this to true to enable optimistic locking, avoid updating when the record has changed since it has been loaded from the database. Yii will set the version parameter to the value stored in \yii\elasticsearch\version. See the elasticsearch documentation for details. Make sure the record has been fetched with a \yii\elasticsearch\version before. This is only the case for records fetched via get() and mget() by default. For normal queries, the _version field has to be fetched explicitly.
return	integer|boolean	The number of rows deleted, or false if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being deleted is outdated.
throws	yii\elasticsearch\Exception	in case delete failed.

deleteAll() public static method

Deletes rows in the table using the provided conditions.

WARNING: If you do not specify any condition, this method will delete ALL rows in the table.

For example, to delete all customers whose status is 3:

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

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer deleteAll ( $condition = [] )
$condition	array	The conditions that will be passed to the where() method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return	integer	The number of rows deleted
throws	yii\elasticsearch\Exception	on error.

find() public static method

Creates an \yii\elasticsearch\ActiveQueryInterface instance for query purpose.

The returned \yii\elasticsearch\ActiveQueryInterface instance can be further customized by calling methods defined in \yii\elasticsearch\ActiveQueryInterface before one() or all() is called to return populated ActiveRecord instances. For example,

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

This method is also called by yii\db\BaseActiveRecord::hasOne() and yii\db\BaseActiveRecord::hasMany() to create a relational query.

You may override this method to return a customized query. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        // use CustomerQuery instead of the default ActiveQuery
        return new CustomerQuery(get_called_class());
    }
}

The following code shows how to apply a default condition for all queries:

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	The newly created yii\elasticsearch\ActiveQuery instance.

findAll() public static method

Returns a list of active record models that match the specified primary key value(s) or a set of column values.

The method accepts:

• a scalar value (integer or string): query by a single primary key value and return an array containing the corresponding record (or an empty array if not found).
• a non-associative array: query by a list of primary key values and return the corresponding records (or an empty array if none was found). Note that an empty condition will result in an empty result as it will be interpreted as a search for primary keys and not an empty WHERE condition.
• an associative array of name-value pairs: query by a set of attribute values and return an array of records matching all of them (or an empty array if none was found). Note that ['id' => 1, 2] is treated as a non-associative array.

This method will automatically call the all() method and return an array of \yii\elasticsearch\ActiveRecordInterface instances.

Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

// 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	Primary key value or a set of column values
return	static[]	An array of ActiveRecord instances, or an empty array if nothing matches.

findOne() public static method

Returns a single active record model instance by a primary key or an array of column values.

The method accepts:

• a scalar value (integer or string): query by a single primary key value and return the corresponding record (or null if not found).
• a non-associative array: query by a list of primary key values and return the first record (or null if not found).
• an associative array of name-value pairs: query by a set of attribute values and return a single record matching all of them (or null if not found). Note that ['id' => 1, 2] is treated as a non-associative array.

That this method will automatically call the one() method and return an \yii\elasticsearch\ActiveRecordInterface instance.

Note: As this is a short-hand method only, using more complex conditions, like ['!=', 'id', 1] will not work. If you need to specify more complex conditions, use find() in combination with where() instead.

See the following code for usage examples:

// 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 static findOne ( $condition )
$condition	mixed	Primary key value or a set of column values
return	static	ActiveRecord instance matching the condition, or null if nothing matches.

get() public static method

Gets a record by its primary key.

public static static|null get ( $primaryKey, $options = [] )
$primaryKey	mixed	The primaryKey value
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. Please refer to the elasticsearch documentation for more details on these options.
return	static|null	The record instance or null if it was not found.

getDb() public static method

Returns the database connection used by this AR class.

By default, the "elasticsearch" application component is used as the database connection. You may override this method if you want to use a different database connection.

public static yii\elasticsearch\Connection getDb ( )
return	yii\elasticsearch\Connection	The database connection used by this AR class.

getExplanation() public method (available since version 2.0.5)

public array|null getExplanation ( )
return	array|null	An explanation for each hit on how its score was computed.

getHighlight() public method

public array|null getHighlight ( )
return	array|null	A list of arrays with highlighted excerpts indexed by field names.

getOldPrimaryKey() public method

Returns the old primary key value(s).

This refers to the primary key value that is populated into the record after executing a find method (e.g. find(), findOne()). The value remains unchanged even if the primary key attribute is manually assigned with a different value.

public mixed getOldPrimaryKey ( $asArray = false )
$asArray	boolean	Whether to return the primary key value as an array. If true, the return value will be an array with column name as key and column value as value. If this is false (default), a scalar value will be returned for non-composite primary key.
return	mixed	The old primary key value. An array (column name => column value) is returned if the primary key is composite or $asArray is true. A string is returned otherwise (null will be returned if the key value is null).
throws	yii\db\Exception	if the AR model does not have a primary key

getPrimaryKey() public method

Returns the primary key value(s).

public mixed getPrimaryKey ( $asArray = false )
$asArray	boolean	Whether to return the primary key value as an array. If true, the return value will be an array with column names as keys and column values as values. Note that for composite primary keys, an array will always be returned regardless of this parameter value.
return	mixed	The primary key value. An array (column name => column value) is returned if the primary key is composite or $asArray is true. A string is returned otherwise (null will be returned if the key value is null).

getScore() public method

public float getScore ( )
return	float	Returns the score of this record when it was retrieved via a find() query.

index() public static method

public static string index ( )
return	string	The name of the index this record is stored in.

insert() public method

Inserts a document into the associated index using the attribute values of this record.

This method performs the following steps in order:

1. call beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
2. call afterValidate() when $runValidation is true.
3. call beforeSave(). If the method returns false, it will skip the rest of the steps;
4. insert the record into database. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_BEFORE_INSERT, EVENT_AFTER_INSERT and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the changed attribute values will be inserted into database.

If the primary key is not set (null) during insertion, it will be populated with a randomly generated value after insertion.

For example, to insert a customer record:

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

public boolean insert ( $runValidation = true, $attributes = null, $options = ['op_type' => 'create'] )
$runValidation	boolean	Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the database.
$attributes	array	List of attributes that need to be saved. Defaults to null, meaning all attributes will be saved.
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. These are among others: routing define shard placement of this record. parent by giving the primaryKey of another record this defines a parent-child relation timestamp specifies the timestamp to store along with the document. Default is indexing time. Please refer to the elasticsearch documentation for more details on these options. By default the op_type is set to create.
return	boolean	Whether the attributes are valid and the record is inserted successfully.

instantiate() public static method

Creates an active record instance.

This method is called together with populateRecord() by yii\elasticsearch\ActiveQuery. It is not meant to be used for creating new records directly.

You may override this method if the instance being created depends on the row data to be populated into the record. For example, by creating a record based on the value of a column, you may implement the so-called single-table inheritance mapping.

public static static instantiate ( $row )
$row	array	Row data to be populated into the record. This array consists of the following keys: _source: refers to the attributes of the record. _type: the type this record is stored in. _index: the index this record is stored in.
return	static	The newly created active record

mget() public static method

Gets a list of records by its primary keys.

public static array mget ( array $primaryKeys, $options = [] )
$primaryKeys	array	An array of primaryKey values
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. Please refer to the elasticsearch documentation for more details on these options.
return	array	The record instances, or empty array if nothing was found

optimisticLock() public method

This method has no effect in Elasticsearch ActiveRecord.

Elasticsearch ActiveRecord uses native Optimistic locking. See update() for more details.

public void optimisticLock ( )

populateRecord() public static method

Populates an active record object using a row of data from the database/storage.

This is an internal method meant to be called to create active record objects after fetching data from the database. It is mainly used by yii\elasticsearch\ActiveQuery to populate the query results into active records.

When calling this method manually you should call afterFind() on the created record to trigger the afterFind Event.

public static void populateRecord ( $record, $row )
$record	yii\elasticsearch\ActiveRecord	The record to be populated. In most cases this will be an instance created by instantiate() beforehand.
$row	array	Attribute values (name => value)

primaryKey() public static method

This method defines the attribute that uniquely identifies a record.

The primaryKey for elasticsearch documents is the _id field by default. This field is not part of the ActiveRecord attributes so you should never add _id to the list of attributes.

You may override this method to define the primary key name when you have defined path mapping for the _id field so that it is part of the _source and thus part of the attributes.

Note that elasticsearch only supports one attribute to be the primary key. However to match the signature of the ActiveRecordInterface this methods returns an array instead of a single string.

public static string[] primaryKey ( )
return	string[]	Array of primary key attributes. Only the first element of the array will be used.

primaryKeysByCondition() protected static method (available since version 2.0.4)

Performs a quick and highly efficient scroll/scan query to get the list of primary keys that satisfy the given condition. If condition is a list of primary keys (e.g.: ['_id' => ['1', '2', '3']]), the query is not performed for performance considerations.

See also:

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

protected static array primaryKeysByCondition ( $condition )
$condition	array	Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter
return	array	Primary keys that correspond to given conditions

setPrimaryKey() public method

Sets the primary key

public void setPrimaryKey ( $value )
$value	mixed
throws	yii\base\InvalidCallException	when record is not new

type() public static method

public static string type ( )
return	string	The name of the type of this record.

unlinkAll() public method

Destroys the relationship in current model.

This method is not supported by elasticsearch.

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

update() public method

Saves the changes to this active record into the associated database table.

This method performs the following steps in order:

1. call beforeValidate() when $runValidation is true. If beforeValidate() returns false, the rest of the steps will be skipped;
2. call afterValidate() when $runValidation is true. If validation failed, the rest of the steps will be skipped;
3. call beforeSave(). If beforeSave() returns false, the rest of the steps will be skipped;
4. save the record into database. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_AFTER_VALIDATE, EVENT_BEFORE_UPDATE, and EVENT_AFTER_UPDATE will be raised by the corresponding methods.

Only the changed attribute values will be saved into database.

For example, to update a customer record:

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

Note that it is possible the update does not affect any row in the table. In this case, this method will return 0. For this reason, you should use the following code to check if update() is successful or not:

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

public integer|boolean update ( $runValidation = true, $attributeNames = null, $options = [] )
$runValidation	boolean	Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the database.
$attributeNames	array	List of attribute names that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. These are among others: routing define shard placement of this record. parent by giving the primaryKey of another record this defines a parent-child relation timeout timeout waiting for a shard to become available. replication the replication type for the delete/index operation (sync or async). consistency the write consistency of the index/delete operation. refresh refresh the relevant primary and replica shards (not the whole index) immediately after the operation occurs, so that the updated document appears in search results immediately. detect_noop this parameter will become part of the request body and will prevent the index from getting updated when nothing has changed. Please refer to the elasticsearch documentation for more details on these options. The following parameters are Yii specific: optimistic_locking set this to true to enable optimistic locking, avoid updating when the record has changed since it has been loaded from the database. Yii will set the version parameter to the value stored in \yii\elasticsearch\version. See the elasticsearch documentation for details. Make sure the record has been fetched with a \yii\elasticsearch\version before. This is only the case for records fetched via get() and mget() by default. For normal queries, the _version field has to be fetched explicitly.
return	integer|boolean	The number of rows affected, or false if validation fails or beforeSave() stops the updating process.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being updated is outdated.
throws	yii\base\InvalidParamException	if no \yii\elasticsearch\version is available and optimistic locking is enabled.
throws	yii\elasticsearch\Exception	in case update failed.

updateAll() public static method

Updates all records whos primary keys are given.

For example, to change the status to be 1 for all customers whose status is 2:

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

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer updateAll ( $attributes, $condition = [] )
$attributes	array	Attribute values (name-value pairs) to be saved into the table
$condition	array	The conditions that will be passed to the where() method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return	integer	The number of rows updated
throws	yii\elasticsearch\Exception	on error.

updateAllCounters() public static method

Updates all matching records using the provided counter changes and conditions.

For example, to add 1 to age of all customers whose status is 2,

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

See also [[yii\elasticsearch\ActiveRecord::primaryKeysByCondition()]].

public static integer updateAllCounters ( $counters, $condition = [] )
$counters	array	The counters to be updated (attribute name => increment value). Use negative values if you want to decrement the counters.
$condition	array	The conditions that will be passed to the where() method when building the query. Please refer to yii\elasticsearch\ActiveQuery::where() on how to specify this parameter.
return	integer	The number of rows updated
throws	yii\elasticsearch\Exception	on error.

updateInternal() protected method

See also update().

protected integer|false updateInternal ( $attributes = null, $options = [] )
$attributes	array	Attributes to update
$options	array	Options given in this parameter are passed to elasticsearch as request URI parameters. See update() for details.
return	integer|false	The number of rows affected, or false if beforeSave() stops the updating process.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being updated is outdated.
throws	yii\base\InvalidParamException	if no \yii\elasticsearch\version is available and optimistic locking is enabled.
throws	yii\elasticsearch\Exception	in case update failed.