ShippingMethod

Type

Abstract Class

Namespace

craft\commerce\base

Inherits

craft\commerce\base\ShippingMethod » craft\commerce\base\Model » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject

Implements

ArrayAccess, IteratorAggregate, craft\base\ModelInterface, craft\commerce\base\HasStoreInterface, craft\commerce\base\ShippingMethodInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\commerce\base\StoreTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Extended by

craft\commerce\models\ShippingMethod, craft\commerce\models\ShippingMethodOption

Since

2.0

Base ShippingMethod

View source

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
customerCondition	craft\commerce\elements\conditions\customers\ShippingMethodCustomerCondition
dateCreated	DateTime, null
dateUpdated	DateTime, null
enabled	boolean – Enabled
errors	array – Errors for all attributes or the specified attribute.
firstErrors	array – The first errors.
handle	string, null – Handle
id	integer, null – ID
isEnabled	boolean
iterator	ArrayIterator – An iterator for traversing the items in the list.
name	string, null – Name
orderCondition	craft\commerce\elements\conditions\orders\ShippingMethodOrderCondition
scenario	string – The scenario that this model is in.
shippingRules	array
store	craft\commerce\models\Store
storeId	integer, null – Store ID
type	string
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.

cpEditUrl

Type

string

Default value

null

View source

customerCondition

Type

craft\commerce\elements\conditions\customers\ShippingMethodCustomerCondition

Default value

null

View source

dateCreated

Type

DateTime, null

Default value

null

Since

3.4

View source

dateUpdated

Type

DateTime, null

Default value

null

Since

3.4

View source

enabled

Type

boolean

Default value

true

Enabled

View source

handle

Type

string, null

Default value

null

Handle

View source

id

Type

integer, null

Default value

null

ID

View source

isEnabled

Type

boolean

Default value

null

View source

name

Type

string, null

Default value

null

Name

View source

orderCondition

Type

craft\commerce\elements\conditions\orders\ShippingMethodOrderCondition

Default value

null

View source

shippingRules

Type

array

Default value

null

View source

type

Type

string

Default value

null

View source

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.
__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.
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.
getCustomerCondition()
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.
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.
getOrderCondition()
getPriceForOrder()
getScenario()	Returns the scenario that this model is used in.
getShippingRules()	Returns an array of rules that meet the ShippingRules interface.
getStore()
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 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.
matchOrder()	Is this shipping method available to the order?
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.
setCustomerCondition()
setOrderCondition()
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

getCustomerCondition()

Since

5.0.0

View source

Returns

craft\commerce\elements\conditions\customers\ShippingMethodCustomerCondition

getHandle()

Returns the unique handle of this Shipping Method.

View source

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

getIsEnabled()

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

View source

getMatchingShippingRule()

The first matching shipping rule for this shipping method

View source

Arguments

• $order

getName()

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

View source

getOrderCondition()

Since

5.0.0

View source

Returns

craft\commerce\elements\conditions\orders\ShippingMethodOrderCondition

getPriceForOrder()

View source

Arguments

• $order

getShippingRules()

Returns an array of rules that meet the ShippingRules interface.

View source

Returns

\Illuminate\Support\Collection<\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

matchOrder()

Is this shipping method available to the order?

View source

Arguments

• $order

setCustomerCondition()

Since

5.4.0

View source

Arguments

• $condition (craft\commerce\elements\conditions\customers\ShippingMethodCustomerCondition, string, array, null)

Returns

void

Throws

• \JsonSchema\Exception\InvalidConfigException

setOrderCondition()

Since

5.0.0

View source

Arguments

• $condition (craft\commerce\elements\conditions\orders\ShippingMethodOrderCondition, string, array, null)

Returns

void

Throws

• \JsonSchema\Exception\InvalidConfigException

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().

defineRules()

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source

Returns

array

Constants

Constant	Description
SCENARIO_DEFAULT	The name of the default scenario.