Subscription

Type
Class
Namespace
craft\commerce\elements
Inherits
craft\commerce\elements\Subscription » craft\base\Element » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ElementInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\ElementTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Subscription model.

View source

# Public Properties

Property Description
_subscriptionData array – The subscription data from gateway
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
allPayments craft\commerce\models\subscriptions\SubscriptionPayment[]
alternativePlans craft\commerce\base\Plan[]
ancestors craft\elements\db\ElementQueryInterface, craft\base\ElementInterface
archived boolean – Whether the element is archived
attributes array – Attribute values (name => value).
awaitingFieldValues boolean – Whether the element is still awaiting its custom field values
behaviors yii\base\Behavior – List of behaviors attached to this component
billingIssueDescription mixed
billingIssueResolveFormHtml mixed
children craft\elements\db\ElementQueryInterface, craft\base\ElementInterface
contentId integer, null – The element’s content row ID
contentTable string
cpEditUrl string, null
currentRevision craft\base\ElementInterface, null
dateCanceled DateTime – Time when subscription was canceled
dateCreated DateTime, null – The date that the element was created
dateDeleted DateTime, null – The date that the element was trashed
dateExpired DateTime – Time when subscription expired
dateSuspended DateTime – Time when subscription was put on hold
dateUpdated DateTime, null – The date that the element was last updated
descendants craft\elements\db\ElementQueryInterface, craft\base\ElementInterface
dirtyAttributes string[]
dirtyFields string[]
draftId integer, null – The ID of the draft’s row in the drafts table
duplicateOf craft\base\ElementInterface, null – The element that this element is being duplicated by.
editorHtml string – The HTML for the editor HUD
enabled boolean – Whether the element is enabled
enabledForSite boolean, null – Whether the element is enabled for the given site.
errors array – Errors for all attributes or the specified attribute.
fieldColumnPrefix string
fieldContext string
fieldLayout craft\models\FieldLayout, null
fieldLayoutId integer, null – The element’s field layout ID
fieldParamNamespace string, null – The field param namespace
fieldValues array – The field values (handle => value)
firstErrors array – The first errors.
gateway craft\commerce\base\SubscriptionGatewayInterface
gatewayId integer – Gateway id
gqlTypeName string
hardDelete boolean – Whether the element is being hard-deleted.
hasBillingIssues mixed
hasDescendants boolean
hasFreshContent boolean – Whether the element’s content is fresh
hasStarted boolean – Whether the subscription has started
id integer, null – The element’s ID
isCanceled boolean – Whether the subscription is canceled
isDraft boolean
isEditable boolean
isExpired boolean – Whether the subscription has expired
isHomepage boolean
isOnTrial boolean
isRevision boolean
isSuspended boolean – Whether the subscription is on hold due to payment issues
isUnsavedDraft boolean
iterator ArrayIterator – An iterator for traversing the items in the list.
level integer, null – The element’s level within its structure
lft integer, null – The element’s left position within its structure
link \Twig\Markup, null
name null, string
newSiteIds integer[] – The site IDs that the element was just propagated to for the first time.
next craft\base\ElementInterface, null
nextPaymentAmount string
nextPaymentDate DateTime – Date of next payment
nextSibling craft\base\ElementInterface, null
order null, craft\commerce\elements\Order
orderEditUrl string
orderId integer, null – Order id
parent craft\base\ElementInterface, null
plan craft\commerce\base\PlanInterface
planId integer – Plan id
planName string
prev craft\base\ElementInterface, null
prevSibling craft\base\ElementInterface, null
previewTargets array
previewing boolean – Whether the element is currently being previewed.
propagateAll boolean – Whether all element attributes should be propagated across all its supported sites, even if that means overwriting existing site-specific values.
propagating boolean – Whether the element is being saved in the context of propagating another site's version of the element.
ref string, null
reference string – Subscription reference on the gateway
resaving boolean – Whether the element is being resaved by a ResaveElement job or a resave console command.
revisionId integer – The ID of the revision’s row in the revisions table
rgt integer, null – The element’s right position within its structure
root integer, null – The element’s structure’s root ID
route mixed – The route that the request should use, or null if no special action should be taken
scenario string – The scenario that this model is in.
searchScore integer, null – The element’s search score, if the craft\elements\db\ElementQuery::search() parameter was used when querying for the element
serializedFieldValues array
siblings craft\elements\db\ElementQueryInterface, craft\base\ElementInterface
site craft\models\Site
siteId integer, null – The site ID the element is associated with
slug string, null – The element’s slug
sourceId integer, null
sourceUid string
status string, null
structureId integer, null – The element’s structure ID
subscriber craft\elements\User
subscriptionData array
supportedSites integer[], array
tempId string, null – The element’s temporary ID (only used if the element's URI format contains {id})
title string, null – The element’s title
totalDescendants integer
trashed boolean – Whether the element has been soft-deleted.
trialDays integer – Trial days granted
trialExpires DateTime
uiLabel string
uid string, null – The element’s UID
uri string, null – The element’s URI
uriFormat string, null
url string, null
userId integer – User id
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# _subscriptionData

Type
array

The subscription data from gateway

View source

# allPayments

Type
craft\commerce\models\subscriptions\SubscriptionPayment[]
Access
Read-only

View source

# alternativePlans

Type
craft\commerce\base\Plan[]
Access
Read-only

View source

# billingIssueDescription

Type
mixed
Access
Read-only

View source

# billingIssueResolveFormHtml

Type
mixed
Access
Read-only

View source

# cpEditUrl

Type
string, null
Access
Read-only

View source

# dateCanceled

Type
DateTime

Time when subscription was canceled

View source

# dateExpired

Type
DateTime

Time when subscription expired

View source

# dateSuspended

Type
DateTime

Time when subscription was put on hold

View source

# fieldLayout

Type
craft\models\FieldLayout, null
Access
Read-only

View source

# gateway

Type
craft\commerce\base\SubscriptionGatewayInterface
Access
Read-only

View source

# gatewayId

Type
integer

Gateway id

View source

# hasBillingIssues

Type
mixed
Access
Read-only

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

# isOnTrial

Type
boolean
Access
Read-only

View source

# isSuspended

Type
boolean

Whether the subscription is on hold due to payment issues

View source

# name

Type
null, string
Access
Read-only

View source

# nextPaymentAmount

Type
string
Access
Read-only

View source

# nextPaymentDate

Type
DateTime

Date of next payment

View source

# order

Type
null, craft\commerce\elements\Order
Access
Read-only

View source

# orderEditUrl

Type
string
Access
Read-only

View source

# orderId

Type
integer, null

Order id

View source

# plan

Type
craft\commerce\base\PlanInterface
Access
Read-only

View source

# planId

Type
integer

Plan id

View source

# planName

Type
string
Access
Read-only

View source

# reference

Type
string

Subscription reference on the gateway

View source

# status

Type
string, null
Access
Read-only

View source

# subscriber

Type
craft\elements\User
Access
Read-only

View source

# subscriptionData

Type
array

View source

# trialDays

Type
integer

Trial days granted

View source

# trialExpires

Type
DateTime
Access
Read-only

View source

# userId

Type
integer

User id

View source

# Protected Properties

Property Description
revisionCreatorId string, null – Revision creator ID to be saved
revisionNotes string, null – Revision notes to be saved

# 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.
__set() Sets the value of a component property.
__toString()
__unset() Sets a component property to be null.
actions() Returns the available element actions for a given source.
activeAttributes() Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterDelete() Performs actions after an element is deleted.
afterMoveInStructure() Performs actions after an element is moved within a structure.
afterPropagate() Performs actions after an element is fully saved and propagated to other sites.
afterRestore() Performs actions after an element is restored.
afterSave() Performs actions after an element is saved.
afterValidate() This method is invoked after validation ends.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
attributeHints() Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
beforeDelete() Performs actions before an element is deleted.
beforeMoveInStructure() Performs actions before an element is moved within a structure.
beforeRestore() Performs actions before an element is restored.
beforeSave() Performs actions before an element is saved.
beforeValidate() This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() Returns a value indicating whether a property can be read.
canReactivate() Returns whether this subscription can be reactivated.
canSetProperty() Returns a value indicating whether a property can be set.
className() Returns the fully qualified name of this class.
clearErrors() Removes errors for all attributes or a single attribute.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
defaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineRules() Returns the validation rules for attributes.
defineSources() Defines the sources that elements of this type may belong to.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
displayName() Returns the display name of this class.
eagerLoadingMap() Returns an array that maps source-to-target element IDs based on the given sub-property handle.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
exporters() Returns the available export options for a given source.
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.
find() Creates an craft\elements\db\ElementQueryInterface instance for query purpose.
findAll() Returns a list of elements that match the specified ID(s) or a set of element criteria parameters.
findOne() Returns a single element instance by a primary key or a set of element criteria parameters.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() Returns the validators applicable to the current scenario.
getAllPayments() Returns an array of all payments for this subscription.
getAlternativePlans() Returns possible alternative plans for this subscription
getAncestors() Returns the element’s ancestors.
getAttributeHint() Returns the text hint for the specified attribute.
getAttributeLabel() Returns the text label for the specified attribute.
getAttributeStatus() Returns the status of a given attribute.
getAttributes() Returns attribute values.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getBillingIssueDescription() Return a description of the billing issue (if any) with this subscription.
getBillingIssueResolveFormHtml() Return the form HTML for resolving the billing issue (if any) with this subscription.
getChildren() Returns the element’s children.
getContentTable() Returns the name of the table this element’s content is stored in.
getCpEditUrl() Returns the element’s edit URL in the control panel.
getCurrentRevision() Returns the element’s current revision, if one exists.
getDescendants() Returns the element’s descendants.
getDirtyAttributes() Returns a list of attribute names that have changed since the element was first loaded.
getDirtyFields() Returns a list of custom field handles that have changed since the element was first loaded.
getEagerLoadedElementCount() Returns the count of eager-loaded elements for a given handle.
getEagerLoadedElements() Returns the eager-loaded elements for a given handle.
getEditorHtml() Returns the HTML for the element’s editor HUD.
getEnabledForSite() Returns whether the element is enabled for the current site.
getError() Returns the first error of the specified attribute.
getErrorSummary() Returns the errors for all attributes as a one-dimensional array.
getErrors() Returns the errors for all attributes or a single attribute.
getFieldColumnPrefix() Returns the field column prefix this element’s content uses.
getFieldContext() Returns the field context this element’s content uses.
getFieldLayout() Returns the field layout used by this element.
getFieldParamNamespace() Returns the namespace used by custom field params on the request.
getFieldStatus() Returns the status of a given field.
getFieldValue() Returns the value for a given field.
getFieldValues() Returns the element’s normalized custom field values, indexed by their handles.
getFirstError() Returns the first error of the specified attribute.
getFirstErrors() Returns the first error of every attribute in the model.
getGateway() Returns the product type for the product tied to the license.
getGqlTypeName() Returns the GraphQL type name for this element type.
getHasBillingIssues() Return whether this subscription has billing issues.
getHasDescendants() Returns whether the element has descendants.
getHasFreshContent() Returns whether the element’s content is "fresh" (unsaved and without validation errors).
getHtmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
getId() Returns the element’s ID.
getIsDraft() Returns whether this is a draft.
getIsEditable() Returns whether the current user can edit the element.
getIsHomepage() Returns whether this element represents the site homepage.
getIsOnTrial() Returns whether this subscription is on trial.
getIsRevision() Returns whether this is a revision.
getIsUnsavedDraft() Returns whether the element is an unsaved draft.
getIterator() Returns an iterator for traversing the attributes in the model.
getLink() Returns an anchor pre-filled with this element’s URL and title.
getName()
getNext() Returns the next element relative to this one, from a given set of criteria.
getNextPaymentAmount() Returns the next payment amount with currency code as a string.
getNextSibling() Returns the element’s next sibling.
getOrder() Returns the order that included this subscription, if any.
getOrderEditUrl() Returns the link for editing the order that purchased this license.
getParent() Returns the element’s parent.
getPlan() Returns the subscription plan for this subscription
getPlanName()
getPrev() Returns the previous element relative to this one, from a given set of criteria.
getPrevSibling() Returns the element’s previous sibling.
getPreviewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
getRef() Returns the reference string to this element.
getRoute() Returns the route that should be used when the element’s URI is requested.
getScenario() Returns the scenario that this model is used in.
getSearchKeywords() Returns the search keywords for a given search attribute.
getSerializedFieldValues() Returns an array of the element’s serialized custom field values, indexed by their handles.
getSiblings() Returns all of the element’s siblings.
getSite() Returns the site the element is associated with.
getSourceId() Returns the element’s ID, or if it’s a draft/revision, its source element’s ID.
getSourceUid() Returns the element’s UUID, or if it’s a draft/revision, its source element’s UUID.
getStatus() Returns the element’s status.
getSubscriber() Returns the User that is subscribed.
getSubscriptionData()
getSupportedSites() Returns the sites this element is associated with.
getTableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.
getThumbUrl() Returns the URL to the element’s thumbnail, if there is one.
getTotalDescendants() Returns the total number of descendants that the element has.
getTrialExpires() Returns the datetime of trial expiry.
getUiLabel() Returns what the element should be called within the control panel.
getUriFormat() Returns the URI format used to generate this element’s URI.
getUrl() Returns the element’s full URL.
getValidators() Returns all the validators declared in rules().
gqlScopesByContext() Returns the GraphQL scopes required by element's context.
gqlTypeNameByContext() Returns the GraphQL type name by an element's context.
hasContent() Returns whether elements of this type will be storing any data in the content table (titles or custom fields).
hasEagerLoadedElements() Returns whether elements have been eager-loaded with a given handle.
hasErrors() Returns a value indicating whether there is any validation error.
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.
hasStatuses() Returns whether elements of this type have statuses.
hasTitles() Returns whether elements of this type have traditional titles.
hasUris() Returns whether elements of this type can have their own slugs and URIs.
indexHtml() Returns the element index HTML.
init() Initializes the object.
instance() Returns static class instance, which can be used to obtain meta information.
isAncestorOf() Returns whether this element is an ancestor of another one.
isAttributeActive() Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() Returns a value indicating whether the attribute is required.
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments.
isChildOf() Returns whether this element is a direct child of another one.
isDescendantOf() Returns whether this element is a descendant of another one.
isFieldDirty() Returns whether a custom field value has changed since the element was first loaded.
isFieldEmpty() Returns whether a field is empty.
isLocalized() Returns whether elements of this type store content on a per-site basis.
isNextSiblingOf() Returns whether this element is the direct next sibling of another one.
isParentOf() Returns whether this element is a direct parent of another one.
isPrevSiblingOf() Returns whether this element is the direct previous sibling of another one.
isSiblingOf() Returns whether this element is a sibling of another one.
load() Populates the model with input data.
loadMultiple() Populates a set of models with the data from end user.
lowerDisplayName() Returns the lowercase version of displayName().
markAsClean() Resets the record of dirty attributes and fields.
markAsDirty() Marks all fields and attributes as dirty.
off() Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() Returns the element at the specified offset.
offsetSet() Sets the element at the specified offset.
offsetUnset() Sets the element value at the specified offset to null.
on() Attaches an event handler to an event.
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned.
pluralDisplayName() Returns the plural version of displayName().
pluralLowerDisplayName() Returns the plural, lowercase version of displayName().
refHandle() Returns the handle that should be used to refer to this element type from reference tags.
rules() Returns the validation rules for attributes.
safeAttributes() Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() Returns a list of scenarios and the corresponding active attributes.
searchableAttributes() Defines which element attributes should be searchable.
setAttributes() Sets the attribute values in a massive way.
setDirtyAttributes() Sets the list of dirty attribute names.
setEagerLoadedElementCount() Sets the count of eager-loaded elements for a given handle.
setEagerLoadedElements() Sets some eager-loaded elements on a given handle.
setEnabledForSite() Sets whether the element is enabled for the current site.
setFieldParamNamespace() Sets the namespace used by custom field params on the request.
setFieldValue() Sets the value for a given field.
setFieldValues() Sets the element’s custom field values.
setFieldValuesFromRequest() Sets the element’s custom field values, when the values have come from post data.
setNext() Sets the default next element.
setParent() Sets the element’s parent.
setPrev() Sets the default previous element.
setRevisionCreatorId() Sets the revision creator ID to be saved.
setRevisionNotes() Sets the revision notes to be saved.
setScenario() Sets the scenario for the model.
setSubscriptionData()
sortOptions() Returns the sort options for the element type.
sources() Returns the source definitions that elements of this type may belong to.
statuses()
tableAttributes() Defines all of the available columns that can be shown in table views.
toArray() Converts the model into an array.
trackChanges() Returns whether Craft should keep track of attribute and custom field changes made to this element type, including when the last time they were changed, and who was logged-in at the time.
trigger() Triggers an event.
validate() Performs the data validation.
validateCustomFieldAttribute() Calls a custom validation function on a custom field.
validateCustomFieldContentSize() Validates that the content size is going to fit within the field’s database column.
validateMultiple() Validates multiple models.

# __toString()

View source

Returns

null, string

# afterSave()

Performs actions after an element is saved.

View source

Arguments

  • $isNew (boolean) – Whether the element is brand new

# canReactivate()

Returns whether this subscription can be reactivated.

View source

Returns

boolean

Throws

# datetimeAttributes()

Returns the names of any attributes that should hold DateTime values.

View source

Returns

string[]

# defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

# defineSources()

Defines the sources that elements of this type may belong to.

View source

Arguments

  • $context (string, null) – The context ('index' or 'modal').

Returns

array – The sources.

# displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

# eagerLoadingMap()

Returns an array that maps source-to-target element IDs based on the given sub-property handle.

This method aids in the eager-loading of elements when performing an element query. The returned array should contain the following keys:

  • elementType – the fully qualified class name of the element type that should be eager-loaded
  • map – an array of element ID mappings, where each element is a sub-array with source and target keys.
  • criteria (optional) – Any criteria parameters that should be applied to the element query when fetching the eager-loaded elements.

View source

Arguments

  • $sourceElements (craft\base\ElementInterface) – An array of the source elements
  • $handle (string) – The property handle used to identify which target elements should be included in the map

Returns

array, false, null – The eager-loading element ID mappings, false if no mappings exist, or null if the result should be ignored

# find()

Creates an craft\elements\db\ElementQueryInterface instance for query purpose.

The returned craft\elements\db\ElementQueryInterface instance can be further customized by calling methods defined in craft\elements\db\ElementQueryInterface before one() or all() is called to return populated \craft\commerce\elements\ElementInterface instances. For example,

// Find the entry whose ID is 5
$entry = Entry::find()->id(5)->one();
// Find all assets and order them by their filename:
$assets = Asset::find()
    ->orderBy('filename')
    ->all();

If you want to define custom criteria parameters for your elements, you can do so by overriding this method and returning a custom query class. For example,

class Product extends Element
{
    public static function find()
    {
        // use ProductQuery instead of the default ElementQuery
        return new ProductQuery(get_called_class());
    }
}

You can also set default criteria parameters on the ElementQuery if you don’t have a need for a custom query class. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->limit(50);
    }
}

