SubscriptionQuery

Type
Class
Namespace
craft\commerce\elements\db
Inherits
craft\commerce\elements\db\SubscriptionQuery » craft\elements\db\ElementQuery (opens new window) » craft\db\Query (opens new window) » yii\db\Query (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements
craft\elements\db\ElementQueryInterface (opens new window), yii\base\Configurable (opens new window), yii\db\ExpressionInterface (opens new window), yii\db\QueryInterface (opens new window)
Uses traits
craft\base\ClonefixTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\db\QueryTrait (opens new window)
Since
2.0

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

View source (opens new window)

# Public Properties

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

# dateCanceled

Type
mixed
Default value
null

The time the subscription was canceled

View source (opens new window)

# dateExpired

Type
mixed
Default value
null

The date the subscription ceased to be active

View source (opens new window)

# dateSuspended

Type
mixed
Default value
null

The date the subscription ceased to be active

View source (opens new window)

# gatewayId

Type
mixed
Default value
null

The gateway id

View source (opens new window)

# hasStarted

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the subscription has started

View source (opens new window)

# isCanceled

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the subscription is canceled

View source (opens new window)

# isExpired

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the subscription has expired

View source (opens new window)

# isSuspended

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the subscription is suspended

View source (opens new window)

# nextPaymentDate

Type
mixed
Default value
null

Time of next payment for the subscription

View source (opens new window)

# onTrial

Type
boolean (opens new window), null (opens new window)
Default value
null

Whether the subscription is currently on trial.

View source (opens new window)

# orderId

Type
mixed
Default value
null

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

View source (opens new window)

# planId

Type
mixed
Default value
null

The subscription plan id

View source (opens new window)

# reference

Type
mixed
Default value
null

The gateway reference for subscription

View source (opens new window)

# trialDays

Type
mixed
Default value
null

Number of trial days for the subscription

View source (opens new window)

# userId

Type
mixed
Default value
null

The user id of the subscriber

View source (opens new window)

# Protected Properties

# defaultOrderBy

Type
array (opens new window)
Default value
[ 'commerce_subscriptions.dateCreated' => SORT_DESC, ]

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone() (opens new window)
__construct() Constructor
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) 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.
afterPopulate() (opens new window) Performs any post-population processing on elements.
all()
ancestorDist() (opens new window) Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by ancestorOf() (opens new window).
ancestorOf() (opens new window) 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() (opens new window) 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() (opens new window) Causes the query to return matching {elements} eager-loaded with related elements, in addition to the elements that were already specified by with() (opens new window).
anyStatus() Sets the status param to null.
archived() (opens new window) Sets the archived (opens new window) property.
asArray() (opens new window) 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() (opens new window) Returns a list of behaviors that this component should behave as.
cache() (opens new window) 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() (opens new window) Clears the cached result (opens new window).
collect() (opens new window) Executes the query and returns all results as a collection.
column() (opens new window) Executes the query and returns the first column of the result.
count() (opens new window) 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() (opens new window) Converts a found row into an element instance.
criteriaAttributes() (opens new window) Returns the query's criteria attributes.
dateCanceled() Narrows the query results based on the subscriptions’ cancellation date.
dateCreated() (opens new window) 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() (opens new window) Narrows the query results based on the {elements}’ last-updated dates.
descendantDist() (opens new window) Narrows the query results to only {elements} that are up to a certain distance away from the {element} specified by descendantOf() (opens new window).
descendantOf() (opens new window) 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() (opens new window) Narrows the query results to only drafts created by a given user.
draftId() (opens new window) Narrows the query results based on the {elements}’ draft’s ID (from the drafts table).
draftOf() (opens new window) Narrows the query results to only drafts of a given {element}.
drafts() (opens new window) 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.
ensureBehaviors() (opens new window) Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
exists() (opens new window) 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).
fixedOrder() (opens new window) Causes the query results to be returned in the order specified by id() (opens new window).
from() (opens new window) Sets the FROM part of the query.
gatewayId() Narrows the query results based on the gateway, per its ID.
getBehavior() (opens new window) Returns the named behavior object.
getBehaviors() (opens new window) Returns all behaviors attached to this component.
getCacheTags() (opens new window)
getCachedResult() (opens new window) Returns the resulting elements set by setCachedResult() (opens new window), if the criteria params haven’t changed since then.
getCriteria() (opens new window) Returns an array of the current criteria attribute values.
getRawSql() (opens new window) 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() (opens new window) 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.
hasStarted() Narrows the query results to only subscriptions that have started.
having() (opens new window) Sets the HAVING part of the query.
id() (opens new window) Narrows the query results based on the {elements}’ IDs.
ids() (opens new window) Executes the query and returns the IDs of the resulting elements.
ignorePlaceholders() (opens new window) 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() (opens new window).
inReverse() (opens new window) Causes the query results to be returned in reverse order.
indexBy() (opens new window) Sets the indexBy() (opens new window) property.
init() (opens new window) Initializes the object.
innerJoin() (opens new window) 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() (opens new window) Returns whether a given table has been joined in this query.
isSuspended() Narrows the query results to only subscriptions that are suspended.
join() (opens new window) Appends a JOIN part to the query.
leaves() (opens new window) 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() (opens new window) 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.
max() (opens new window) Returns the maximum of the specified column values.
min() (opens new window) Returns the minimum of the specified column values.
nextPaymentDate() Narrows the query results based on the subscriptions’ next payment dates.
nextSiblingOf() (opens new window) 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.
on() (opens new window) Attaches an event handler to an event.
onTrial() Narrows the query results to only subscriptions that are on trial.
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.
orderBy() (opens new window) Determines the order that the {elements} should be returned in. (If empty, defaults to {default-order-by}.)
orderId() Narrows the query results based on the order, per its ID.
pairs() (opens new window) 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.
plan() Narrows the query results based on the subscription plan.
planId() Narrows the query results based on the subscription plans’ IDs.
populate() (opens new window) Converts the raw query results into the format as specified by this query.
positionedAfter() (opens new window) Narrows the query results to only {elements} that are positioned after another {element} in its structure.
positionedBefore() (opens new window) Narrows the query results to only {elements} that are positioned before another {element} in its structure.
preferSites() (opens new window) If unique() (opens new window) is set, this determines which site should be selected when querying multi-site elements.
prepare() (opens new window) Prepares for building SQL.
prepareSubquery() (opens new window) Prepares the element query and returns its subquery (which determines what elements will be returned).
prevSiblingOf() (opens new window) Narrows the query results to only the {element} that comes immediately before another {element} in its structure.
provisionalDrafts() (opens new window) Narrows the query results to only provisional drafts.
ref() (opens new window) Narrows the query results based on a reference string.
reference() Narrows the query results based on the reference.
relatedTo() (opens new window) Narrows the query results to only {elements} that are related to certain other elements.
revisionCreator() (opens new window) Narrows the query results to only revisions created by a given user.
revisionId() (opens new window) Narrows the query results based on the {elements}’ revision’s ID (from the revisions table).
revisionOf() (opens new window) Narrows the query results to only revisions of a given {element}.
revisions() (opens new window) Narrows the query results to only revision {elements}.
rightJoin() (opens new window) Appends a RIGHT OUTER JOIN part to the query.
savedDraftsOnly() (opens new window) Narrows the query results to only unpublished drafts which have been saved after initial creation.
scalar() (opens new window) Returns the query result as a scalar value.
search() (opens new window) Narrows the query results to only {elements} that match a search query.
select() (opens new window) Sets the SELECT part of the query.
setCachedResult() (opens new window) Sets the resulting elements.
siblingOf() (opens new window) Narrows the query results to only {elements} that are siblings of another {element} in its structure.
site() (opens new window) Determines which site(s) the {elements} should be queried in.
siteId() (opens new window) Determines which site(s) the {elements} should be queried in, per the site’s ID.
siteSettingsId() (opens new window) Narrows the query results based on the {elements}’ IDs in the elements_sites table.
slug() (opens new window) Narrows the query results based on the {elements}’ slugs.
status() Narrows the query results based on the {elements}’ statuses.
structureId() (opens new window) Determines which structure data should be joined into the query.
sum() (opens new window) Returns the sum of the specified column values.
title() (opens new window) Narrows the query results based on the {elements}’ titles.
toArray() (opens new window) Converts the model into an array.
trashed() (opens new window) 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() (opens new window) Triggers an event.
uid() (opens new window) Narrows the query results based on the {elements}’ UIDs.
union() (opens new window) Appends a SQL statement using UNION operator.
unique() (opens new window) Determines whether only elements with unique IDs should be returned by the query.
uri() (opens new window) 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() (opens new window) Sets the WHERE part of the query.
with() (opens new window) Causes the query to return matching {elements} eager-loaded with related elements.
withQuery() (opens new window) Prepends a SQL statement using WITH syntax.
withStructure() (opens new window) Explicitly determines whether the query should join in the structure data.

