Skip to content

MockElementQuery

Type
Class
Namespace
craft\test\mockclasses\elements
Inherits
craft\test\mockclasses\elements\MockElementQuery » craft\elements\db\ElementQuery » craft\db\Query » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements
craft\elements\db\ElementQueryInterface, yii\base\Configurable, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\db\QueryTrait
Since
3.5

MockElementQuery is used to mimic element queries and mock their results

View source

Public Properties

PropertyDescription
ancestorDistinteger, null – The maximum number of levels that results may be separated from ancestorOf().
ancestorOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
archivedboolean – Whether to return only archived elements.
asArrayboolean – Whether to return each element as an array.
behaviorsyii\base\Behavior – List of behaviors attached to this component.
cacheTagsstring[]
cachedResultcraft\base\ElementInterface[], null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTablestring, null – The content table that will be joined by this query.
criteriaarray
customFieldscraft\base\FieldInterface[], null – The fields that may be involved in this query.
dateCreatedmixed – When the resulting elements must have been created.
dateUpdatedmixed – When the resulting elements must have been last updated.
descendantDistinteger, null – The maximum number of levels that results may be separated from descendantOf().
descendantOfinteger, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
distinctboolean – Whether to select distinct rows of data only.
draftCreatorinteger, null – The drafts’ creator ID
draftIdinteger, null – The ID of the draft to return (from the drafts table)
draftOfinteger, string, false, null – The source element ID that drafts should be returned for.
draftsboolean, null – Whether draft elements should be returned.
elementTypestring, null – The name of the craft\base\ElementInterface class.
emulateExecutionboolean – Whether to emulate the actual query execution, returning empty or false results.
enabledForSiteboolean – Whether the elements must be enabled for the chosen site.
fixedOrderboolean – Whether results should be returned in the order specified by id().
fromarray, null – The table(s) to be selected from.
groupByarray, null – How to group the query results.
hasDescendantsboolean, null – Whether the resulting elements must have descendants.
havingstring, array, yii\db\ExpressionInterface, null – The condition to be applied in the GROUP BY clause.
idinteger, integer[], false, null – The element ID(s).
ignorePlaceholdersboolean – Whether to ignore placeholder elements when populating the results.
inReverseboolean – Whether the results should be queried in reverse.
indexBystring, callable, null – The name of the column by which the query results should be indexed by.
iteratorArrayIterator
joinarray, null – How to join with other tables.
leavesboolean – Whether the elements must be “leaves” in the structure.
levelmixed – The element’s level within the structure
limitinteger, yii\db\ExpressionInterface, null – Maximum number of records to be returned.
nextSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
offsetinteger, yii\db\ExpressionInterface, null – Zero-based offset from where the records are to be returned.
orderByarray, null – How to sort the query results.
paramsarray, null – List of query parameter values indexed by parameter placeholders.
positionedAfterinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
positionedBeforeinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
preferSitesarray, null – Determines which site should be selected when querying multi-site elements.
prevSiblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
provisionalDraftsboolean, null – Whether provisional drafts should be returned.
querycraft\db\Query, null – The query object created by prepare()
queryCacheDependencyyii\caching\Dependency, null – The dependency to be associated with the cached query result for this query
queryCacheDurationinteger, boolean, null – The default number of seconds that query results can remain valid in cache.
rawSqlstring
refstring, string[], null – The reference code(s) used to identify the element(s).
relatedTointeger, array, craft\base\ElementInterface, null – The element relation criteria.
revisionCreatorinteger, null – The revisions’ creator ID
revisionIdinteger, null – The ID of the revision to return (from the revisions table)
revisionOfinteger, null – The source element ID that revisions should be returned for
revisionsboolean – Whether revision elements should be returned.
savedDraftsOnlyboolean – Whether only unpublished drafts which have been saved after initial creation should be included in the results.
searchstring, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
selectarray, null – The columns being selected.
selectOptionstring, null – Additional option that should be appended to the 'SELECT' keyword.
siblingOfinteger, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
sitestring, string[], craft\models\Site – The site(s) that resulting elements must be returned in
siteIdinteger, integer[], string, null – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
siteSettingsIdinteger, integer[], null – The element ID(s) in the elements_sites table.
slugstring, string[], null – The slug that resulting elements must have.
statusstring, string[], null – The status(es) that the resulting elements must have.
structureIdinteger, false, null – The structure ID that should be used to join in the structureelements table.
subQuerycraft\db\Query, null – The subselect’s query object created by prepare()
tablesUsedInFromstring[] – Table names indexed by aliases.
titlestring, string[], null – The title that resulting elements must have.
trashedboolean, null – Whether to return trashed (soft-deleted) elements.
uidstring, string[], null – The element UID(s).
unionarray, null – This is used to construct the UNION clause(s) in a SQL statement.
uniqueboolean – Whether only elements with unique IDs should be returned by the query.
uristring, string[], null – The URI that the resulting element must have.
wherestring, array, yii\db\ExpressionInterface, null – Query condition.
withstring, array, null – The eager-loading declaration.
withQueriesarray, null – This is used to construct the WITH section in a SQL query.
withStructureboolean, null – Whether element structure data should automatically be left-joined into the query.

