$filter public property The filter part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL. public array|string $filter = null

$fields public property The fields being retrieved from the documents. For example, ['id', 'name']. If not set, this option will not be applied to the query and no fields will be returned. In this case the _source field will be returned by default which can be configured using source(). Setting this to an empty array will result in no fields being retrieved, which means that only the primaryKey of a record will be available in the result. For each field you may also add an array representin

$aggregations public property List of aggregations to add to this query. See also http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-aggregations.html. public array $aggregations = []

getName() public method public string getName ( )return string The user-friendly name of this exception

prepareMessage() public method Prepares a log message. public string prepareMessage ( $message )$message array The log message to be formatted.

init() public method This method will initialize the \yii\elasticsearch\elasticsearch property to make sure it refers to a valid Elasticsearch connection. public void init ( )throws yii\base\InvalidConfigException if \yii\elasticsearch\elasticsearch is invalid.

getContextMessage() protected method If $includeContext property is false, returns context message normally. If $includeContext is true, returns an empty string (so that context message in collect() is not generated), expecting that context will be appended to every message in prepareMessage(). protected array getContextMessage ( )return array The context information

export() public method Exports log $messages to a specific destination. Child classes must implement this method. public void export ( )

collect() public method Processes the given log messages. This method will filter the given messages with $levels and $categories. And if requested, it will also export the filtering result to specific medium (e.g. email). Depending on the $includeContext attribute, a context message will be either created or ignored. public void collect ( $messages, $final )$messages array Log messages to be processed. See yii\log\Logger::$messages for the structure of each message. $final boolean Whe

$_contextMessage protected property Context message cache (can be used multiple times if context is appended to every message) protected string $_contextMessage = null