Class ShippingMethod

ShippingMethod is a base class for providing shipping options to customers.

Object

ViewableData implements IteratorAggregate

DataObject implements DataObjectInterface, i18nEntityProvider

ShippingMethod

Direct known subclasses

FixedShippingMethod, TableShippingMethod

Indirect known subclasses

CostTableShippingMethod, WeightTableShippingMethod

Package: cart\shipping
Author: menedem
Located at cart_shipping/code/ShippingMethod.php

Methods summary

`public static array`	# `get_supported_methods( )` Returns `array` array
`public static array`	# `set_supported_methods( array $methodMap )` Parameters `$methodMap` array $methodMap Returns `array` array
`public static boolean`	# `method_is_supported( string $method )` Проверяет доступен ли данный клас для создания метода доставки Проверяет доступен ли данный клас для создания метода доставки Parameters `$method` string $method Returns `boolean` boolean
`public static DataObjectSet`	# `get_shipping_methods( )` Получение всех доступных способов доставки Получение всех доступных способов доставки Returns `DataObjectSet` DataObjectSet
`public`	# `populateDefaults( )` Load the default values in from the self::$defaults array. Will traverse the defaults of the current class and all its parent classes. Called by the constructor when creating new records. Load the default values in from the self::$defaults array. Will traverse the defaults of the current class and all its parent classes. Called by the constructor when creating new records. Uses `DataObjectDecorator::populateDefaults()` Overrides `DataObject::populateDefaults`
`public FieldSet`	# `getCMSFields( )` Centerpiece of every data administration interface in Silverstripe, which returns a `FieldSet` suitable for a `Form` object. If not overloaded, we're using `DataObject::scaffoldFormFields()` to automatically generate this set. To customize, overload this method in a subclass or decorate onto it by using DataObjectDecorator->updateCMSFields(). Centerpiece of every data administration interface in Silverstripe, which returns a `FieldSet` suitable for a `Form` object. If not overloaded, we're using `DataObject::scaffoldFormFields()` to automatically generate this set. To customize, overload this method in a subclass or decorate onto it by using DataObjectDecorator->updateCMSFields(). klass MyCustomClass extends DataObject { static $db = array('CustomProperty'=>'Boolean'); public function getCMSFields() { $fields = parent::getCMSFields(); $fields->addFieldToTab('Root.Content',new CheckboxField('CustomProperty')); return $fields; } } Returns `FieldSet` Returns a TabSet for usage within the CMS - don't use for frontend forms. See Good example of complex FormField building: SiteTree::getCMSFields() Overrides `DataObject::getCMSFields`
`public`	# `ShippingIcon( )`
`public`	# `ListTitle( )`
`public null\|float`	# `calculateRate( ShippingPackage $package, Address $address )` Рассчитывает стоимость доставки Рассчитывает стоимость доставки Parameters `$package` ShippingPackage $package `$address` Address $address Returns `null\|float` null\|float
`public CatalogPrice`	# `getRate( )` Стоимость доставки Стоимость доставки Returns `CatalogPrice` CatalogPrice
`public`	# `Title( )`
`public`	# `onBeforeWrite( )` Event handler called before writing to the database. You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though! Event handler called before writing to the database. You can overload this to clean up or otherwise process data before writing it to the database. Don't forget to call parent::onBeforeWrite(), though! This called after $this->validate(), so you can be sure that your data is valid. Uses `DataObjectDecorator::onBeforeWrite()` Overrides `DataObject::onBeforeWrite`

Magic methods summary

Properties summary

`public static array`	`$db`	# Database field definitions. This is a map from field names to field type. The field type should be a class that extends . Database field definitions. This is a map from field names to field type. The field type should be a class that extends .
`public static array`	`$has_one`	# One-to-zero relationship defintion. This is a map of component name to data type. In order to turn this into a true one-to-one relationship you can add a `DataObject::$belongs_to` relationship on the child class. One-to-zero relationship defintion. This is a map of component name to data type. In order to turn this into a true one-to-one relationship you can add a `DataObject::$belongs_to` relationship on the child class. Note that you cannot have a has_one and belongs_to relationship with the same name.
`public static array`	`$defaults`	# Inserts standard column-values when a DataObject is instanciated. Does not insert default records `DataObject::$default_records`. This is a map from fieldname to default value. Inserts standard column-values when a DataObject is instanciated. Does not insert default records `DataObject::$default_records`. This is a map from fieldname to default value. If you would like to change a default value in a sub-class, just specify it. - If you would like to disable the default value given by a parent class, set the default value to 0,'',or false in your subclass. Setting it to null won't work.
`public static array`	`$summary_fields`	# Provides a default list of fields to be used by a 'summary' view of this object. Provides a default list of fields to be used by a 'summary' view of this object.
`public static string`	`$default_sort`	# The default sort expression. This will be inserted in the ORDER BY clause of a SQL query if no other sort expression is provided. The default sort expression. This will be inserted in the ORDER BY clause of a SQL query if no other sort expression is provided.
`public static array`	`$shippingMethodIcons`	#
`public mixed`	`$CalculatedRate`	#
`protected static array`	`$supported_methods`	# Список доступных классов для методов доставки Список доступных классов для методов доставки

Properties inherited from DataObject

$allowed_actions, $ancestry, $api_access, $belongs_many_many, $belongs_to, $brokenOnDelete, $brokenOnWrite, $cache_get_one, $cache_has_own_table, $cache_has_own_table_field, $casting, $componentCache, $components, $create_table_options, $default_records, $destroyed, $field_labels, $has_many, $indexes, $many_many, $many_many_extraFields, $original, $plural_name, $record, $searchable_fields, $singular_name

Properties inherited from ViewableData

$customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

Packages

Classes

Class ShippingMethod

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Parameters

Returns

Parameters

Returns

Returns

Uses

Overrides

Returns

See

Overrides

Parameters

Returns

Returns

Uses

Overrides

Methods inherited from DataObject

Methods inherited from ViewableData

Methods inherited from Object

Magic methods summary

Properties summary

Properties inherited from DataObject

Properties inherited from ViewableData

Properties inherited from Object