ShippingMethod

Type
Class
Namespace
craft\commerce\models
Inherits
craft\commerce\models\ShippingMethod » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\commerce\base\ShippingMethodInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
2.0

Shipping method model.

View source

Public Properties

PropertyDescription
$activeValidatorsyii\validators\Validator – The validators applicable to the current $scenario.
$attributesarray – Attribute values (name => value).
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$cpEditUrlstring
$enabledboolean – Enabled
$errorsarray – Errors for all attributes or the specified attribute.
$firstErrorsarray – The first errors.
$handlestring – Handle
$idinteger – ID
$isEnabledboolean
$iteratorArrayIterator – An iterator for traversing the items in the list.
$namestring – Name
$scenariostring – The scenario that this model is in.
$shippingRulescraft\commerce\base\ShippingRuleInterface[] – The array of ShippingRules
$typestring
$validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

$cpEditUrl

Type
string
Access
Read-only

View source

Signature

public string getCpEditUrl ( )

$enabled

Signature

public boolean $enabled = null

$handle

Type
string
Access
Read-only

Handle

View source

Signature

public string getHandle ( )

$id

Type
integer
Access
Read-only

ID

View source

Signature

public integer, null getId ( )

$isEnabled

Type
boolean
Access
Read-only

View source

Signature

public boolean getIsEnabled ( )

$name

Type
string
Access
Read-only

Name

View source

Signature

public string getName ( )

$shippingRules

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

The array of ShippingRules

View source

Signature

public craft\commerce\base\ShippingRuleInterface[] getShippingRules ( )

$type

Type
string
Access
Read-only

View source

Signature

public string getType ( )

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
getActiveValidators()Returns the validators applicable to the current $scenario.
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 control panel URL to manage this method and its rules.
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.
getFirstError()Returns the first error of the specified attribute.
getFirstErrors()Returns the first error of every attribute in the model.
getHandle()Returns the unique handle of this Shipping Method.
getId()Returns the ID of this Shipping Method, if it is managed by Craft Commerce.
getIsEnabled()Returns whether this shipping method is enabled for listing and selection by customers.
getIterator()Returns an iterator for traversing the attributes in the model.
getName()Returns the name of this Shipping Method as displayed to the customer and in the control panel.
getScenario()Returns the scenario that this model is used in.
getShippingRules()Returns an array of rules that meet the ShippingRules interface.
getType()Returns the type of Shipping Method. This might be the name of the plugin or provider.
getValidators()Returns all the validators declared in rules().
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.
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.

getCpEditUrl()

Returns the control panel URL to manage this method and its rules.

An empty string will result in no link.

View source

Returns

string

Signature

public string getCpEditUrl ( )

getHandle()

Returns the unique handle of this Shipping Method.

View source

Returns

string

Signature

public string getHandle ( )

getId()

Returns the ID of this Shipping Method, if it is managed by Craft Commerce.

View source

Returns

integer, null – The shipping method ID, or null if it is not managed by Craft Commerce

Signature

public integer, null getId ( )

getIsEnabled()

Returns whether this shipping method is enabled for listing and selection by customers.

View source

Returns

boolean

Signature

public boolean getIsEnabled ( )

getName()

Returns the name of this Shipping Method as displayed to the customer and in the control panel.

View source

Returns

string

Signature

public string getName ( )

getShippingRules()

Returns an array of rules that meet the ShippingRules interface.

View source

Returns

craft\commerce\base\ShippingRuleInterface[] – The array of ShippingRules

Signature

public craft\commerce\base\ShippingRuleInterface[] getShippingRules ( )

getType()

Returns the type of Shipping Method. This might be the name of the plugin or provider.

The core shipping methods have type: Custom. This is shown in the control panel only.

View source

Returns

string

Signature

public string getType ( )

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:

[
    ['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\models\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 \craft\commerce\models\Validator::builtInValidators. 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

Returns

array – Validation rules

Signature

public array rules ( )

Protected Methods

MethodDescription
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

ConstantDescription
SCENARIO_DEFAULTThe name of the default scenario.