Версия: 6.x
burger close
Класс Cdek2
Граф наследования:Cdek2:
AbstractType InterfaceDeliveryOrder InterfaceIonicMobile

Открытые члены

 getTitle ()
 
 getDescription ()
 
 getShortName ()
 
 getRequiredAddressFields ()
 
 canCalculateCostByDeliveryAddress (Address $address)
 
 getFormObject ()
 
 getAdminHTML (Order $order)
 
 getIonicMobileAdditionalHTML (Order $order, Delivery $delivery)
 
 hasPvz ()
 
 onOrderCreate (Order $order, Address $address=null)
 
 getSelectError (Order $order)
 
 getPvzByAddress (Address $address)
 
 getDeliveryCost (Order $order, Address $address, Delivery $delivery, $use_currency=true)
 
 getDeliveryOrderTrackNumber (DeliveryOrder $delivery_order)
 
 getDeliveryOrderActions (DeliveryOrder $delivery_order)
 
 executeInterfaceDeliveryOrderAction (HttpRequest $http_request, Order $order, string $action)
 
 createDeliveryOrder (Order $order)
 
 changeDeliveryOrder (DeliveryOrder $delivery_order, Order $order)
 
 deleteDeliveryOrder (DeliveryOrder $delivery_order)
 
 refreshDeliveryOrder (DeliveryOrder $delivery_order)
 
 getDeliveryOrderDataLines (DeliveryOrder $delivery_order)
 
 executeWebHook (HttpRequest $http_request)
 
 loadOptions (array $opt=null)
 
- Открытые члены унаследованные от AbstractType
 __construct (array $options=null)
 
 processOptions ($options)
 
 beforesave ()
 
 getCheckboxParam ($key=null)
 
 set ($value)
 
 setListenPost ($boolean)
 
 isListenPost ()
 
 get ()
 
 getHint ()
 
 setHint ($text)
 
 setEscapeType ($escape_type)
 
 getEscapeType ()
 
 unsetvalue ()
 
 validate ($value)
 
 setChecker ($callmethod, $errortxt= '')
 
 removeAllCheckers ()
 
 getCheckers ()
 
 setVisible ($bool, $switch=null)
 
 isVisible ($switch=null, $use_default_visible=true)
 
 isMeVisible ($switch=null, $use_default_visible=true)
 
 setMeVisible ($bool)
 
 getTreeList ()
 
 setTree ($tree_function,...$params)
 
 getListFunc ()
 
 setList ($listfunc,...$params)
 
 setListFromArray (array $list)
 
 setChangeSizeForList ($bool)
 
 getList ()
 
 setCheckboxView ($onValue, $offValue)
 
 setCheckboxListView ($bool)
 
 setRadioListView ($bool, $inline=false)
 
 isRadioListInline ()
 
 selfSave ()
 
 normalizePost ()
 
 addClass (string $class)
 
 setAttr (array $view_attr)
 
 getAttr ()
 
 getAttrArray ()
 
 getAttrByKey ($key)
 
 isHaveAttrKey ($key)
 
 textView ()
 
 formView ($view_options=null, $orm_object=null)
 
 setName ($name)
 
 getName ()
 
 setArrayWrap ($array_wrap_name)
 
 setFormName ($form_name)
 
 getFormName ()
 
 setMaxLength ($length)
 
 getMaxLength ()
 
 isAlwaysModify ()
 
 setAlwaysModify ($bool)
 
 setReadOnly ($readonly=true)
 
 setErrors (array $errors)
 
 getErrors ()
 
 hasErrors ()
 
 getDescription ()
 
 setDescription ($description)
 
 setUseToSave ($bool)
 
 isUseToSave ()
 
 isRuntime ()
 
 setRuntime ($bool)
 
 isAutoincrement ()
 
 setAutoincrement ($bool)
 
 hasLength ()
 
 setAllowEmpty ($bool)
 
 isAllowEmpty ()
 
 getSQLNotation ()
 
 getSQLTypeParameter ()
 
 setDecimal ($decimal)
 
 getDecimal ()
 
 setPrimaryKey ($bool)
 
 isPrimaryKey ()
 
 setUnique ($bool)
 
 isUnique ()
 
 setIndex ($bool)
 
 isIndex ()
 
 setDefault ($default, $is_func=false)
 
 getDefault ($db_format=false)
 
 isDefaultFunc ()
 
 getPhpType ()
 
 setPhpType ($type)
 
 setTemplate ($template)
 
 setMeTemplate ($template)
 
 getOriginalTemplate ()
 
 getRenderTemplate ($multiedit=false)
 
 getTitle ()
 
 setHidden ($bool)
 
 isHidden ()
 
 escape ($value)
 
 checkDefaultRequestValue ($value)
 
 setRequestType ($var_type)
 
 getFromRequest (array $src)
 
 callPropertyFunction ($property_name,...$params)
 
 setTrimString ($bool)
 
 getTrimString ()
 
 isHtmlEncodedField ()
 
 __set ($name, $value)
 
 __get ($name)
 
 __isset ($name)
 
 __unset ($name)
 
