Class yii\mongodb\Query
Inheritance | yii\mongodb\Query » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable, yii\db\QueryInterface |
Uses Traits | yii\db\QueryTrait |
Subclasses | yii\mongodb\ActiveQuery, yii\mongodb\file\ActiveQuery, yii\mongodb\file\Query |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-mongodb/blob/master/Query.php |
Query represents Mongo "find" operation.
Query provides a set of methods to facilitate the specification of "find" command. These methods can be chained together.
For example,
$query = new Query();
// compose the query
$query->select(['name', 'status'])
->from('customer')
->limit(10);
// execute the query
$rows = $query->all();
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
$collection | yii\mongodb\Collection | Collection instance. | yii\mongodb\Query |
$emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\db\QueryTrait |
$from | string|array | The collection to be selected from. | yii\mongodb\Query |
$indexBy | string|callable|null | The name of the column by which the query results should be indexed by. | yii\db\QueryTrait |
$limit | integer|yii\db\ExpressionInterface|null | Maximum number of records to be returned. | yii\db\QueryTrait |
$offset | integer|yii\db\ExpressionInterface|null | Zero-based offset from where the records are to be returned. | yii\db\QueryTrait |
$options | array | Cursor options in format: optionKey => optionValue | yii\mongodb\Query |
$orderBy | array|null | How to sort the query results. | yii\db\QueryTrait |
$select | array | The fields of the results to return. | yii\mongodb\Query |
$where | string|array|yii\db\ExpressionInterface|null | Query condition. | yii\db\QueryTrait |
Public Methods
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Component |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of a component property. | yii\base\Component |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
__set() | Sets the value of a component property. | yii\base\Component |
__unset() | Sets a component property to be null. | yii\base\Component |
addOptions() | Adds additional cursor options. | yii\mongodb\Query |
addOrderBy() | Adds additional ORDER BY columns to the query. | yii\db\QueryTrait |
all() | Executes the query and returns all results as an array. | yii\mongodb\Query |
andFilterCompare() | Helper method for easy querying on values containing some common operators. | yii\mongodb\Query |
andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait |
andWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
average() | Returns the average of the specified column values. | yii\mongodb\Query |
batch() | Starts a batch query. | yii\mongodb\Query |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
buildCursor() | Builds the MongoDB cursor for this query. | yii\mongodb\Query |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
column() | Executes the query and returns the first column of the result. | yii\mongodb\Query |
count() | Returns the number of records. | yii\mongodb\Query |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
distinct() | Returns a list of distinct values for the given column across a collection. | yii\mongodb\Query |
each() | Starts a batch query and retrieves data row by row. | yii\mongodb\Query |
emulateExecution() | Sets whether to emulate query execution, preventing any interaction with data storage. | yii\db\QueryTrait |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
exists() | Returns a value indicating whether the query result contains any row of data. | yii\mongodb\Query |
filterWhere() | Sets the WHERE part of the query but ignores empty operands. | yii\db\QueryTrait |
from() | Sets the collection to be selected from. | yii\mongodb\Query |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getCollection() | Returns the Mongo collection for this query. | yii\mongodb\Query |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
indexBy() | Sets the indexBy() property. | yii\db\QueryTrait |
init() | Initializes the object. | yii\base\BaseObject |
limit() | Sets the LIMIT part of the query. | yii\db\QueryTrait |
max() | Returns the maximum of the specified column values. | yii\mongodb\Query |
min() | Returns the minimum of the specified column values. | yii\mongodb\Query |
modify() | Performs 'findAndModify' query and returns a single row of result. | yii\mongodb\Query |
off() | Detaches an existing event handler from this component. | yii\base\Component |
offset() | Sets the OFFSET part of the query. | yii\db\QueryTrait |
on() | Attaches an event handler to an event. | yii\base\Component |
one() | Executes the query and returns a single row of result. | yii\mongodb\Query |
options() | Sets the cursor options. | yii\mongodb\Query |
orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait |
orWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait |
orderBy() | Sets the ORDER BY part of the query. | yii\db\QueryTrait |
populate() | Converts the raw query results into the format as specified by this query. | yii\mongodb\Query |
prepare() | Prepares for query building. | yii\mongodb\Query |
scalar() | Returns the query result as a scalar value. | yii\mongodb\Query |
select() | Sets the list of fields of the results to return. | yii\mongodb\Query |
sum() | Returns the sum of the specified column values. | yii\mongodb\Query |
trigger() | Triggers an event. | yii\base\Component |
where() | Sets the WHERE part of the query. | yii\db\QueryTrait |
Protected Methods
Method | Description | Defined By |
---|---|---|
aggregate() | Performs the aggregation for the given column. | yii\mongodb\Query |
fetchRows() | Fetches rows from the given Mongo cursor. | yii\mongodb\Query |
fetchRowsInternal() | yii\mongodb\Query | |
filterCondition() | Removes empty operands from the given query condition. | yii\db\QueryTrait |
isEmpty() | Returns a value indicating whether the give value is "empty". | yii\db\QueryTrait |
normalizeOrderBy() | Normalizes format of ORDER BY data. | yii\db\QueryTrait |
Property Details
The collection to be selected from. If string considered as the name of the collection inside the default database. If array - first element considered as the name of the database, second - as name of collection inside that database
See also from().
Cursor options in format: optionKey => optionValue
See also:
- \MongoDB\Driver\Cursor::addOption()
- options()
Method Details
Defined in: yii\base\Component::__call()
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\Component::__clone()
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\Component::__get()
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value or the value of a behavior's property |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__isset()
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
false
for non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property)
.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in: yii\base\Component::__set()
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__unset()
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property)
.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
Adds additional cursor options.
See also options().
public $this addOptions ( $options ) | ||
$options | array |
Cursor options in format: optionName => optionValue |
return | $this |
The query object itself |
---|
public function addOptions($options)
{
if (is_array($this->options)) {
$this->options = array_merge($this->options, $options);
} else {
$this->options = $options;
}
return $this;
}
Defined in: yii\db\QueryTrait::addOrderBy()
Adds additional ORDER BY columns to the query.
See also orderBy().
public $this addOrderBy ( $columns ) | ||
$columns | string|array|yii\db\ExpressionInterface |
The columns (and the directions) to be ordered by.
Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array
(e.g. The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL. |
return | $this |
The query object itself |
---|
public function addOrderBy($columns)
{
$columns = $this->normalizeOrderBy($columns);
if ($this->orderBy === null) {
$this->orderBy = $columns;
} else {
$this->orderBy = array_merge($this->orderBy, $columns);
}
return $this;
}
Performs the aggregation for the given column.
protected integer aggregate ( $column, $operator, $db ) | ||
$column | string |
Column name. |
$operator | string |
Aggregation operator. |
$db | yii\mongodb\Connection |
The database connection used to execute the query. |
return | integer |
Aggregation result. |
---|
protected function aggregate($column, $operator, $db)
{
if (!empty($this->emulateExecution)) {
return null;
}
$this->prepare();
$collection = $this->getCollection($db);
$pipelines = [];
if ($this->where !== null) {
$pipelines[] = ['$match' => $this->where];
}
$pipelines[] = [
'$group' => [
'_id' => '1',
'total' => [
'$' . $operator => '$' . $column
],
]
];
$result = $collection->aggregate($pipelines);
if (array_key_exists(0, $result)) {
return $result[0]['total'];
}
return null;
}
Executes the query and returns all results as an array.
public array all ( $db = null ) | ||
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | array |
The query results. If the query results in nothing, an empty array will be returned. |
---|
public function all($db = null)
{
if (!empty($this->emulateExecution)) {
return [];
}
$cursor = $this->buildCursor($db);
$rows = $this->fetchRows($cursor, true, $this->indexBy);
return $this->populate($rows);
}
Helper method for easy querying on values containing some common operators.
The comparison operator is intelligently determined based on the first few characters in the given value and internally translated to a MongoDB operator. In particular, it recognizes the following operators if they appear as the leading characters in the given value: <: the column must be less than the given value ($lt). >: the column must be greater than the given value ($gt). <=: the column must be less than or equal to the given value ($lte). >=: the column must be greater than or equal to the given value ($gte). <>: the column must not be the same as the given value ($ne). Note that when $partialMatch is true, this would mean the value must not be a substring of the column. =: the column must be equal to the given value ($eq). none of the above: use the $defaultOperator
Note that when the value is empty, no comparison expression will be added to the search condition.
See also \yii\mongodb\Collection::buildCondition().
public $this andFilterCompare ( $name, $value, $defaultOperator = '=' ) | ||
$name | string |
Column name |
$value | string |
Column value |
$defaultOperator | string |
Defaults to =, performing an exact match. For example: use 'LIKE' or 'REGEX' for partial cq regex matching |
return | $this |
The query object itself. |
---|
public function andFilterCompare($name, $value, $defaultOperator = '=')
{
$matches = [];
if (preg_match('/^(<>|>=|>|<=|<|=)/', (string)$value, $matches)) {
$op = $matches[1];
$value = substr($value, strlen($op));
} else {
$op = $defaultOperator;
}
return $this->andFilterWhere([$op, $name, $value]);
}
Defined in: yii\db\QueryTrait::andFilterWhere()
Adds an additional WHERE condition to the existing one but ignores empty operands.
The new condition and the existing one will be joined using the 'AND' operator.
This method is similar to andWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
See also:
public $this andFilterWhere ( array $condition ) | ||
$condition | array |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
return | $this |
The query object itself |
---|
public function andFilterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->andWhere($condition);
}
return $this;
}
Defined in: yii\db\QueryTrait::andWhere()
Adds an additional WHERE condition to the existing one.
The new condition and the existing one will be joined using the 'AND' operator.
See also:
public $this andWhere ( $condition ) | ||
$condition | string|array|yii\db\ExpressionInterface |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
return | $this |
The query object itself |
---|
public function andWhere($condition)
{
if ($this->where === null) {
$this->where = $condition;
} else {
$this->where = ['and', $this->where, $condition];
}
return $this;
}
Defined in: yii\base\Component::attachBehavior()
Attaches a behavior to this component.
This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.
See also detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
The name of the behavior. |
$behavior | string|array|yii\base\Behavior |
The behavior configuration. This can be one of the following:
|
return | yii\base\Behavior |
The behavior object |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.
See also attachBehavior().
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Returns the average of the specified column values.
public integer average ( $q, $db = null ) | ||
$q | string |
The column name. Make sure you properly quote column names in the expression. |
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | integer |
The average of the specified column values. |
---|
public function average($q, $db = null)
{
if (!empty($this->emulateExecution)) {
return 0;
}
return $this->aggregate($q, 'avg', $db);
}
Starts a batch query.
A batch query supports fetching data in batches, which can keep the memory usage under a limit.
This method will return a yii\mongodb\BatchQueryResult object which implements the Iterator
interface
and can be traversed to retrieve the data in batches.
For example,
$query = (new Query)->from('user');
foreach ($query->batch() as $rows) {
// $rows is an array of 10 or fewer rows from user collection
}
public yii\mongodb\BatchQueryResult batch ( $batchSize = 100, $db = null ) | ||
$batchSize | integer |
The number of records to be fetched in each batch. |
$db | yii\mongodb\Connection |
The MongoDB connection. If not set, the "mongodb" application component will be used. |
return | yii\mongodb\BatchQueryResult |
The batch query result. It implements the |
---|
public function batch($batchSize = 100, $db = null)
{
return Yii::createObject([
'class' => BatchQueryResult::className(),
'query' => $this,
'batchSize' => $batchSize,
'db' => $db,
'each' => false,
]);
}
Defined in: yii\base\Component::behaviors()
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
public array behaviors ( ) | ||
return | array |
The behavior configurations. |
---|
public function behaviors()
{
return [];
}
Builds the MongoDB cursor for this query.
public \MongoDB\Driver\Cursor buildCursor ( $db = null ) | ||
$db | yii\mongodb\Connection |
The MongoDB connection used to execute the query. |
return | \MongoDB\Driver\Cursor |
Mongo cursor instance. |
---|
public function buildCursor($db = null)
{
$this->prepare();
$options = $this->options;
if (!empty($this->orderBy)) {
$options['sort'] = $this->orderBy;
}
$options['limit'] = $this->limit;
$options['skip'] = $this->offset;
$cursor = $this->getCollection($db)->find($this->composeCondition(), $this->select, $options);
return $cursor;
}
Defined in: yii\base\Component::canGetProperty()
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a readable property of the given name (when
$checkBehaviors
is true).
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::canSetProperty()
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a writable property of the given name (when
$checkBehaviors
is true).
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
Executes the query and returns the first column of the result.
Column _id
will be automatically excluded from select fields, if select() is not empty and
_id
is not selected explicitly.
public array column ( $db = null ) | ||
$db | yii\mongodb\Connection |
The MongoDB connection used to generate the query.
If this parameter is not given, the |
return | array |
The first column of the query result. An empty array is returned if the query results in nothing. |
---|
public function column($db = null)
{
if (!empty($this->emulateExecution)) {
return [];
}
$originSelect = (array)$this->select;
if (!isset($originSelect['_id']) && array_search('_id', $originSelect, true) === false) {
$this->select['_id'] = false;
}
if (is_string($this->indexBy) && $originSelect && count($originSelect) === 1) {
$this->select[] = $this->indexBy;
}
$cursor = $this->buildCursor($db);
$rows = $this->fetchRows($cursor, true);
if (empty($rows)) {
return [];
}
$results = [];
foreach ($rows as $row) {
$value = reset($row);
if ($this->indexBy === null) {
$results[] = $value;
} else {
if ($this->indexBy instanceof \Closure) {
$results[call_user_func($this->indexBy, $row)] = $value;
} else {
$results[$row[$this->indexBy]] = $value;
}
}
}
return $results;
}
Returns the number of records.
public integer count ( $q = '*', $db = null ) | ||
$q | string |
Kept to match yii\db\QueryInterface, its value is ignored. |
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | integer |
Number of records |
---|---|---|
throws | yii\mongodb\Exception |
on failure. |
public function count($q = '*', $db = null)
{
if (!empty($this->emulateExecution)) {
return 0;
}
$this->prepare();
$collection = $this->getCollection($db);
return $collection->count($this->where, $this->options);
}
Defined in: yii\base\Component::detachBehavior()
Detaches a behavior from the component.
The behavior's yii\base\Behavior::detach() method will be invoked.
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
The behavior's name. |
return | yii\base\Behavior|null |
The detached behavior. Null if the behavior does not exist. |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in: yii\base\Component::detachBehaviors()
Detaches all behaviors from the component.
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Returns a list of distinct values for the given column across a collection.
public array distinct ( $q, $db = null ) | ||
$q | string |
Column to use. |
$db | yii\mongodb\Connection |
The MongoDB connection used to execute the query.
If this parameter is not given, the |
return | array |
Array of distinct values |
---|
public function distinct($q, $db = null)
{
if (!empty($this->emulateExecution)) {
return [];
}
$this->prepare();
$collection = $this->getCollection($db);
if ($this->where !== null) {
$condition = $this->where;
} else {
$condition = [];
}
$result = $collection->distinct($q, $condition);
if ($result === false) {
return [];
}
return $result;
}
Starts a batch query and retrieves data row by row.
This method is similar to batch() except that in each iteration of the result, only one row of data is returned. For example,
$query = (new Query)->from('user');
foreach ($query->each() as $row) {
}
public yii\mongodb\BatchQueryResult each ( $batchSize = 100, $db = null ) | ||
$batchSize | integer |
The number of records to be fetched in each batch. |
$db | yii\mongodb\Connection |
The MongoDB connection. If not set, the "mongodb" application component will be used. |
return | yii\mongodb\BatchQueryResult |
The batch query result. It implements the |
---|
public function each($batchSize = 100, $db = null)
{
return Yii::createObject([
'class' => BatchQueryResult::className(),
'query' => $this,
'batchSize' => $batchSize,
'db' => $db,
'each' => true,
]);
}
Defined in: yii\db\QueryTrait::emulateExecution()
Sets whether to emulate query execution, preventing any interaction with data storage.
After this mode is enabled, methods, returning query results like yii\db\QueryInterface::one(),
yii\db\QueryInterface::all(), yii\db\QueryInterface::exists() and so on, will return empty or false values.
You should use this method in case your program logic indicates query should not return any results, like
in case you set false where condition like 0=1
.
public $this emulateExecution ( $value = true ) | ||
$value | boolean |
Whether to prevent query execution. |
return | $this |
The query object itself. |
---|
public function emulateExecution($value = true)
{
$this->emulateExecution = $value;
return $this;
}
Defined in: yii\base\Component::ensureBehaviors()
Makes sure that the behaviors declared in behaviors() are attached to this component.
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Returns a value indicating whether the query result contains any row of data.
public boolean exists ( $db = null ) | ||
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | boolean |
Whether the query result contains any row of data. |
---|
public function exists($db = null)
{
if (!empty($this->emulateExecution)) {
return false;
}
$cursor = $this->buildCursor($db);
foreach ($cursor as $row) {
return true;
}
return false;
}
Fetches rows from the given Mongo cursor.
protected array|boolean fetchRows ( $cursor, $all = true, $indexBy = null ) | ||
$cursor | \MongoDB\Driver\Cursor |
Mongo cursor instance to fetch data from. |
$all | boolean |
Whether to fetch all rows or only first one. |
$indexBy | string|callable |
The column name or PHP callback, by which the query results should be indexed by. |
return | array|boolean |
Result. |
---|---|---|
throws | yii\mongodb\Exception |
on failure. |
protected function fetchRows($cursor, $all = true, $indexBy = null)
{
$token = 'fetch cursor id = ' . $cursor->getId();
Yii::info($token, __METHOD__);
try {
Yii::beginProfile($token, __METHOD__);
$result = $this->fetchRowsInternal($cursor, $all);
Yii::endProfile($token, __METHOD__);
return $result;
} catch (\Exception $e) {
Yii::endProfile($token, __METHOD__);
throw new Exception($e->getMessage(), (int) $e->getCode(), $e);
}
}
See also yii\mongodb\Query::fetchRows().
protected array|boolean fetchRowsInternal ( $cursor, $all ) | ||
$cursor | \MongoDB\Driver\Cursor |
Mongo cursor instance to fetch data from. |
$all | boolean |
Whether to fetch all rows or only first one. |
return | array|boolean |
Result. |
---|
protected function fetchRowsInternal($cursor, $all)
{
$result = [];
if ($all) {
foreach ($cursor as $row) {
$result[] = $row;
}
} else {
if ($row = current($cursor->toArray())) {
$result = $row;
} else {
$result = false;
}
}
return $result;
}
Defined in: yii\db\QueryTrait::filterCondition()
Removes empty operands from the given query condition.
protected array filterCondition ( $condition ) | ||
$condition | array |
The original condition |
return | array |
The condition with empty operands removed. |
---|---|---|
throws | yii\base\NotSupportedException |
if the condition operator is not supported |
protected function filterCondition($condition)
{
if (!is_array($condition)) {
return $condition;
}
if (!isset($condition[0])) {
// hash format: 'column1' => 'value1', 'column2' => 'value2', ...
foreach ($condition as $name => $value) {
if ($this->isEmpty($value)) {
unset($condition[$name]);
}
}
return $condition;
}
// operator format: operator, operand 1, operand 2, ...
$operator = array_shift($condition);
switch (strtoupper($operator)) {
case 'NOT':
case 'AND':
case 'OR':
foreach ($condition as $i => $operand) {
$subCondition = $this->filterCondition($operand);
if ($this->isEmpty($subCondition)) {
unset($condition[$i]);
} else {
$condition[$i] = $subCondition;
}
}
if (empty($condition)) {
return [];
}
break;
case 'BETWEEN':
case 'NOT BETWEEN':
if (array_key_exists(1, $condition) && array_key_exists(2, $condition)) {
if ($this->isEmpty($condition[1]) || $this->isEmpty($condition[2])) {
return [];
}
}
break;
default:
if (array_key_exists(1, $condition) && $this->isEmpty($condition[1])) {
return [];
}
}
array_unshift($condition, $operator);
return $condition;
}
Defined in: yii\db\QueryTrait::filterWhere()
Sets the WHERE part of the query but ignores empty operands.
This method is similar to where(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
The following code shows the difference between this method and where():
// WHERE `age`=:age
$query->filterWhere(['name' => null, 'age' => 20]);
// WHERE `age`=:age
$query->where(['age' => 20]);
// WHERE `name` IS NULL AND `age`=:age
$query->where(['name' => null, 'age' => 20]);
Note that unlike where(), you cannot pass binding parameters to this method.
See also:
public $this filterWhere ( array $condition ) | ||
$condition | array |
The conditions that should be put in the WHERE part. See where() on how to specify this parameter. |
return | $this |
The query object itself |
---|
public function filterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->where($condition);
}
return $this;
}
Sets the collection to be selected from.
public $this from ( $collection ) | ||
$collection | ||
return | $this |
The query object itself. |
---|
public function from($collection)
{
$this->from = $collection;
return $this;
}
Defined in: yii\base\Component::getBehavior()
Returns the named behavior object.
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
The behavior name |
return | yii\base\Behavior|null |
The behavior object, or null if the behavior does not exist |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in: yii\base\Component::getBehaviors()
Returns all behaviors attached to this component.
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
List of behaviors attached to this component |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
Returns the Mongo collection for this query.
public yii\mongodb\Collection getCollection ( $db = null ) | ||
$db | yii\mongodb\Connection |
Mongo connection. |
return | yii\mongodb\Collection |
Collection instance. |
---|
public function getCollection($db = null)
{
if ($db === null) {
$db = Yii::$app->get('mongodb');
}
return $db->getCollection($this->from);
}
Defined in: yii\base\Component::hasEventHandlers()
Returns a value indicating whether there is any handler attached to the named event.
public boolean hasEventHandlers ( $name ) | ||
$name | string |
The event name |
return | boolean |
Whether there is any handler attached to the event. |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in: yii\base\Component::hasMethod()
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviors
is true).
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::hasProperty()
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a property of the given name (when
$checkBehaviors
is true).
See also:
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Defined in: yii\db\QueryTrait::indexBy()
Sets the indexBy() property.
public $this indexBy ( $column ) | ||
$column | string|callable |
The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be:
|
return | $this |
The query object itself |
---|
public function indexBy($column)
{
$this->indexBy = $column;
return $this;
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
public function init()
{
}
Defined in: yii\db\QueryTrait::isEmpty()
Returns a value indicating whether the give value is "empty".
The value is considered "empty", if one of the following conditions is satisfied:
- it is
null
, - an empty string (
''
), - a string containing only whitespace characters,
- or an empty array.
protected boolean isEmpty ( $value ) | ||
$value | mixed | |
return | boolean |
If the value is empty |
---|
protected function isEmpty($value)
{
return $value === '' || $value === [] || $value === null || is_string($value) && trim($value) === '';
}
Defined in: yii\db\QueryTrait::limit()
Sets the LIMIT part of the query.
public $this limit ( $limit ) | ||
$limit | integer|yii\db\ExpressionInterface|null |
The limit. Use null or negative value to disable limit. |
return | $this |
The query object itself |
---|
public function limit($limit)
{
$this->limit = $limit;
return $this;
}
Returns the maximum of the specified column values.
public integer max ( $q, $db = null ) | ||
$q | string |
The column name. Make sure you properly quote column names in the expression. |
$db | yii\mongodb\Connection |
The MongoDB connection used to execute the query.
If this parameter is not given, the |
return | integer |
The maximum of the specified column values. |
---|
public function max($q, $db = null)
{
return $this->aggregate($q, 'max', $db);
}
Returns the minimum of the specified column values.
public integer min ( $q, $db = null ) | ||
$q | string |
The column name. Make sure you properly quote column names in the expression. |
$db | yii\mongodb\Connection |
The MongoDB connection used to execute the query.
If this parameter is not given, the |
return | integer |
The minimum of the specified column values. |
---|
public function min($q, $db = null)
{
return $this->aggregate($q, 'min', $db);
}
Performs 'findAndModify' query and returns a single row of result.
public array|null modify ( $update, $options = [], $db = null ) | ||
$update | array |
Update criteria |
$options | array |
List of options in format: optionName => optionValue. |
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query. |
return | array|null |
The original document, or the modified document when $options['new'] is set. |
---|
public function modify($update, $options = [], $db = null)
{
if (!empty($this->emulateExecution)) {
return null;
}
$this->prepare();
$collection = $this->getCollection($db);
if (!empty($this->orderBy)) {
$options['sort'] = $this->orderBy;
}
$options['fields'] = $this->select;
return $collection->findAndModify($this->composeCondition(), $update, $options);
}
Defined in: yii\db\QueryTrait::normalizeOrderBy()
Normalizes format of ORDER BY data.
protected array normalizeOrderBy ( $columns ) | ||
$columns | array|string|yii\db\ExpressionInterface|null |
The columns value to normalize. See orderBy() and addOrderBy(). |
protected function normalizeOrderBy($columns)
{
if (empty($columns)) {
return [];
} elseif ($columns instanceof ExpressionInterface) {
return [$columns];
} elseif (is_array($columns)) {
return $columns;
}
$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
$result = [];
foreach ($columns as $column) {
if (preg_match('/^(.*?)\s+(asc|desc)$/i', $column, $matches)) {
$result[$matches[1]] = strcasecmp($matches[2], 'desc') ? SORT_ASC : SORT_DESC;
} else {
$result[$column] = SORT_ASC;
}
}
return $result;
}
Defined in: yii\base\Component::off()
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
Event name |
$handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
return | boolean |
If a handler is found and detached |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in: yii\db\QueryTrait::offset()
Sets the OFFSET part of the query.
public $this offset ( $offset ) | ||
$offset | integer|yii\db\ExpressionInterface|null |
The offset. Use null or negative value to disable offset. |
return | $this |
The query object itself |
---|
public function offset($offset)
{
$this->offset = $offset;
return $this;
}
Defined in: yii\base\Component::on()
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event
is an yii\base\Event object which includes parameters associated with the event.
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
The event name |
$handler | callable |
The event handler |
$data | mixed |
The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data. |
$append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Executes the query and returns a single row of result.
public array|false one ( $db = null ) | ||
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | array|false |
The first row (in terms of an array) of the query result. |
---|
public function one($db = null)
{
if (!empty($this->emulateExecution)) {
return false;
}
$cursor = $this->buildCursor($db);
return $this->fetchRows($cursor, false);
}
Sets the cursor options.
See also addOptions().
public $this options ( $options ) | ||
$options | array |
Cursor options in format: optionName => optionValue |
return | $this |
The query object itself |
---|
public function options($options)
{
$this->options = $options;
return $this;
}
Defined in: yii\db\QueryTrait::orFilterWhere()
Adds an additional WHERE condition to the existing one but ignores empty operands.
The new condition and the existing one will be joined using the 'OR' operator.
This method is similar to orWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.
See also:
public $this orFilterWhere ( array $condition ) | ||
$condition | array |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
return | $this |
The query object itself |
---|
public function orFilterWhere(array $condition)
{
$condition = $this->filterCondition($condition);
if ($condition !== []) {
$this->orWhere($condition);
}
return $this;
}
Defined in: yii\db\QueryTrait::orWhere()
Adds an additional WHERE condition to the existing one.
The new condition and the existing one will be joined using the 'OR' operator.
See also:
public $this orWhere ( $condition ) | ||
$condition | string|array|yii\db\ExpressionInterface |
The new WHERE condition. Please refer to where() on how to specify this parameter. |
return | $this |
The query object itself |
---|
public function orWhere($condition)
{
if ($this->where === null) {
$this->where = $condition;
} else {
$this->where = ['or', $this->where, $condition];
}
return $this;
}
Defined in: yii\db\QueryTrait::orderBy()
Sets the ORDER BY part of the query.
See also addOrderBy().
public $this orderBy ( $columns ) | ||
$columns | string|array|yii\db\ExpressionInterface|null |
The columns (and the directions) to be ordered by.
Columns can be specified in either a string (e.g. The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns. Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL. |
return | $this |
The query object itself |
---|
public function orderBy($columns)
{
$this->orderBy = $this->normalizeOrderBy($columns);
return $this;
}
Converts the raw query results into the format as specified by this query.
This method is internally used to convert the data fetched from database into the format as required by this query.
public array populate ( $rows ) | ||
$rows | array |
The raw query result from database |
return | array |
The converted query result |
---|
public function populate($rows)
{
if ($this->indexBy === null) {
return $rows;
}
$result = [];
foreach ($rows as $row) {
$result[ArrayHelper::getValue($row, $this->indexBy)] = $row;
}
return $result;
}
Prepares for query building.
This method is called before actual query composition, e.g. building cursor, count etc. You may override this method to do some final preparation work before query execution.
public $this prepare ( ) | ||
return | $this |
A prepared query instance. |
---|
public function prepare()
{
return $this;
}
Returns the query result as a scalar value.
The value returned will be the first column in the first row of the query results.
Column _id
will be automatically excluded from select fields, if select() is not empty and
_id
is not selected explicitly.
public string|null|false scalar ( $db = null ) | ||
$db | yii\mongodb\Connection |
The MongoDB connection used to generate the query.
If this parameter is not given, the |
return | string|null|false |
The value of the first column in the first row of the query result.
|
---|
public function scalar($db = null)
{
if (!empty($this->emulateExecution)) {
return null;
}
$originSelect = (array)$this->select;
if (!isset($originSelect['_id']) && array_search('_id', $originSelect, true) === false) {
$this->select['_id'] = false;
}
$cursor = $this->buildCursor($db);
$row = $this->fetchRows($cursor, false);
if (empty($row)) {
return false;
}
return reset($row);
}
Sets the list of fields of the results to return.
public $this select ( array $fields ) | ||
$fields | array |
Fields of the results to return. |
return | $this |
The query object itself. |
---|
public function select(array $fields)
{
$this->select = $fields;
return $this;
}
Returns the sum of the specified column values.
public integer sum ( $q, $db = null ) | ||
$q | string |
The column name. Make sure you properly quote column names in the expression. |
$db | yii\mongodb\Connection |
The Mongo connection used to execute the query.
If this parameter is not given, the |
return | integer |
The sum of the specified column values |
---|
public function sum($q, $db = null)
{
if (!empty($this->emulateExecution)) {
return 0;
}
return $this->aggregate($q, 'sum', $db);
}
Defined in: yii\base\Component::trigger()
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
The event name |
$event | yii\base\Event|null |
The event instance. If not set, a default yii\base\Event object will be created. |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
Defined in: yii\db\QueryTrait::where()
Sets the WHERE part of the query.
See yii\db\QueryInterface::where() for detailed documentation.
See also:
public $this where ( $condition ) | ||
$condition | string|array|yii\db\ExpressionInterface |
The conditions that should be put in the WHERE part. |
return | $this |
The query object itself |
---|
public function where($condition)
{
$this->where = $condition;
return $this;
}