MockElementQuery
- Type
- Class
- Namespace
- craft\test\mockclasses\elements
- Inherits
- craft\test\mockclasses\elements\MockElementQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- craft\elements\db\ElementQueryInterface, yii\base\Configurable (opens new window), yii\db\ExpressionInterface (opens new window), yii\db\QueryInterface (opens new window)
- Uses traits
- craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\db\QueryTrait (opens new window)
- Since
- 3.5
MockElementQuery is used to mimic element queries and mock their results
View source (opens new window)
# Public Properties
# Protected Properties
Property | Description |
---|---|
defaultOrderBy | array (opens new window) – The default orderBy() value to use if orderBy() is empty but not null. |
properties | array (opens new window) |
returnValues | array (opens new window) |
# properties
- Type
- array (opens new window)
- Default value
[]
View source (opens new window)
# returnValues
- Type
- array (opens new window)
- Default value
[]
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() | Mock setting query arguments via a method call. |
__clone() | |
__construct() | MockElementQuery constructor. |
__get() | Getter for mock query arguments. |
__isset() | Check if a property has been set already. |
__set() | Setter for mock query arguments. |
__toString() (opens new window) | Returns the SQL representation of Query |
__unset() (opens new window) | Sets a component property to be null. |
addGroupBy() (opens new window) | Adds additional group-by columns to the existing ones. |
addOrderBy() (opens new window) | Adds additional ORDER BY columns to the query. |
addParams() (opens new window) | Adds additional parameters to be bound to the query. |
addSelect() (opens new window) | Add more columns to the SELECT part of the query. |
afterPopulate() | Performs any post-population processing on elements. |
all() | Return all the return values. |
ancestorDist() | Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf(). |
ancestorOf() | Narrows the query results to only {elements} that are ancestors of another {element} in its structure. |
andFilterCompare() (opens new window) | Adds a filtering condition for a specific column and allow the user to choose a filter operator. |
andFilterHaving() (opens new window) | Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window). |
andFilterWhere() (opens new window) | Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window). |
andHaving() (opens new window) | Adds an additional HAVING condition to the existing one. |
andRelatedTo() | Narrows the query results to only {elements} that are related to certain other elements. |
andWhere() (opens new window) | Adds an additional WHERE condition to the existing one. |
andWith() | Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with(). |
anyStatus() | Removes element filters based on their statuses. |
archived() | Sets the archived property. |
asArray() | Causes the query to return matching {elements} as arrays of data, rather than [[{element-class}]] objects. |
attachBehavior() (opens new window) | Attaches a behavior to this component. |
attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
average() (opens new window) | Returns the average of the specified column values. |
batch() (opens new window) | Starts a batch query. |
behaviors() | Returns a list of behaviors that this component should behave as. |
cache() | Enables query cache for this Query. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
clearCachedResult() | Clears the cached result (opens new window). |
column() | Executes the query and returns the first column of the result. |
count() | Returns the number of records. |
create() (opens new window) | Creates a new Query object and copies its property values from an existing one. |
createCommand() (opens new window) | Creates a DB command that can be used to execute this query. |
createElement() | Converts a found row into an element instance. |
criteriaAttributes() | Returns the query's criteria attributes. |
dateCreated() | Narrows the query results based on the {elements}’ creation dates. |
dateUpdated() | Narrows the query results based on the {elements}’ last-updated dates. |
descendantDist() | Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf(). |
descendantOf() | Narrows the query results to only {elements} that are descendants of another {element} in its structure. |
detachBehavior() (opens new window) | Detaches a behavior from the component. |
detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
distinct() (opens new window) | Sets the value indicating whether to SELECT DISTINCT or not. |
draftCreator() | Narrows the query results to only drafts created by a given user. |
draftId() | Narrows the query results based on the {elements}’ draft’s ID (from the drafts table). |
draftOf() | Narrows the query results to only drafts of a given {element}. |
drafts() | Narrows the query results to only drafts {elements}. |
each() (opens new window) | Starts a batch query and retrieves data row by row. |
emulateExecution() (opens new window) | Sets whether to emulate query execution, preventing any interaction with data storage. |
enabledForSite() | Narrows the query results based on whether the {elements} are enabled in the site they’re being queried in, per the site() parameter. |
ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
exists() | Returns a value indicating whether the query result contains any row of data. |
extraFields() (opens new window) | Returns the list of fields that can be expanded further and returned by toArray() (opens new window). |
fields() (opens new window) | Returns the list of fields that should be returned by default by toArray() (opens new window) when no specific fields are specified. |
filterHaving() (opens new window) | Sets the HAVING part of the query but ignores empty operands (opens new window). |
filterWhere() (opens new window) | Sets the WHERE part of the query but ignores empty operands (opens new window). |
find() | Returns all elements that match the criteria. |
first() | Returns the first element that matches the criteria. |
fixedOrder() | Causes the query results to be returned in the order specified by id(). |
from() (opens new window) | Sets the FROM part of the query. |
generateSpecificQueryClass() | Generate a more specific query class for the provided element type class. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getCacheTags() | |
getCachedResult() | Returns the resulting elements set by setCachedResult(), if the criteria params haven’t changed since then. |
getCriteria() | Returns an array of the current criteria attribute values. |
getIterator() | Required by the IteratorAggregate interface. |
getRawSql() | Shortcut for createCommand()->getRawSql() . |
getTablesUsedInFrom() (opens new window) | Returns table names used in from() (opens new window) indexed by aliases. |
groupBy() (opens new window) | Sets the GROUP BY part of the query. |
hasDescendants() | Narrows the query results based on whether the {elements} have any descendants in their structure. |
hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
having() (opens new window) | Sets the HAVING part of the query. |
id() | Narrows the query results based on the {elements}’ IDs. |
ids() | Executes the query and returns the IDs of the resulting elements. |
ignorePlaceholders() | Causes the query to return matching {elements} as they are stored in the database, ignoring matching placeholder elements that were set by craft\services\Elements::setPlaceholderElement(). |
inReverse() | Causes the query results to be returned in reverse order. |
indexBy() (opens new window) | Sets the indexBy() (opens new window) property. |
init() | Initializes the object. |
innerJoin() (opens new window) | Appends an INNER JOIN part to the query. |
isJoined() | Returns whether a given table has been joined in this query. |
join() (opens new window) | Appends a JOIN part to the query. |
last() | Returns the last element that matches the criteria. |
leaves() | Narrows the query results based on whether the {elements} are “leaves” ({elements} with no descendants). |
leftJoin() (opens new window) | Appends a LEFT OUTER JOIN part to the query. |
level() | Narrows the query results based on the {elements}’ level within the structure. |
limit() (opens new window) | Sets the LIMIT part of the query. |
locale() | Sets the site property. |
localeEnabled() | Sets the enabledForSite property. |
max() (opens new window) | Returns the maximum of the specified column values. |
min() (opens new window) | Returns the minimum of the specified column values. |
nextSiblingOf() | Narrows the query results to only the {element} that comes immediately after another {element} in its structure. |
noCache() (opens new window) | Disables query cache for this Query. |
nth() | Executes the query and returns a single row of result at a given offset. |
off() (opens new window) | Detaches an existing event handler from this component. |
offset() (opens new window) | Sets the OFFSET part of the query. |
offsetExists() | Required by the ArrayAccess interface. |
offsetGet() | Required by the ArrayAccess interface. |
offsetSet() | Required by the ArrayAccess interface. |
offsetUnset() | Required by the ArrayAccess interface. |
on() (opens new window) | Attaches an event handler to an event. |
one() | Return a return value. |
orFilterHaving() (opens new window) | Adds an additional HAVING condition to the existing one but ignores empty operands (opens new window). |
orFilterWhere() (opens new window) | Adds an additional WHERE condition to the existing one but ignores empty operands (opens new window). |
orHaving() (opens new window) | Adds an additional HAVING condition to the existing one. |
orWhere() (opens new window) | Adds an additional WHERE condition to the existing one. |
order() | Sets the orderBy property. |
orderBy() (opens new window) | Sets the ORDER BY part of the query. |
pairs() | Executes the query and returns the first two columns in the results as key/value pairs. |
params() (opens new window) | Sets the parameters to be bound to the query. |
populate() | Converts the raw query results into the format as specified by this query. |
positionedAfter() | Narrows the query results to only {elements} that are positioned after another {element} in its structure. |
positionedBefore() | Narrows the query results to only {elements} that are positioned before another {element} in its structure. |
preferSites() | If unique() is set, this determines which site should be selected when querying multi-site elements. |
prepare() | Prepares for building SQL. |
prevSiblingOf() | Narrows the query results to only the {element} that comes immediately before another {element} in its structure. |
provisionalDrafts() | Narrows the query results to only provisional drafts. |
ref() | Narrows the query results based on a reference string. |
relatedTo() | Narrows the query results to only {elements} that are related to certain other elements. |
revisionCreator() | Narrows the query results to only revisions created by a given user. |
revisionId() | Narrows the query results based on the {elements}’ revision’s ID (from the revisions table). |
revisionOf() | Narrows the query results to only revisions of a given {element}. |
revisions() | Narrows the query results to only revision {elements}. |
rightJoin() (opens new window) | Appends a RIGHT OUTER JOIN part to the query. |
savedDraftsOnly() | Narrows the query results to only unpublished drafts which have been saved after initial creation. |
scalar() | Returns the query result as a scalar value. |
search() | Narrows the query results to only {elements} that match a search query. |
select() (opens new window) | Sets the SELECT part of the query. |
setCachedResult() | Sets the resulting elements. |
setReturnValues() | Set the return values. |
siblingOf() | Narrows the query results to only {elements} that are siblings of another {element} in its structure. |
site() | Determines which site(s) the {elements} should be queried in. |
siteId() | Determines which site(s) the {elements} should be queried in, per the site’s ID. |
siteSettingsId() | Narrows the query results based on the {elements}’ IDs in the elements_sites table. |
slug() | Narrows the query results based on the {elements}’ slugs. |
status() | Narrows the query results based on the {elements}’ statuses. |
structureId() | Determines which structure data should be joined into the query. |
sum() (opens new window) | Returns the sum of the specified column values. |
title() | Narrows the query results based on the {elements}’ titles. |
toArray() (opens new window) | Converts the model into an array. |
total() | Returns the total elements that match the criteria. |
trashed() | Narrows the query results to only {elements} that have been soft-deleted. |
trigger() (opens new window) | Triggers an event. |
uid() | Narrows the query results based on the {elements}’ UIDs. |
union() (opens new window) | Appends a SQL statement using UNION operator. |
unique() | Determines whether only elements with unique IDs should be returned by the query. |
uri() | Narrows the query results based on the {elements}’ URIs. |
where() (opens new window) | Sets the WHERE part of the query. |
with() | Causes the query to return matching {elements} eager-loaded with related elements. |
withQuery() (opens new window) | Prepends a SQL statement using WITH syntax. |
withStructure() | Explicitly determines whether the query should join in the structure data. |
# __call()
Mock setting query arguments via a method call.
View source (opens new window)
Arguments
$method
$arguments
Returns
static
# __construct()
MockElementQuery constructor.
View source (opens new window)
# __get()
Getter for mock query arguments.
View source (opens new window)
Arguments
$name
# __isset()
Check if a property has been set already.
View source (opens new window)
Arguments
$name
Returns
# __set()
Setter for mock query arguments.
View source (opens new window)
Arguments
$name
$value
# all()
Return all the return values.
View source (opens new window)
Arguments
$db
Returns
# generateSpecificQueryClass()
Generate a more specific query class for the provided element type class.
View source (opens new window)
Arguments
$elementClass
# one()
Return a return value.
View source (opens new window)
Arguments
$db
Returns
mixed
, null (opens new window)
# setReturnValues()
Set the return values.
View source (opens new window)
Arguments
$values
(array (opens new window))
Returns
static
# Protected Methods
Method | Description |
---|---|
afterPrepare() | This method is called at the end of preparing an element query for the query builder. |
beforePrepare() | This method is called at the beginning of preparing an element query for the query builder. |
cacheTags() | Returns any cache invalidation tags that caches involving this element query should use as dependencies. |
cleanUpTableNames() (opens new window) | Clean up table names and aliases Both aliases and names are enclosed into . |
customFields() | Returns the fields that should take part in an upcoming elements query. |
extractFieldsFor() (opens new window) | Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". |
extractRootFields() (opens new window) | Extracts the root field names from nested fields. |
filterCondition() (opens new window) | Removes empty operands (opens new window) from the given query condition. |
getUnaliasedColumnsFromSelect() (opens new window) | |
getUniqueColumns() (opens new window) | Returns unique column names excluding duplicates. |
isEmpty() (opens new window) | Returns a value indicating whether the give value is "empty". |
joinElementTable() | Joins in a table with an id column that has a foreign key pointing to craft_elements .id . |
normalizeOrderBy() (opens new window) | Normalizes format of ORDER BY data. |
normalizeSelect() (opens new window) | Normalizes the SELECT columns passed to select() (opens new window) or addSelect() (opens new window). |
queryScalar() | Queries a scalar value by setting select() (opens new window) first. |
resolveFields() (opens new window) | Determines which fields can be returned by toArray() (opens new window). |
setCommandCache() (opens new window) | Sets $command cache, if this query has enabled caching. |
statusCondition() | Returns the condition that should be applied to the element query for a given status. |
# Constants
Constant | Description |
---|---|
CLASS_TEMPLATE_FILE |