SubscriptionQuery

Type
Class
Namespace
craft\commerce\elements\db
Inherits
craft\commerce\elements\db\SubscriptionQuery » 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
2.0

SubscriptionQuery represents a SELECT SQL statement for subscriptions in a way that is independent of DBMS.

View source

# Public Properties

Property Description
ancestorDist integer, null – The maximum number of levels that results may be separated from ancestorOf().
ancestorOf integer, craft\base\ElementInterface, null – The element (or its ID) that results must be an ancestor of.
archived boolean – Whether to return only archived elements.
asArray boolean – Whether to return each element as an array.
behaviors yii\base\Behavior – List of behaviors attached to this component
cachedResult craft\base\ElementInterface, null – $elements The resulting elements, or null if setCachedResult() was never called or the criteria has changed
contentTable string, null – The content table that will be joined by this query.
criteria array
customFields craft\base\FieldInterface, null – The fields that may be involved in this query.
dateCanceled DateTime – The time the subscription was canceled
dateCreated mixed – When the resulting elements must have been created.
dateExpired DateTime – The date the subscription ceased to be active
dateSuspended DateTime – The date the subscription ceased to be active
dateUpdated mixed – When the resulting elements must have been last updated.
descendantDist integer, null – The maximum number of levels that results may be separated from descendantOf().
descendantOf integer, craft\base\ElementInterface, null – The element (or its ID) that results must be a descendant of.
distinct boolean – Whether to select distinct rows of data only.
draftCreator integer, null – The drafts’ creator ID
draftId integer, null – The ID of the draft to return (from the drafts table)
draftOf integer, false, null – The source element ID that drafts should be returned for.
drafts boolean – Whether draft elements should be returned.
elementType string, null – The name of the craft\base\ElementInterface class.
emulateExecution boolean – Whether to emulate the actual query execution, returning empty or false results.
enabledForSite boolean – Whether the elements must be enabled for the chosen site.
fixedOrder boolean – Whether results should be returned in the order specified by id().
from array – The table(s) to be selected from.
gatewayId integer, integer[] – The gateway id
groupBy array – How to group the query results.
hasDescendants boolean, null – Whether the resulting elements must have descendants.
hasStarted boolean – Whether the subscription has started
having string, array, yii\db\ExpressionInterface – The condition to be applied in the GROUP BY clause.
id integer, integer[], false, null – The element ID(s).
ignorePlaceholders boolean – Whether to ignore placeholder elements when populating the results.
inReverse boolean – Whether the results should be queried in reverse.
indexBy string, callable – The name of the column by which the query results should be indexed by.
isCanceled boolean – Whether the subscription is canceled
isExpired boolean – Whether the subscription has expired
isSuspended boolean – Whether the subscription is suspended
iterator ArrayIterator
join array – How to join with other tables.
leaves boolean – Whether the elements must be “leaves” in the structure.
level mixed – The element’s level within the structure
limit integer, yii\db\ExpressionInterface – Maximum number of records to be returned.
nextPaymentDate DateTime – Time of next payment for the subscription
nextSiblingOf integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the next sibling of.
offset integer, yii\db\ExpressionInterface – Zero-based offset from where the records are to be returned.
onTrial boolean – Whether the subscription is currently on trial.
orderBy array – How to sort the query results.
orderId integer, integer[] – The id of the order that the license must be a part of.
params array – List of query parameter values indexed by parameter placeholders.
planId integer, integer[] – The subscription plan id
positionedAfter integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned after.
positionedBefore integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be positioned before.
preferSites array, null – Determines which site should be selected when querying multi-site elements.
prevSiblingOf integer, craft\base\ElementInterface, null – The element (or its ID) that the result must be the previous sibling of.
query craft\db\Query, null – The query object created by prepare()
queryCacheDependency yii\caching\Dependency – The dependency to be associated with the cached query result for this query
queryCacheDuration integer, true – The default number of seconds that query results can remain valid in cache.
rawSql string
ref string, string[], null – The reference code(s) used to identify the element(s).
reference string, string[] – The gateway reference for subscription
relatedTo integer, array, craft\base\ElementInterface, null – The element relation criteria.
revisionCreator integer, null – The revisions’ creator ID
revisionId integer, null – The ID of the revision to return (from the revisions table)
revisionOf integer, null – The source element ID that revisions should be returned for
revisions boolean – Whether revision elements should be returned.
search string, array, craft\search\SearchQuery, null – The search term to filter the resulting elements by.
select array – The columns being selected.
selectOption string – Additional option that should be appended to the 'SELECT' keyword.
siblingOf integer, craft\base\ElementInterface, null – The element (or its ID) that the results must be a sibling of.
siteId integer, integer[], string, null – The site ID(s) that the elements should be returned in, or '*' if elements should be returned in all supported sites.
slug string, string[], null – The slug that resulting elements must have.
status string, string[], null – The status(es) that the resulting elements must have.
structureId integer, false, null – The structure ID that should be used to join in the structureelements table.
subQuery craft\db\Query, null – The subselect’s query object created by prepare()
tablesUsedInFrom string[] – Table names indexed by aliases
title string, string[], null – The title that resulting elements must have.
trashed boolean, null – Whether to return trashed (soft-deleted) elements.
trialDays integer, integer[] – Number of trial days for the subscription
uid string, string[], null – The element UID(s).
union array – This is used to construct the UNION clause(s) in a SQL statement.
unique boolean – Whether only elements with unique IDs should be returned by the query.
uri string, string[], null – The URI that the resulting element must have.
userId integer, integer[] – The user id of the subscriber
where string, array, yii\db\ExpressionInterface – Query condition.
with string, array, null – The eager-loading declaration.
withQueries array – This is used to construct the WITH section in a SQL query.
withStructure boolean, null – Whether element structure data should automatically be left-joined into the query.