- Открытые члены унаследованные от InterfaceDeliveryOrder
 getDeliveryOrderList (Order $order)
 
 getDeliveryOrderAdminDeliveryParamsHtml (Order $order)
 

Открытые статические члены

static handbookTariffList ()
 

Поля данных

 $api
 
- Поля данных унаследованные от AbstractType
const ESCAPE_TYPE_NONE = false
 
const ESCAPE_TYPE_ENTITY = 'entity'
 
const ESCAPE_TYPE_HTML = 'html'
 
 $name
 
 $description
 
 $formtype = "input"
 

Защищенные члены

 calcDeliveryPeriod (Order $order, Address $address=null, Delivery $delivery=null)
 

Защищенные статические члены

static handbookTariffListToPvz ()
 
static handbookServices ()
 

Дополнительные унаследованные члены

- Защищенные данные унаследованные от AbstractType
 $listfunc
 
 $listfunc_param = []
 
 $tree_function
 
 $tree_function_params = []
 
 $list
 
 $parent_object
 
 $value
 
 $hidden = false
 
 $requesttype
 
 $checkers = []
 
 $use_to_save = true
 
 $read_only = false
 
 $array_wrap_name = false
 
 $form_template = '%system%/coreobject/type/form/string.tpl'
 
 $template
 
 $me_template
 
 $change_size_for_list = true
 
 $always_modify = false
 
 $errors = []
 
 $listen_post = true
 
 $hint = ''
 
 $checkbox_param = []
 
 $checkbox_list = false
 
 $radio_list = false
 
 $radio_list_inline = false
 
 $vis_form = true
 
 $me_visible
 
 $view_attr = []
 
 $php_type = ''
 
 $escape_type = self::ESCAPE_TYPE_ENTITY
 
 $runtime = false
 
 $sql_notation = ''
 
 $autoincrement = false
 
 $allowempty = true
 
 $primary_key = false
 
 $default = null
 
 $is_default_func
 
 $unique = false
 
 $index = false
 
 $has_len = true
 
 $max_len
 
 $decimal
 
 $form_name
 
 $trim_string = false
 
 $options = []
 

Методы

calcDeliveryPeriod ( Order  $order,
Address  $address = null,
Delivery  $delivery = null 
)
protected

Рассчитывает структурированную информацию по сроку, который требуется для доставки товара по заданному адресу

Аргументы
Order$order- объект заказа
Address$address- объект адреса
Delivery$delivery- объект доставки
Возвращает
DeliveryPeriod|null
Исключения
RSException
ShopException
canCalculateCostByDeliveryAddress ( Address  $address)

Возвращает true если стоимость доставки можно рассчитать на основе адреса доставки

Аргументы
Address$address- адрес
Возвращает
bool
changeDeliveryOrder ( DeliveryOrder  $delivery_order,
Order  $order 
)

Создаёт заказ доставки

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Order$order- объект заказа
Возвращает
DeliveryOrder
Исключения
ShopException
createDeliveryOrder ( Order  $order)

Создаёт заказ доставки

Аргументы
Order$order- объект заказа
Возвращает
DeliveryOrder
Исключения
RSException
ShopException

Замещает InterfaceDeliveryOrder.