View source

Returns

craft\commerce\elements\db\SubscriptionQuery – The newly created craft\commerce\elements\db\SubscriptionQuery instance.

# getAllPayments()

Returns an array of all payments for this subscription.

View source

Returns

craft\commerce\models\subscriptions\SubscriptionPayment[]

Throws

# getAlternativePlans()

Returns possible alternative plans for this subscription

View source

Returns

craft\commerce\base\Plan[]

# getBillingIssueDescription()

Return a description of the billing issue (if any) with this subscription.

View source

Returns

mixed

Throws

# getBillingIssueResolveFormHtml()

Return the form HTML for resolving the billing issue (if any) with this subscription.

View source

Returns

mixed

Throws

# getCpEditUrl()

Returns the element’s edit URL in the control panel.

View source

Returns

string, null

# getFieldLayout()

Returns the field layout used by this element.

View source

Returns

craft\models\FieldLayout, null

# getGateway()

Returns the product type for the product tied to the license.

View source

Returns

craft\commerce\base\SubscriptionGatewayInterface

Throws

# getHasBillingIssues()

Return whether this subscription has billing issues.

View source

Returns

mixed

Throws

# getIsOnTrial()

Returns whether this subscription is on trial.

View source

Returns

boolean

# getName()

View source

Returns

null, string

