Plan

Type: Abstract Class
Namespace: craft\commerce\base
Inherits: craft\commerce\base\Plan » craft\commerce\base\Model » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\commerce\base\PlanInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), craft\commerce\base\PlanTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by: craft\commerce\models\subscriptions\DummyPlan
Since: 2.0

Plan model

# Public Properties

Property	Description
activeValidators (opens new window)	yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
attributes (opens new window)	array (opens new window) – Attribute values (name => value).
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
dateArchived	DateTime (opens new window) – When the plan was archived
dateCreated	DateTime (opens new window), null (opens new window)
dateUpdated	DateTime (opens new window), null (opens new window)
enabled	boolean (opens new window) – Whether the plan is enabled on site
errors (opens new window)	array (opens new window) – Errors for all attributes or the specified attribute.
firstErrors (opens new window)	array (opens new window) – The first errors.
gateway	craft\commerce\base\GatewayInterface
gatewayId	integer (opens new window) – The gateway ID.
handle	string (opens new window) – Plan handle
id	integer (opens new window) – Plan ID
information	craft\elements\Entry (opens new window), null (opens new window)
isArchived	boolean (opens new window) – Whether the plan is archived
iterator (opens new window)	ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name	string (opens new window) – Plan name
planData	string (opens new window) – Gateway response
planInformationId	integer (opens new window) – ID of the entry containing plan information
reference	string (opens new window) – Plan reference on the gateway
scenario (opens new window)	string (opens new window) – The scenario that this model is in.
sortOrder	integer (opens new window) – Sort order
subscriptionCount	integer (opens new window)
uid	string (opens new window) – Plan uid
user	craft\elements\User (opens new window)
validators (opens new window)	ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# `subscriptionCount`

Type: integer (opens new window)
Default value: null

View source (opens new window)

# `user`

Type: craft\elements\User (opens new window)
Default value: null

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() (opens new window)	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() (opens new window)	Sets the value of a component property.
__toString()	Returns the billing plan friendly name
__unset() (opens new window)	Sets a component property to be null.
activeAttributes() (opens new window)	Returns the attribute names that are subject to validation in the current scenario.
addError() (opens new window)	Adds a new error to the specified attribute.
addErrors() (opens new window)	Adds a list of errors.
addModelErrors() (opens new window)	Adds errors from another model, with a given attribute name prefix.
afterValidate() (opens new window)	This method is invoked after validation ends.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attributeHints() (opens new window)	Returns the attribute hints.
attributeLabels() (opens new window)	Returns the attribute labels.
attributes() (opens new window)	Returns the list of attribute names.
beforeValidate() (opens new window)	This method is invoked before validation starts.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
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.
canSwitchFrom()	Returns whether it's possible to switch to this plan from a different plan.
className() (opens new window)	Returns the fully qualified name of this class.
clearErrors() (opens new window)	Removes errors for all attributes or a single attribute.
createValidators() (opens new window)	Creates validator objects based on the validation rules specified in rules() (opens new window).
datetimeAttributes() (opens new window)	Returns the names of any attributes that should hold DateTime (opens new window) values.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
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.
formName() (opens new window)	Returns the form name that this model class should use.
generateAttributeLabel() (opens new window)	Generates a user friendly attribute label based on the give attribute name.
getActiveUserSubscriptions()	Returns active subscriptions for this plan by user id.
getActiveValidators() (opens new window)	Returns the validators applicable to the current scenario (opens new window).
getAllUserSubscriptions()	Returns all subscriptions for this plan by user id, including expired subscriptions.
getAttributeHint() (opens new window)	Returns the text hint for the specified attribute.
getAttributeLabel() (opens new window)	Returns the text label for the specified attribute.
getAttributes() (opens new window)	Returns attribute values.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getError() (opens new window)	Returns the first error of the specified attribute.
getErrorSummary() (opens new window)	Returns the errors for all attributes as a one-dimensional array.
getErrors() (opens new window)	Returns the errors for all attributes or a single attribute.
getFirstError() (opens new window)	Returns the first error of the specified attribute.
getFirstErrors() (opens new window)	Returns the first error of every attribute in the model.
getGateway()	Returns the gateway for this subscription plan.
getInformation()	Returns the plan's related Entry element, if any.
getIterator() (opens new window)	Returns an iterator for traversing the attributes in the model.
getPlanData()	Returns the stored plan data.
getScenario() (opens new window)	Returns the scenario that this model is used in.
getSubscriptionCount()	Returns the subscription count for this plan.
getValidators() (opens new window)	Returns all the validators declared in rules() (opens new window).
hasActiveSubscription()	Returns whether there exists an active subscription for this plan for this user.
hasErrors() (opens new window)	Returns a value indicating whether there is any validation error.
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.
init() (opens new window)	Initializes the object.
instance() (opens new window)	Returns static class instance, which can be used to obtain meta information.
isAttributeActive() (opens new window)	Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() (opens new window)	Returns a value indicating whether the attribute is required.
isAttributeSafe() (opens new window)	Returns a value indicating whether the attribute is safe for massive assignments.
load() (opens new window)	Populates the model with input data.
loadMultiple() (opens new window)	Populates a set of models with the data from end user.
off() (opens new window)	Detaches an existing event handler from this component.
offsetExists() (opens new window)	Returns whether there is an element at the specified offset.
offsetGet() (opens new window)	Returns the element at the specified offset.
offsetSet() (opens new window)	Sets the element at the specified offset.
offsetUnset() (opens new window)	Sets the element value at the specified offset to null.
on() (opens new window)	Attaches an event handler to an event.
onUnsafeAttribute() (opens new window)	This method is invoked when an unsafe attribute is being massively assigned.
rules()	Returns the validation rules for attributes.
safeAttributes() (opens new window)	Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() (opens new window)	Returns a list of scenarios and the corresponding active attributes.
setAttributes() (opens new window)	Sets the attribute values in a massive way.
setScenario() (opens new window)	Sets the scenario for the model.
toArray() (opens new window)	Converts the model into an array.
trigger() (opens new window)	Triggers an event.
validate() (opens new window)	Performs the data validation.
validateMultiple() (opens new window)	Validates multiple models.

