Plan ​
- Type
- Abstract Class
- Namespace
- craft\commerce\base
- Inherits
- craft\commerce\base\Plan » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\CpEditable, craft\base\ModelInterface, craft\commerce\base\PlanInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses traits
- craft\base\ClonefixTrait, craft\commerce\base\PlanTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Extended by
- craft\commerce\models\subscriptions\DummyPlan
- Since
- 2.0
Plan model
Public Properties ​
| Property | Description |
|---|---|
| activeValidators | yii\validators\Validator – The validators applicable to the current scenario. |
| attributes | array – Attribute values (name => value). |
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| cpEditUrl | string, null |
| dateArchived | DateTime, null – When the plan was archived |
| dateCreated | DateTime, null |
| dateUpdated | DateTime, null |
| enabled | boolean – Whether the plan is enabled on site |
| errors | array – Errors for all attributes or the specified attribute. |
| firstErrors | array – The first errors. |
| gateway | craft\commerce\base\GatewayInterface |
| gatewayId | integer, null – The gateway ID. |
| handle | string, null – Plan handle |
| id | integer, null – Plan ID |
| information | craft\elements\Entry, null |
| isArchived | boolean – Whether the plan is archived |
| iterator | ArrayIterator – An iterator for traversing the items in the list. |
| name | string, null – Plan name |
| planData | string, null – Gateway response |
| planInformationId | integer, null – ID of the entry containing plan information |
| reference | string, null – Plan reference on the gateway |
| scenario | string – The scenario that this model is in. |
| sortOrder | integer, null – Sort order |
| subscriptionCount | integer |
| uid | string, null – Plan uid |
| user | craft\elements\User |
| validators | ArrayObject, yii\validators\Validator – All the validators declared in the model. |
cpEditUrl ​
dateCreated ​
dateUpdated ​
gateway ​
- Type
- craft\commerce\base\GatewayInterface
- Default value
null
information ​
- Type
- craft\elements\Entry, null
- Default value
null
subscriptionCount ​
- Type
- integer
- Default value
null
user ​
- Type
- craft\elements\User
- Default value
null
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | |
| __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 billing plan friendly name |
| __unset() | Sets a component property to be null. |
| 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. |
| 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. |
| 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. |
| canSetProperty() | 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() | 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. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| 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. |
| formName() | Returns the form name that this model class should use. |
| generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. |
| getActiveUserSubscriptions() | Returns active subscriptions for this plan by user id. |
| getActiveValidators() | Returns the validators applicable to the current scenario. |
| getAllUserSubscriptions() | Returns all subscriptions for this plan by user id, including expired subscriptions. |
| getAttributeHint() | Returns the text hint for the specified attribute. |
| getAttributeLabel() | Returns the text label for the specified attribute. |
| getAttributes() | Returns attribute values. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getCpEditUrl() | Returns the URL to the component’s edit page in the control panel. |
| getErrorSummary() | Returns the errors for all attributes as a one-dimensional array. |
| getErrors() | Returns the errors for all attributes or a single attribute. |
| getFirstError() | Returns the first error of the specified attribute. |
| getFirstErrors() | 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() | Returns an iterator for traversing the attributes in the model. |
| getPlanData() | Returns the stored plan data. |
| getScenario() | Returns the scenario that this model is used in. |
| getSubscriptionCount() | Returns the subscription count for this plan. |
| getValidators() | Returns all the validators declared in rules(). |
| hasActiveSubscription() | Returns whether there exists an active subscription for this plan for this user. |
| 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. |
| init() | Initializes the object. |
| instance() | Returns static class instance, which can be used to obtain meta information. |
| 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. |
| load() | Populates the model with input data. |
| loadMultiple() | Populates a set of models with the data from end user. |
| 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. |
| 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. |
| setAttributes() | Sets the attribute values in a massive way. |
| setScenario() | Sets the scenario for the model. |
| toArray() | Converts the model into an array. |
| trigger() | Triggers an event. |
| validate() | Performs the data validation. |
| validateMultiple() | Validates multiple models. |
__toString() ​
Returns the billing plan friendly name
Returns ​
getActiveUserSubscriptions() ​
Returns active subscriptions for this plan by user id.
Arguments ​
$userId(integer) – The user id
Returns ​
getAllUserSubscriptions() ​
Returns all subscriptions for this plan by user id, including expired subscriptions.
Arguments ​
$userId(integer) – The user id
Returns ​
getCpEditUrl() ​
Returns the URL to the component’s edit page in the control panel.
Returns ​
getGateway() ​
Returns the gateway for this subscription plan.
Throws ​
- yii\base\InvalidConfigException
if gateway does not support subscriptions
getInformation() ​
Returns the plan's related Entry element, if any.
getPlanData() ​
Returns the stored plan data.
Returns ​
mixed
getSubscriptionCount() ​
Returns the subscription count for this plan.
hasActiveSubscription() ​
Returns whether there exists an active subscription for this plan for this user.
Arguments ​
$userId
rules() ​
Returns the validation rules for attributes.
Validation rules are used by validate() 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:
php
[
['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 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:
php
// $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. Each one has an alias name which can be used when specifying a validation rule.
Below are some examples:
php
[
// 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().
Returns ​
array – Validation rules
Protected Methods ​
| Method | Description |
|---|---|
| defineBehaviors() | Returns the behaviors to attach to this class. |
| defineRules() | Returns the validation rules for attributes. |
| 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. |
| resolveFields() | Determines which fields can be returned by toArray(). |
Constants ​
| Constant | Description |
|---|---|
SCENARIO_DEFAULT | The name of the default scenario. |