# dateCanceled

Type
DateTime

The time the subscription was canceled

View source

# dateExpired

Type
DateTime

The date the subscription ceased to be active

View source

# dateSuspended

Type
DateTime

The date the subscription ceased to be active

View source

# gatewayId

Type
integer, integer[]

The gateway id

View source

# hasStarted

Type
boolean

Whether the subscription has started

View source

# isCanceled

Type
boolean

Whether the subscription is canceled

View source

# isExpired

Type
boolean

Whether the subscription has expired

View source

# isSuspended

Type
boolean

Whether the subscription is suspended

View source

# nextPaymentDate

Type
DateTime

Time of next payment for the subscription

View source

# onTrial

Type
boolean

Whether the subscription is currently on trial.

View source

# orderId

Type
integer, integer[]

The id of the order that the license must be a part of.

View source

# planId

Type
integer, integer[]

The subscription plan id

View source

# reference

Type
string, string[]

The gateway reference for subscription

View source

# trialDays

Type
integer, integer[]

Number of trial days for the subscription

View source

# userId

Type
integer, integer[]

The user id of the subscriber

View source

# Protected Properties

Property Description
defaultOrderBy array

# defaultOrderBy

Type
array

View source

# 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() 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.
all() Executes the query and returns all results as an array.
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}.
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.
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() Clears out the status() and enabledForSite() parameters.
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.
criteriaAttributes() Returns the query's criteria attributes.
dateCanceled() Narrows the query results based on the subscriptions’ cancellation date.
dateCreated() Narrows the query results based on the {elements}’ creation dates.
dateExpired() Narrows the query results based on the subscriptions’ expiration date.
dateSuspended() Narrows the query results based on the subscriptions’ suspension date.
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}.
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.
gatewayId() Narrows the query results based on the gateway, per its ID.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
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.
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.
hasStarted() Narrows the query results to only subscriptions that have started.
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.
isCanceled() Narrows the query results to only subscriptions that are canceled.
isExpired() Narrows the query results to only subscriptions that have expired.
isJoined() Returns whether a given table has been joined in this query.
isSuspended() Narrows the query results to only subscriptions that are suspended.
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 \craft\elements\db\$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.
nextPaymentDate() Narrows the query results based on the subscriptions’ next payment dates.
nextSiblingOf() Narrows the query results to only the {element} that comes immediately after another {element}.
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.
onTrial() Narrows the query results to only subscriptions that are on trial.
one() Executes the query and returns a single row of result.
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.
orderId() Narrows the query results based on the order, per its ID.
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.
plan() Narrows the query results based on the subscription plan.
planId() Narrows the query results based on the subscription plans’ IDs.
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}.
positionedBefore() Narrows the query results to only {elements} that are positioned before another {element}.
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}.
ref() Narrows the query results based on a reference string.
reference() Narrows the query results based on the reference.
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.
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.
siblingOf() Narrows the query results to only {elements} that are siblings of another {element}.
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.
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.
trialDays() Narrows the query results based on the number of trial days.
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.
user() Narrows the query results based on the subscriptions’ user accounts.
userId() Narrows the query results based on the subscriptions’ user accounts’ IDs.
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.