# `__toString()`

Returns the billing plan friendly name

View source (opens new window)

Returns

string (opens new window)

# `getActiveUserSubscriptions()`

Returns active subscriptions for this plan by user id.

View source (opens new window)

Arguments

$userId (integer (opens new window)) – The user id

Returns

craft\base\ElementInterface (opens new window)

# `getAllUserSubscriptions()`

Returns all subscriptions for this plan by user id, including expired subscriptions.

View source (opens new window)

Arguments

$userId (integer (opens new window)) – The user id

Returns

craft\base\ElementInterface (opens new window)

# `getGateway()`

Returns the gateway for this subscription plan.

View source (opens new window)

Returns

craft\commerce\base\SubscriptionGatewayInterface, null (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)
if gateway does not support subscriptions

# `getInformation()`

Returns the plan's related Entry element, if any.

View source (opens new window)

Returns

craft\elements\Entry (opens new window), null (opens new window)

# `getPlanData()`

Returns the stored plan data.

View source (opens new window)

Returns

mixed

# `getSubscriptionCount()`

Returns the subscription count for this plan.

View source (opens new window)

Returns

integer (opens new window)

# `hasActiveSubscription()`

Returns whether there exists an active subscription for this plan for this user.

View source (opens new window)

Arguments

$userId (integer (opens new window))

Returns

boolean (opens new window)

# `rules()`

Returns the validation rules for attributes.

Validation rules are used by validate() (opens new window) to check if attribute values are valid. Child classes may override this method to declare different validation rules.

Each rule is an array with the following structure:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

where

attribute list: required, specifies the attributes array to be validated, for single attribute you can pass a string;
validator type: required, specifies the validator to be used. It can be a built-in validator name, a method name of the model class, an anonymous function, or a validator class name.
on: optional, specifies the scenarios (opens new window) array in which the validation rule can be applied. If this option is not set, the rule will apply to all scenarios.
additional name-value pairs can be specified to initialize the corresponding validator properties. Please refer to individual validator class API for possible properties.

A validator can be either an object of a class extending \craft\commerce\base\Validator, or a model class method (called inline validator) that has the following signature:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

In the above $attribute refers to the attribute currently being validated while $params contains an array of validator configuration options such as max in case of string validator. The value of the attribute currently being validated can be accessed as $this->$attribute. Note the $ before attribute; this is taking the value of the variable $attribute and using it as the name of the property to access.

Yii also provides a set of built-in validators (opens new window). Each one has an alias name which can be used when specifying a validation rule.

Below are some examples:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Note, in order to inherit rules defined in the parent class, a child class needs to merge the parent rules with child rules using functions such as array_merge().

View source (opens new window)

Returns

array (opens new window) – Validation rules

# Protected Methods

Method	Description
defineRules() (opens new window)	Returns the validation rules for attributes.
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.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

# Constants

Constant	Description
`SCENARIO_DEFAULT`	The name of the default scenario.

← OrderDeprecatedTrait PlanInterface →

Plan

# Public Properties

# dateCreated

# dateUpdated

# gateway

# information

# subscriptionCount

# user

# Public Methods

# __toString()

Returns

# getActiveUserSubscriptions()

Arguments

Returns

# getAllUserSubscriptions()

Arguments

Returns

# getGateway()

Returns

Throws

# getInformation()

Returns

# getPlanData()

Returns

# getSubscriptionCount()

Returns

# hasActiveSubscription()

Arguments

Returns

# rules()

Returns

# Protected Methods

# Constants

# `dateCreated`

# `dateUpdated`

# `gateway`

# `information`

# `subscriptionCount`

# `user`

# `__toString()`

# `getActiveUserSubscriptions()`

# `getAllUserSubscriptions()`

# `getGateway()`

# `getInformation()`

# `getPlanData()`

# `getSubscriptionCount()`

# `hasActiveSubscription()`

# `rules()`