Protected Properties

PropertyDescription
defaultOrderByarray – The default orderBy() value to use if orderBy() is empty but not null.
propertiesarray
returnValuesarray

properties

Type
array
Default value
[]

View source

returnValues

Type
array
Default value
[]

View source

Public Methods

MethodDescription
__call()Mock setting query arguments via a method call.
__clone()This method is called after the object is created by cloning an existing one.
__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()Returns the SQL representation of Query
__unset()Sets a component property to be null.
addGroupBy()Adds additional group-by columns to the existing ones.
addOrderBy()Adds additional ORDER BY columns to the query.
addParams()Adds additional parameters to be bound to the query.
addSelect()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()Adds a filtering condition for a specific column and allow the user to choose a filter operator.
andFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
andFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
andHaving()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()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()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
average()Returns the average of the specified column values.
batch()Starts a batch query.
behaviors()Returns a list of behaviors that this component should behave as.
cache()Enables query cache for this Query.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
clearCachedResult()Clears the cached result.
column()Executes the query and returns the first column of the result.
count()Returns the number of records.
create()Creates a new Query object and copies its property values from an existing one.
createCommand()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()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
distinct()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()Starts a batch query and retrieves data row by row.
emulateExecution()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()Makes sure that the behaviors declared in behaviors() are attached to this component.
exists()Returns a value indicating whether the query result contains any row of data.
extraFields()Returns the list of fields that can be expanded further and returned by toArray().
fields()Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
filterHaving()Sets the HAVING part of the query but ignores empty operands.
filterWhere()Sets the WHERE part of the query but ignores empty operands.
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()Sets the FROM part of the query.
generateSpecificQueryClass()Generate a more specific query class for the provided element type class.
getBehavior()Returns the named behavior object.
getBehaviors()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()Returns table names used in from() indexed by aliases.
groupBy()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()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined for this component.
having()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()Sets the indexBy() property.
init()Initializes the object.
innerJoin()Appends an INNER JOIN part to the query.
isJoined()Returns whether a given table has been joined in this query.
join()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()Appends a LEFT OUTER JOIN part to the query.
level()Narrows the query results based on the {elements}’ level within the structure.
limit()Sets the LIMIT part of the query.
locale()Sets the site property.
localeEnabled()Sets the enabledForSite property.
max()Returns the maximum of the specified column values.
min()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()Disables query cache for this Query.
nth()Executes the query and returns a single row of result at a given offset.
off()Detaches an existing event handler from this component.
offset()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()Attaches an event handler to an event.
one()Return a return value.
orFilterHaving()Adds an additional HAVING condition to the existing one but ignores empty operands.
orFilterWhere()Adds an additional WHERE condition to the existing one but ignores empty operands.
orHaving()Adds an additional HAVING condition to the existing one.
orWhere()Adds an additional WHERE condition to the existing one.
order()Sets the orderBy property.
orderBy()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()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()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()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()Returns the sum of the specified column values.
title()Narrows the query results based on the {elements}’ titles.
toArray()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()Triggers an event.
uid()Narrows the query results based on the {elements}’ UIDs.
union()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()Sets the WHERE part of the query.
with()Causes the query to return matching {elements} eager-loaded with related elements.
withQuery()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

Arguments

  • $method (mixed)
  • $arguments (mixed)

Returns

static

__construct()

MockElementQuery constructor.

View source

__get()

Getter for mock query arguments.

View source

Arguments

  • $name (mixed)

__isset()

Check if a property has been set already.

View source

Arguments

  • $name (mixed)

Returns

boolean

__set()

Setter for mock query arguments.

View source

Arguments

  • $name (mixed)
  • $value (mixed)

all()

Return all the return values.

View source

Arguments

  • $db

Returns

array

generateSpecificQueryClass()

Generate a more specific query class for the provided element type class.

View source

Arguments

  • $elementClass (mixed)

one()

Return a return value.

View source

Arguments

  • $db

Returns

mixed, null

setReturnValues()

Set the return values.

View source

Arguments

Returns

static

Protected Methods

MethodDescription
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()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()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()Extracts the root field names from nested fields.
filterCondition()Removes empty operands from the given query condition.
getUnaliasedColumnsFromSelect()
getUniqueColumns()Returns unique column names excluding duplicates.
isEmpty()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()Normalizes format of ORDER BY data.
normalizeSelect()Normalizes the SELECT columns passed to select() or addSelect().
queryScalar()Queries a scalar value by setting select() first.
resolveFields()Determines which fields can be returned by toArray().
setCommandCache()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

ConstantDescription
CLASS_TEMPLATE_FILE