# getNextPaymentAmount()

Returns the next payment amount with currency code as a string.

View source

Returns

string

Throws

# getOrder()

Returns the order that included this subscription, if any.

View source

Returns

null, craft\commerce\elements\Order

# getOrderEditUrl()

Returns the link for editing the order that purchased this license.

View source

Returns

string

# getPlan()

Returns the subscription plan for this subscription

View source

Returns

craft\commerce\base\PlanInterface

# getPlanName()

View source

Returns

string

# getStatus()

Returns the element’s status.

View source

Returns

string, null

# getSubscriber()

Returns the User that is subscribed.

View source

Returns

craft\elements\User

# getSubscriptionData()

View source

Returns

array

# getTrialExpires()

Returns the datetime of trial expiry.

View source

Returns

DateTime

Throws

# hasContent()

Returns whether elements of this type will be storing any data in the content table (titles or custom fields).

View source

Returns

boolean – Whether elements of this type will be storing any data in the content table.

# hasStatuses()

Returns whether elements of this type have statuses.

If this returns true, the element index template will show a Status menu by default, and your elements will get status indicator icons next to them. Use statuses() to customize which statuses the elements might have.

View source

Returns

boolean – Whether elements of this type have statuses.

# lowerDisplayName()

Returns the lowercase version of displayName().