# __construct()

Constructor

View source

Arguments

  • $elementType (string) – The element type class associated with this query
  • $config (array) – 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

Arguments

  • $name (string) – The property name or the event name
  • $value (mixed) – The property value

Throws

# anyStatus()

Clears out the status() and enabledForSite() parameters.

View source

Returns

static – Self reference

Example

{# Fetch all {elements}, regardless of status #}
{% set {elements-var} = {twig-method}
    .anyStatus()
    .all() %}

# dateCanceled()

Narrows the query results based on the subscriptions’ cancellation date.

Possible values include:

Value Fetches {elements}…
'>= 2018-04-01' that were canceled on or after 2018-04-01.
'< 2018-05-01' that were canceled before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01'] that were canceled between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} that were canceled recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
    .dateCanceled(">= #{aWeekAgo}")
    .all() %}

# dateExpired()

Narrows the query results based on the subscriptions’ expiration date.

Possible values include:

Value Fetches {elements}…
'>= 2018-04-01' that expired on or after 2018-04-01.
'< 2018-05-01' that expired before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01'] that expired between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} that expired recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
    .dateExpired(">= #{aWeekAgo}")
    .all() %}

# dateSuspended()

Narrows the query results based on the subscriptions’ suspension date.

Possible values include:

Value Fetches {elements}…
'>= 2018-04-01' that were suspended on or after 2018-04-01.
'< 2018-05-01' that were suspended before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01'] that were suspended between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} that were suspended recently #}
{% set aWeekAgo = date('7 days ago')|atom %}

{% set {elements-var} = {twig-method}
    .dateSuspended(">= #{aWeekAgo}")
    .all() %}

# gatewayId()

Narrows the query results based on the gateway, per its ID.

Possible values include:

Value Fetches {elements}…
1 with a gateway with an ID of 1.
'not 1' not with a gateway with an ID of 1.
[1, 2] with a gateway with an ID of 1 or 2.
['not', 1, 2] not with a gateway with an ID of 1 or 2.

View source

Arguments

Returns

static – Self reference

# hasStarted()

Narrows the query results to only subscriptions that have started.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