# __construct()

Constructor

View source (opens new window)

Arguments

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

Throws

# all()

View source (opens new window)

Arguments

  • $db

Returns

craft\commerce\elements\Subscription[], array (opens new window)

# anyStatus()

DEPRECATED

Deprecated in 4.0.0. status(null) should be used instead.

Sets the status param to null.

View source (opens new window)

Returns

self – Self reference

# 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 (opens new window)

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 (opens new window)

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 (opens new window)

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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# hasStarted()

Narrows the query results to only subscriptions that have started.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# isCanceled()

Narrows the query results to only subscriptions that are canceled.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# isExpired()

Narrows the query results to only subscriptions that have expired.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# isSuspended()

Narrows the query results to only subscriptions that are suspended.

View source (opens new window)

Arguments

Returns

static – Self reference

Example

{# Fetch suspended subscriptions #}
{% set {elements-var} = {twig-method}
  .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 (opens new window)

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() %}

# nth()

View source (opens new window)

Arguments

  • $n
  • $db = null

Returns

craft\commerce\elements\Subscription, array (opens new window), false (opens new window)

# onTrial()

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

View source (opens new window)

Arguments

Returns

static – Self reference

Example

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

# one()

View source (opens new window)

Arguments

  • $db

Returns

craft\commerce\elements\Subscription, array (opens new window), false (opens new window)

# 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 (opens new window)

Arguments

  • $value (mixed) – The property value

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 (opens new window)

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 (opens new window)

Arguments

  • $value (mixed) – The property value

Returns

static – Self reference

# reference()

Narrows the query results based on the reference.

View source (opens new window)

Arguments

  • $value (mixed) – The property value

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 (opens new window)

Arguments

  • $value

Example

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

# trialDays()

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

View source (opens new window)

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 (opens new window) object for a user account represented by the object.

View source (opens new window)

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 (opens new window)

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() (opens new window) 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() (opens new window) 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() (opens new window) 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() (opens new window) 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() (opens new window) 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 (opens new window). The subselect’s Query object being prepared is available via subQuery (opens new window). 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.

# 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

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