View source

Returns

string

# pluralDisplayName()

Returns the plural version of displayName().

View source

Returns

string

# pluralLowerDisplayName()

Returns the plural, lowercase version of displayName().

View source

Returns

string

# setEagerLoadedElements()

Sets some eager-loaded elements on a given handle.

View source

Arguments

# setSubscriptionData()

View source

Arguments

# statuses()

View source

# Protected Methods

Method Description
defineActions() Defines the available element actions for a given source.
defineDefaultTableAttributes() Returns the list of table attribute keys that should be shown by default.
defineExporters() Defines the available element exporters for a given source.
defineSearchableAttributes() Defines which element attributes should be searchable.
defineSortOptions() Returns the sort options for the element type.
defineTableAttributes() Defines all of the available columns that can be shown in table views.
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.
fieldByHandle() Returns the field with a given handle.
fieldLayoutFields() Returns each of this element’s fields.
findByCondition() Finds Element instance(s) by the given condition.
htmlAttributes() Returns any attributes that should be included in the element’s DOM representation in the control panel.
normalizeFieldValue() Normalizes a field’s value.
prepElementQueryForTableAttribute() Preps the element criteria for a given table attribute
previewTargets() Returns the additional locations that should be available for previewing the element, besides its primary URL.
resolveFields() Determines which fields can be returned by toArray().
route() Returns the route that should be used when the element’s URI is requested.
tableAttributeHtml() Returns the HTML that should be shown for a given attribute in Table View.

