EntryQuery
- Type
- Class
- Namespace
- craft\elements\db
- Inherits
- craft\elements\db\EntryQuery » 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.0.0
EntryQuery represents a SELECT SQL statement for entries in a way that is independent of DBMS.
View source (opens new window)
# Public Properties
# after
- Type
- string (opens new window), array (opens new window), DateTime (opens new window)
- Default value
null
The minimum Post Date that resulting entries can have.
# authorGroup
- Type
- string (opens new window), string (opens new window)[], craft\models\UserGroup, null (opens new window)
- Default value
null
The user group(s) that resulting entries’ authors must belong to
View source (opens new window)
# authorGroupId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The user group ID(s) that the resulting entries’ authors must be in.
# authorId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The user ID(s) that the resulting entries’ authors must have.
View source (opens new window)
# before
- Type
- string (opens new window), array (opens new window), DateTime (opens new window)
- Default value
null
The maximum Post Date that resulting entries can have.
# editable
- Type
- boolean (opens new window)
- Default value
false
Whether to only return entries that the user has permission to edit.
View source (opens new window)
# expiryDate
- Type
mixed
- Default value
null
The Expiry Date that the resulting entries must have.
View source (opens new window)
# postDate
- Type
mixed
- Default value
null
The Post Date that the resulting entries must have.
# section
- Type
- string (opens new window), string (opens new window)[], craft\models\Section, null (opens new window)
- Default value
null
The section(s) that resulting entries must belong to
View source (opens new window)
# sectionId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The section ID(s) that the resulting entries must be in.
# type
- Type
- string (opens new window), string (opens new window)[], craft\models\EntryType, null (opens new window)
- Default value
null
The entry type(s) that resulting entries must have
View source (opens new window)
# typeId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The entry type ID(s) that the resulting entries must have.
# Protected Properties
Property | Description |
---|---|
defaultOrderBy | array (opens new window) – The default orderBy() (opens new window) value to use if orderBy() (opens new window) is empty but not null. |
# defaultOrderBy
- Type
- array (opens new window)
- Default value
[ 'entries.postDate' => SORT_DESC, ]
The default orderBy() (opens new window) value to use if orderBy() (opens new window) is empty but not null.
View source (opens new window)
# Public Methods
Method | Description |
---|---|
__call() | Calls the named method which is not a class method. |
__clone() | |
__construct() | Constructor |
__get() | Returns the value of a component property. |
__isset() | Checks if a property is set, i.e. defined and not null. |
__set() | Sets the value of a component property. |
__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. |
after() | Narrows the query results to only entries that were posted on or after a certain date. |
afterPopulate() | Performs any post-population processing on elements. |
all() | |
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. |
authorGroup() | Narrows the query results based on the user group the entries’ authors belong to. |
authorGroupId() | Narrows the query results based on the user group the entries’ authors belong to, per the groups’ IDs. |
authorId() | Narrows the query results based on the entries’ authors. |
average() (opens new window) | Returns the average of the specified column values. |
batch() (opens new window) | Starts a batch query. |
before() | Narrows the query results to only entries that were posted before a certain date. |
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. |
editable() | Sets the editable property. |
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. |
expiryDate() | Narrows the query results based on the entries’ expiry dates. |
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. |
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) | Determines the number of {elements} that should be returned. |
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() | |
off() (opens new window) | Detaches an existing event handler from this component. |
offset() (opens new window) | Determines how many {elements} should be skipped in the results. |
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() | |
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) | Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by} .) |
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. |
postDate() | Narrows the query results based on the entries’ post dates. |
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. |
section() | Narrows the query results based on the sections the entries belong to. |
sectionId() | Narrows the query results based on the sections the entries belong to, per the sections’ IDs. |
select() (opens new window) | Sets the SELECT part of the query. |
setCachedResult() | Sets the resulting elements. |
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 entries’ 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. |
type() | Narrows the query results based on the entries’ entry types. |
typeId() | Narrows the query results based on the entries’ entry types, per the types’ IDs. |
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. |
# __construct()
Constructor
View source (opens new window)
Arguments
$elementType
(string (opens new window)) – The element type class associated with this query$config
(array (opens new window)) – Configurations to be applied to the newly created query object
# __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;
.
View source (opens new window)
Arguments
$name
(string (opens new window)) – The property name or the event name$value
(mixed
) – The property value
Throws
- yii\base\UnknownPropertyException (opens new window)
if the property is not defined - yii\base\InvalidCallException (opens new window)
if the property is read-only.
# after()
Narrows the query results to only entries that were posted on or after a certain date.
Possible values include:
Value | Fetches entries… |
---|---|
'2018-04-01' | that were posted after 2018-04-01. |
a DateTime (opens new window) object | that were posted after the date represented by the object. |
View source (opens new window)
Arguments
$value
(string (opens new window), DateTime (opens new window)) – The property value
Returns
static
– Self reference
# all()
View source (opens new window)
Arguments
$db
Returns
craft\elements\Entry[], array (opens new window) –
# authorGroup()
Narrows the query results based on the user group the entries’ authors belong to.
Possible values include:
Value | Fetches entries… |
---|---|
'foo' | with an author in a group with a handle of foo . |
'not foo' | not with an author in a group with a handle of foo . |
['foo', 'bar'] | with an author in a group with a handle of foo or bar . |
['not', 'foo', 'bar'] | not with an author in a group with a handle of foo or bar . |
a UserGroup object | with an author in a group represented by the object. |
View source (opens new window)
Arguments
$value
(string (opens new window), string (opens new window)[], craft\models\UserGroup, null (opens new window)) – The property value
Returns
static
– Self reference
# authorGroupId()
Narrows the query results based on the user group the entries’ authors belong to, per the groups’ IDs.
Possible values include:
Value | Fetches entries… |
---|---|
1 | with an author in a group with an ID of 1. |
'not 1' | not with an author in a group with an ID of 1. |
[1, 2] | with an author in a group with an ID of 1 or 2. |
['not', 1, 2] | not with an author in a group with an ID of 1 or 2. |
View source (opens new window)
Arguments
$value
(integer (opens new window), integer (opens new window)[], null (opens new window)) – The property value
Returns
static
– Self reference
# authorId()
Narrows the query results based on the entries’ authors.
Possible values include:
Value | Fetches entries… |
---|---|
1 | with an author with an ID of 1. |
'not 1' | not with an author with an ID of 1. |
[1, 2] | with an author with an ID of 1 or 2. |
['not', 1, 2] | not with an author with an ID of 1 or 2. |
View source (opens new window)
Arguments
$value
(integer (opens new window), integer (opens new window)[], null (opens new window)) – The property value
Returns
static
– Self reference
# before()
Narrows the query results to only entries that were posted before a certain date.
Possible values include:
Value | Fetches entries… |
---|---|
'2018-04-01' | that were posted before 2018-04-01. |
a DateTime (opens new window) object | that were posted before the date represented by the object. |
View source (opens new window)
Arguments
$value
(string (opens new window), DateTime (opens new window)) – The property value
Returns
static
– Self reference
# editable()
Sets the editable property.
View source (opens new window)
Arguments
$value
(boolean (opens new window)) – The property value (defaults to true)
Returns
static
– Self reference
# expiryDate()
Narrows the query results based on the entries’ expiry dates.
Possible values include:
Value | Fetches entries… |
---|---|
':empty:' | that don’t have an expiry date. |
':notempty:' | that have an expiry date. |
'>= 2020-04-01' | that will expire on or after 2020-04-01. |
'< 2020-05-01' | that will expire before 2020-05-01 |
['and', '>= 2020-04-04', '< 2020-05-01'] | that will expire between 2020-04-01 and 2020-05-01. |
View source (opens new window)
Arguments
$value
(mixed
) – The property value
Returns
static
– Self reference
# init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
View source (opens new window)
# nth()
View source (opens new window)
Arguments
$n
$db = null
Returns
craft\elements\Entry, array (opens new window), null (opens new window) –
# one()
View source (opens new window)
Arguments
$db
Returns
craft\elements\Entry, array (opens new window), null (opens new window) –
# postDate()
Narrows the query results based on the entries’ post dates.
Possible values include:
Value | Fetches entries… |
---|---|
'>= 2018-04-01' | that were posted on or after 2018-04-01. |
'< 2018-05-01' | that were posted before 2018-05-01 |
['and', '>= 2018-04-04', '< 2018-05-01'] | that were posted between 2018-04-01 and 2018-05-01. |
View source (opens new window)
Arguments
$value
(mixed
) – The property value
Returns
static
– Self reference
# section()
Narrows the query results based on the sections the entries belong to.
Possible values include:
Value | Fetches entries… |
---|---|
'foo' | in a section with a handle of foo . |
'not foo' | not in a section with a handle of foo . |
['foo', 'bar'] | in a section with a handle of foo or bar . |
['not', 'foo', 'bar'] | not in a section with a handle of foo or bar . |
a Section object | in a section represented by the object. |
View source (opens new window)
Arguments
$value
(string (opens new window), string (opens new window)[], craft\models\Section, craft\models\Section[], null (opens new window)) – The property value
Returns
static
– Self reference
# sectionId()
Narrows the query results based on the sections the entries belong to, per the sections’ IDs.
Possible values include:
Value | Fetches entries… |
---|---|
1 | in a section with an ID of 1. |
'not 1' | not in a section with an ID of 1. |
[1, 2] | in a section with an ID of 1 or 2. |
['not', 1, 2] | not in a section with an ID of 1 or 2. |
View source (opens new window)
Arguments
$value
(integer (opens new window), integer (opens new window)[], null (opens new window)) – The property value
Returns
static
– Self reference
# status()
Narrows the query results based on the entries’ statuses.
Possible values include:
Value | Fetches entries… |
---|---|
'live' (default) | that are live. |
'pending' | that are pending (enabled with a Post Date in the future). |
'expired' | that are expired (enabled with an Expiry Date in the past). |
'disabled' | that are disabled. |
['live', 'pending'] | that are live or pending. |
['not', 'live', 'pending'] | that are not live or pending. |
View source (opens new window)
Arguments
$value
# type()
Narrows the query results based on the entries’ entry types.
Possible values include:
Value | Fetches entries… |
---|---|
'foo' | of a type with a handle of foo . |
'not foo' | not of a type with a handle of foo . |
['foo', 'bar'] | of a type with a handle of foo or bar . |
['not', 'foo', 'bar'] | not of a type with a handle of foo or bar . |
an EntryType object | of a type represented by the object. |
View source (opens new window)
Arguments
$value
(string (opens new window), string (opens new window)[], craft\models\EntryType, craft\models\EntryType[], null (opens new window)) – The property value
Returns
static
– Self reference
# typeId()
Narrows the query results based on the entries’ entry types, per the types’ IDs.
Possible values include:
Value | Fetches entries… |
---|---|
1 | of a type with an ID of 1. |
'not 1' | not of a type with an ID of 1. |
[1, 2] | of a type with an ID of 1 or 2. |
['not', 1, 2] | not of a type with an ID of 1 or 2. |
View source (opens new window)
Arguments
$value
(integer (opens new window), integer (opens new window)[], null (opens new window)) – The property value
Returns
static
– Self reference
# 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. |
# beforePrepare()
This method is called at the beginning of preparing an element query for the query builder.
The main Query object being prepared for the query builder is available via query. The subselect’s Query object being prepared is available via subQuery. The role of the subselect query is to apply conditions to the query and narrow the result set down to just the elements that should actually be returned. The role of the main query is to join in any tables that should be included in the results, and select all of the columns that should be included in the results.
View source (opens new window)
Returns
boolean (opens new window) – Whether the query should be prepared and returned to the query builder. If false, the query will be cancelled and no results will be returned.
# cacheTags()
- Since
- 3.5.0
Returns any cache invalidation tags that caches involving this element query should use as dependencies.
Use the most specific tag(s) possible, to reduce the likelihood of pointless cache clearing.
When elements are created/updated/deleted, their craft\base\ElementInterface::getCacheTags() method will be called, and any caches that have those tags listed as dependencies will be invalidated.
View source (opens new window)
Returns
# statusCondition()
Returns the condition that should be applied to the element query for a given status.
For example, if you support a status called “pending”, which maps back to a pending
database column that will
either be 0 or 1, this method could do this:
protected function statusCondition($status)
{
switch ($status) {
case 'pending':
return ['mytable.pending' => true];
default:
return parent::statusCondition($status);
}
View source (opens new window)
Arguments
$status
(string (opens new window)) – The status
Returns
string (opens new window), array (opens new window), yii\db\ExpressionInterface (opens new window), false (opens new window), null (opens new window) – The status condition, or false if $status is an unsupported status