mongodb\file\Query
Class yii\mongodb\file\Query
Inheritance | yii\mongodb\file\Query » yii\mongodb\Query » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable, yii\db\QueryInterface |
Uses Traits | yii\db\QueryTrait |
Subclasses | yii\mongodb\file\ActiveQuery |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-mongodb/blob/master/file/Query.php |
Query represents Mongo "find" operation for GridFS collection.
Query behaves exactly as regular yii\mongodb\Query- Found files will be represented as arrays of file document attributes with additional 'file' key, which stores \MongoGridFSFile instance.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$collection | yii\mongodb\file\Collection | Collection instance. | yii\mongodb\file\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 | The name of the column by which the query results should be indexed by. | yii\db\QueryTrait |
$limit | integer|yii\db\Expression | Maximum number of records to be returned. | yii\db\QueryTrait |
$offset | integer|yii\db\Expression | 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 | How to sort the query results. | yii\db\QueryTrait |
$select | array | The fields of the results to return. | yii\mongodb\Query |
$where | string|array | 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\Object |
__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\Object |
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\file\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\Object |
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
$collection public read-only property
Collection instance.
public yii\mongodb\file\Collection getCollection ( $db = null )
Method Details
getCollection() public method
Returns the Mongo collection for this query.
public yii\mongodb\file\Collection getCollection ( $db = null ) | ||
---|---|---|
$db | yii\mongodb\Connection |
Mongo connection. |
return | yii\mongodb\file\Collection |
Collection instance. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-mongodb-file-query.html