{# Fetch started subscriptions #}
{% set {elements-var} = {twig-function}
    .hasStarted()
    .all() %}

# isCanceled()

Narrows the query results to only subscriptions that are canceled.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

{# Fetch canceled subscriptions #}
{% set {elements-var} = {twig-function}
    .isCanceled()
    .all() %}

# isExpired()

Narrows the query results to only subscriptions that have expired.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

{# Fetch expired subscriptions #}
{% set {elements-var} = {twig-function}
    .isExpired()
    .all() %}

# isSuspended()

Narrows the query results to only subscriptions that are suspended.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

{# Fetch suspended subscriptions #}
{% set {elements-var} = {twig-function}
    .isSuspended()
    .all() %}

# nextPaymentDate()

Narrows the query results based on the subscriptions’ next payment dates.

Possible values include:

Value Fetches {elements}…
'>= 2018-04-01' with a next payment on or after 2018-04-01.
'< 2018-05-01' with a next payment before 2018-05-01
['and', '>= 2018-04-04', '< 2018-05-01'] with a next payment between 2018-04-01 and 2018-05-01.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch {elements} with a payment due soon #}
{% set aWeekFromNow = date('+7 days')|atom %}

{% set {elements-var} = {twig-method}
    .nextPaymentDate("< #{aWeekFromNow}")
    .all() %}

# onTrial()

Narrows the query results to only subscriptions that are on trial.

View source

Arguments

  • $value (boolean) – The property value

Returns

static – Self reference

Example

{# Fetch trialed subscriptions #}
{% set {elements-var} = {twig-function}
    .onTrial()
    .all() %}

# orderId()

Narrows the query results based on the order, per its ID.

Possible values include:

Value Fetches {elements}…
1 with an order with an ID of 1.
'not 1' not with an order with an ID of 1.
[1, 2] with an order with an ID of 1 or 2.
['not', 1, 2] not with an order with an ID of 1 or 2.

View source

Arguments

Returns

static – Self reference

# plan()

Narrows the query results based on the subscription plan.

Possible values include:

Value Fetches {elements}…
'foo' for a plan with a handle of foo.
['foo', 'bar'] for plans with a handle of foo or bar.
a Plan object for a plan represented by the object.

View source

Arguments

  • $value (mixed)

Returns

static – Self reference

Example

{# Fetch Supporter plan subscriptions #}
{% set {elements-var} = {twig-method}
    .plan('supporter')
    .all() %}

# planId()

Narrows the query results based on the subscription plans’ IDs.

Possible values include:

Value Fetches {elements}…
1 for a plan with an ID of 1.
[1, 2] for plans with an ID of 1 or 2.
['not', 1, 2] for plans not with an ID of 1 or 2.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# reference()

Narrows the query results based on the reference.

View source

Arguments

Returns

static – Self reference

# status()

Narrows the query results based on the {elements}’ statuses.

Possible values include:

Value Fetches {elements}…
'active' (default) that are active.
'expired' that have expired.

View source

Arguments

  • $value

Example

{# Fetch expired {elements} #}
{% set {elements-var} = {twig-function}
    .status('expired')
    .all() %}

# trialDays()

Narrows the query results based on the number of trial days.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# user()

Narrows the query results based on the subscriptions’ user accounts.

Possible values include:

Value Fetches {elements}…
'foo' for a user account with a username of foo
['foo', 'bar'] for user accounts with a username of foo or bar.
a User object for a user account represented by the object.

View source

Arguments

  • $value (mixed)

Returns

static – Self reference

Example

{# Fetch the current user's subscriptions #}
{% set {elements-var} = {twig-method}
    .user(currentUser)
    .all() %}

# userId()

Narrows the query results based on the subscriptions’ user accounts’ IDs.

Possible values include:

Value Fetches {elements}…
1 for a user account with an ID of 1.
[1, 2] for user accounts with an ID of 1 or 2.
['not', 1, 2] for user accounts not with an ID of 1 or 2.

View source

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

Example

{# Fetch the current user's subscriptions #}
{% set {elements-var} = {twig-method}
    .userId(currentUser.id)
    .all() %}

# 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.
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.

# 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

Returns

boolean – 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.

# 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' => 1];
        default:
            return parent::statusCondition($status);
    }

View source

Arguments

Returns

string, array, yii\db\ExpressionInterface, false, null – The status condition, or false if $status is an unsupported status