ShippingMethod

Type
Abstract Class
Namespace
craft\commerce\base
Inherits
craft\commerce\base\ShippingMethod » 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\ShippingMethodInterface, 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), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by
craft\commerce\models\ShippingMethod, craft\commerce\models\ShippingMethodOption
Since
2.0

Base ShippingMethod

View source (opens new window)

# 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.
cpEditUrl string (opens new window)
dateCreated DateTime (opens new window), null (opens new window)
dateUpdated DateTime (opens new window), null (opens new window)
enabled boolean (opens new window) – Enabled
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.
handle string (opens new window) – Handle
id integer (opens new window) – ID
isEnabled boolean (opens new window)
isLite boolean (opens new window) – Is this the shipping method for the lite edition.
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
name string (opens new window) – Name
scenario (opens new window) string (opens new window) – The scenario that this model is in.
shippingRules craft\commerce\base\ShippingRuleInterface[] – The array of ShippingRules
type string (opens new window)
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# cpEditUrl

Type
string (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# dateCreated

Type
DateTime (opens new window), null (opens new window)
Default value
null
Since
3.4

View source (opens new window)

# dateUpdated

Type
DateTime (opens new window), null (opens new window)
Default value
null
Since
3.4

View source (opens new window)

# enabled

Type
boolean (opens new window)
Default value
null

Enabled

View source (opens new window)

# handle

Type
string (opens new window)
Default value
null

Handle

View source (opens new window)

# id

Type
integer (opens new window)
Default value
null

ID

View source (opens new window)

# isEnabled

Type
boolean (opens new window)
Default value
null
Access
Read-only

View source (opens new window)

# isLite

Type
boolean (opens new window)
Default value
false

Is this the shipping method for the lite edition.

View source (opens new window)

# name

Type
string (opens new window)
Default value
null

Name

View source (opens new window)

# shippingRules

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

The array of ShippingRules

View source (opens new window)

# type

Type
string (opens new window)
Default value
null
Access
Read-only

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.
__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.
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.
getActiveValidators() (opens new window) Returns the validators applicable to the current scenario (opens new window).
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.
getCpEditUrl() Returns the control panel URL to manage this method and its rules.
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.
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() (opens new window) Returns an iterator for traversing the attributes in the model.
getMatchingShippingRule() The first matching shipping rule for this shipping method
getName() Returns the name of this Shipping Method as displayed to the customer and in the control panel.
getPriceForOrder()
getScenario() (opens new window) 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() (opens new window) Returns all the validators declared in rules() (opens new window).
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.
matchOrder() Is this shipping method available to the order?
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() (opens new window) 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.

# getCpEditUrl()

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

An empty string will result in no link.

View source (opens new window)

Returns

string (opens new window)

# getHandle()

Returns the unique handle of this Shipping Method.

View source (opens new window)

Returns

string (opens new window)

# getId()

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

View source (opens new window)

Returns

integer (opens new window), null (opens new window) – The shipping method ID, or null if it is not managed by Craft Commerce

# getIsEnabled()

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

View source (opens new window)

Returns

boolean (opens new window)

# getMatchingShippingRule()

The first matching shipping rule for this shipping method

View source (opens new window)

Arguments

Returns

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

# getName()

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

View source (opens new window)

Returns

string (opens new window)

# getPriceForOrder()

View source (opens new window)

Arguments

Returns

float (opens new window)

# getShippingRules()

Returns an array of rules that meet the ShippingRules interface.

View source (opens new window)

Returns

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

# 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 (opens new window)

Returns

string (opens new window)

# matchOrder()

Is this shipping method available to the order?

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# 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.