# defineDefaultTableAttributes()

Returns the list of table attribute keys that should be shown by default.

View source

Arguments

  • $source (string) – The selected source’s key

Returns

string[] – The table attributes.

# defineSearchableAttributes()

Defines which element attributes should be searchable.

View source

Returns

string[] – The element attributes that should be searchable

# defineSortOptions()

Returns the sort options for the element type.

View source

Returns

array – The attributes that elements can be sorted by

# defineTableAttributes()

Defines all of the available columns that can be shown in table views.

View source

Returns

array – The table attributes.

# prepElementQueryForTableAttribute()

Preps the element criteria for a given table attribute

View source

Arguments

# tableAttributeHtml()

Returns the HTML that should be shown for a given attribute in Table View.

This method can be used to completely customize what actually shows up within the table’s body for a given attribute, rather than simply showing the attribute’s raw value.

For example, if your elements have an email attribute that you want to wrap in a mailto: link, your getTableAttributesHtml() method could do this:

switch ($attribute) {
    case 'email':
        return $this->email ? Html::mailto(Html::encode($this->email)) : '';
    // ...
}
return parent::tableAttributeHtml($attribute);

WARNING

All untrusted text should be passed through craft\helpers\Html::encode() to prevent XSS attacks.

By default the following will be returned:

  • If the attribute name is link or uri, it will be linked to the front-end URL.
  • If the attribute is a custom field handle, it will pass the responsibility off to the field type.
  • If the attribute value is a DateTime object, the date will be formatted with a localized date format.
  • For anything else, it will output the attribute value as a string.

View source

Arguments

  • $attribute (string) – The attribute name.

Returns

string – The HTML that should be shown for a given attribute in Table View.

Throws

# Constants

Constant Description
ATTR_STATUS_CONFLICTED
ATTR_STATUS_MODIFIED
ATTR_STATUS_OUTDATED
HOMEPAGE_URI
SCENARIO_DEFAULT The name of the default scenario.
SCENARIO_ESSENTIALS
SCENARIO_LIVE
STATUS_ACTIVE
STATUS_ARCHIVED
STATUS_DISABLED
STATUS_ENABLED
STATUS_EXPIRED
STATUS_SUSPENDED