deleteDeliveryOrder ( DeliveryOrder  $delivery_order)

Удаляет заказ на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
void
Исключения
ShopException

Замещает InterfaceDeliveryOrder.

executeInterfaceDeliveryOrderAction ( HttpRequest  $http_request,
Order  $order,
string  $action 
)

Исполняет действие с заказом на доставку При успехе - возвращает инструкции для вывода, при неудаче - бросает исключение

Аргументы
HttpRequest$http_request- объект запроса
Order$order- заказ
string$action- действие
Возвращает
array
Исключения
ShopException
\SmartyException

Замещает InterfaceDeliveryOrder.

executeWebHook ( HttpRequest  $http_request)

Обрабатывает запрос веб-хука

Аргументы
HttpRequest$http_request
Возвращает
string
Исключения
ShopException
getAdminHTML ( Order  $order)

Возвращает дополнительный HTML для админ части в заказе

Аргументы
Order$order- объект заказа
Возвращает
string
getDeliveryCost ( Order  $order,
Address  $address,
Delivery  $delivery,
  $use_currency = true 
)

Возвращает стоимость доставки для заданного заказа. Только число.

Аргументы
Order$order- объект заказа
Address$address- адрес доставкиamountBreakPoint
Delivery$delivery- объект доставки
boolean$use_currency- использовать валюту?
Возвращает
double
Исключения
RSException
getDeliveryOrderActions ( DeliveryOrder  $delivery_order)

Возвращает список действий, доступных для заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказка на доставку
Возвращает
array

Замещает InterfaceDeliveryOrder.

getDeliveryOrderDataLines ( DeliveryOrder  $delivery_order)

Возвращает список данных заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
array

Замещает InterfaceDeliveryOrder.

getDeliveryOrderTrackNumber ( DeliveryOrder  $delivery_order)

Возвращает трек-номер указанного заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
string|null

Замещает InterfaceDeliveryOrder.

getDescription ( )

Возвращает описание типа доставки

Возвращает
string
getFormObject ( )

todo убрать лишние поля Возвращает ORM объект для генерации формы или null

Возвращает
FormObject
getIonicMobileAdditionalHTML ( Order  $order,
Delivery  $delivery 
)

Возвращает HTML для приложения на Ionic

Аргументы
Order$order- объект заказа
Delivery$delivery- объект доставки
Возвращает
string
Исключения
\Exception
\SmartyException

Замещает InterfaceIonicMobile.

getPvzByAddress ( Address  $address)

Возвращает список ПВЗ на основе адреса

Аргументы
Address$address- адрес получателя
Возвращает
Pvz[]
getRequiredAddressFields ( )

Возвращает какие поля адреса необходимы данной доставке

Возвращает
string[]
getSelectError ( Order  $order)

Возвращает ошибки, мешающие выбрать доставку

Аргументы
Order$order- заказ
Возвращает
string
Исключения
RSException
getShortName ( )

Возвращает идентификатор данного типа доставки. (только англ. буквы)

Возвращает
string
getTitle ( )

Возвращает название расчетного модуля (типа доставки)

Возвращает
string
static handbookServices ( )
staticprotected

Справочник дополнительные услуги

Возвращает
string[]
static handbookTariffList ( )
static

Справочник тарифов

Возвращает
array[]
static handbookTariffListToPvz ( )
staticprotected

Справочник список тарифов с доставкой до ПВЗ

Возвращает
int[]
hasPvz ( )

Возвращает, поддерживает ли данный способ доставки ПВЗ

Возвращает
bool
loadOptions ( array  $opt = null)

Устанавливает настройки типа доставки

Аргументы
array | null$opt
Возвращает
void
onOrderCreate ( Order  $order,
Address  $address = null 
)

Функция срабатывает после создания заказа

Аргументы
Order$order- объект заказа
Address$address- Объект адреса
Возвращает
void
Исключения
RSException
refreshDeliveryOrder ( DeliveryOrder  $delivery_order)

Обновляет данные заказа на доставку

Аргументы
DeliveryOrder$delivery_order- объект заказа на доставку
Возвращает
void
Исключения
ShopException

Замещает InterfaceDeliveryOrder.

Поля

$api