DummyPlan ​
- Type
- Class
- Namespace
- craft\commerce\models\subscriptions
- Inherits
- craft\commerce\models\subscriptions\DummyPlan » 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
- Since
- 2.0
Class DummyPlan
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. |
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. |
canSwitchFrom()
​
Returns whether it's possible to switch to this plan from a different plan.
TODO: Fix typo in next major release currentPlant -> currentPlan
TODO: Fix typo in next major release currentPlant -> currentPlan
Arguments ​
$currentPlant
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. |