Версия: 6.x
burger close
Открытые члены | Открытые статические члены | Поля данных | Защищенные члены | Защищенные данные | Статические защищенные данные
Класс Cdek
Граф наследования:Cdek:
AbstractType

Подробное описание

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

 __construct ()
 
 getTitle ()
 
 getDescription ()
 
 getShortName ()
 
 getRequiredAddressFields ()
 
 canCalculateCostByDeliveryAddress (Address $address)
 
 getFormObject ()
 
 getPvzByAddress (Address $address)
 
 hasPvz ()
 
 somethingWrong (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Address $address=null)
 
 actionOrderQuery (\Shop\Model\Orm\Order $order)
 
 getAdminHTML (\Shop\Model\Orm\Order $order)
 
 getAddittionalHtml (\Shop\Model\Orm\Delivery $delivery,\Shop\Model\Orm\Order $order=null)
 
 getAdminAddittionalHtml (\Shop\Model\Orm\Order $order=null)
 
 onOrderCreate (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Address $address=null, $isorderquerry=false)
 
 getDeliveryCost (Order $order, Address $address, Delivery $delivery, $use_currency=true)
 
 getSelectedPvz (Order $order)
 
 setTariffId ($id)
 
 getTariffId ()
 
 getTrackNumber (\Shop\Model\Orm\Order $order)
 
 getTrackNumberUrl (\Shop\Model\Orm\Order $order)
 
 getIonicMobileAdditionalHTML (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Delivery $delivery)
 
 getPvzList (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Address $address=null)
 
 getCityIdByName (Address $address)
 
 loadOptions (array $opt=null)
 
 getSelectError (Order $order)
 
- Открытые члены унаследованные от 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)
 

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

static getAdditionalServices ()
 
static getCitiesByCountryId ($id, $page=0)
 
static getCountries ()
 
static createCountryFile ($countryId, $data=[], $flag=false)
 

Поля данных

const API_URL = "https://integration.cdek.ru/"
 
const API_URL_CALCULATE = "http://api.cdek.ru/calculator/calculate_price_by_json.php"
 
const API_CALCULATE_VERSION = "1.0"
 
const DEVELOPER_KEY ='r5$E7UPuZG:%X$r0j8N-5bUR~go$mKFr'
 
 $log
 
- Поля данных унаследованные от AbstractType
const ESCAPE_TYPE_NONE = false
 
const ESCAPE_TYPE_ENTITY = 'entity'
 
const ESCAPE_TYPE_HTML = 'html'
 
 $name
 
 $description
 
 $formtype = "input"
 

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

 getDateExecute ($format="Y-m-d")
 
 getSecure ($date_execute)
 
 requestPochtomat (\Shop\Model\Orm\Order $order, $tariff,\Shop\Model\Orm\Address $address=null)
 
 requestGetInfo (\Shop\Model\Orm\Order $order)
 
 requestGetCallCourier ($call,\Shop\Model\Orm\Order $order)
 
 requestOrderStatus (\Shop\Model\Orm\Order $order)
 
 requestDeleteOrder (\Shop\Model\Orm\Order $order)
 
 getCurrencyByName ($name)
 
 addErrorsToOrderAdminComment ($action, $order, $errors)
 
 cdekGetCallCourierHTML (\Shop\Model\Orm\Order $order)
 
 cdekReCreateOrder (\Shop\Model\Orm\Order $order)
 
 cdekDeleteOrder (\Shop\Model\Orm\Order $order)
 
 cdekGetPrintDocument (\Shop\Model\Orm\Order $order)
 
 cdekGetPrintLabelForm (\Shop\Model\Orm\Order $order)
 
 cdekGetInfo (\Shop\Model\Orm\Order $order)
 
 cdekGetHtmlStatus (\Shop\Model\Orm\Order $order)
 
 getSelectedTariffs ()
 
 getSelectedFirstTariffId ()
 
 getSelectedFirstTariffInfo ()
 
 calcDeliveryPeriod (\Shop\Model\Orm\Order $order,\Shop\Model\Orm\Address $address=null,\Shop\Model\Orm\Delivery $delivery=null)
 
 getRightTaxForProduct (\Shop\Model\Orm\Order $order,\Catalog\Model\Orm\Product $product)
 
 getTaxRateById ($tax_id)
 
 getCountriesFromFile ()
 
 getAddressFromCityId (int $city_id)
 

Защищенные данные

 $tariffId = []
 
 $delivery_cost_info = []
 
 $cache_pochtomates
 
 $cache_city_id = []
 
 $api
 
- Защищенные данные унаследованные от 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 = []
 

Статические защищенные данные

static $cache_api_requests = []
 

Конструктор(ы)

__construct ( )

Методы

actionOrderQuery ( \Shop\Model\Orm\Order  $order)

Действие с запросами к заказу для получения дополнительной информации от доставки

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string|void
Исключения
\Exception
\RS\Db\Exception
\RS\Exception
\SmartyException
addErrorsToOrderAdminComment (   $action,
  $order,
  $errors 
)
protected

Добавляет ошибки в комментарий админа в заказе через ORM запрос

Аргументы
string$action- действие русскими словами в родительном падеже
\Shop\Model\Orm\Order$order- объект заказа
array$errors- массив ошибок из ответного XML
Исключения
\RS\Db\Exception
calcDeliveryPeriod ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Address  $address = null,
\Shop\Model\Orm\Delivery  $delivery = null 
)
protected

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

Аргументы
\Shop\Model\Orm\Order$orderобъект заказа
\Shop\Model\Orm\Address$addressобъект адреса
\Shop\Model\Orm\Delivery$deliveryобъект доставки
Возвращает
Helper | null
canCalculateCostByDeliveryAddress ( Address  $address)

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

Аргументы
Address$address- адрес
Возвращает
bool
cdekDeleteOrder ( \Shop\Model\Orm\Order  $order)
protected

Возвращает HTML виджет с печатной формой

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\RS\Db\Exception
\RS\Exception
\SmartyException
cdekGetCallCourierHTML ( \Shop\Model\Orm\Order  $order)
protected

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

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\RS\Exception
\SmartyException
cdekGetHtmlStatus ( \Shop\Model\Orm\Order  $order)
protected

Возвращает HTML виджет со статусом заказа для админки

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\SmartyException
cdekGetInfo ( \Shop\Model\Orm\Order  $order)
protected

Возвращает HTML виджет с информацией о заказе

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\SmartyException
cdekGetPrintDocument ( \Shop\Model\Orm\Order  $order)
protected

Возвращает HTML виджет с печатной формой

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\SmartyException
cdekGetPrintLabelForm ( \Shop\Model\Orm\Order  $order)
protected

Возвращает печать ШК-места

Аргументы
Order$order
Возвращает
string
Исключения
\SmartyException
cdekReCreateOrder ( \Shop\Model\Orm\Order  $order)
protected

Пересоздаёт заказ в СДЭК

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
Исключения
\Exception
\RS\Db\Exception
\RS\Exception
\SmartyException
static createCountryFile (   $countryId,
  $data = [],
  $flag = false 
)
static

Создает файл страны с городами СДЕК

Аргументы
$countryId
array$data
bool$flag
static getAdditionalServices ( )
static

Получает массив доп. услуг

Возвращает
array
getAddittionalHtml ( \Shop\Model\Orm\Delivery  $delivery,
\Shop\Model\Orm\Order  $order = null 
)

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

Аргументы
\Shop\Model\Orm\Delivery$delivery- объект доставки
\Shop\Model\Orm\Order$order- заказ доставки
Возвращает
string
Исключения
\Exception
\SmartyException
getAddressFromCityId ( int  $city_id)
protected
getAdminAddittionalHtml ( \Shop\Model\Orm\Order  $order = null)

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

Аргументы
\Shop\Model\Orm\Order$order- заказ доставки
Возвращает
string
Исключения
\Exception
\SmartyException
getAdminHTML ( \Shop\Model\Orm\Order  $order)

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

Аргументы
\Shop\Model\Orm\Order$order- заказ доставки
Возвращает
string
Исключения
\Exception
\SmartyException
static getCitiesByCountryId (   $id,
  $page = 0 
)
static

Функция актуализации городов СДЕК по API

Аргументы
$id
int$page
Возвращает
mixed
getCityIdByName ( Address  $address)

Возвращает id города в базе СДЭК, или false

Аргументы
Address$address
Возвращает
string|false
static getCountries ( )
static

Получение стран доступных в СДЕК API

Возвращает
string[]
getCountriesFromFile ( )
protected

Получение закэшированных город сдек

Возвращает
mixed
getCurrencyByName (   $name)
protected

Получает валюту по имени этой волюты пришедшей из СДЭК

Аргументы
string$name- сокращённое название валюты из СДЭК
Возвращает
mixed
Исключения
\RS\Orm\Exception
getDateExecute (   $format = "Y-m-d")
protected

Получение кода защиты для СДЭК запросов

Аргументы
string$format- формат даты отправления
Возвращает
false|string
getDeliveryCost ( Order  $order,
Address  $address,
Delivery  $delivery,
  $use_currency = true 
)

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

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

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

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

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

Возвращает
| null
getIonicMobileAdditionalHTML ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Delivery  $delivery 
)

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

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
\Shop\Model\Orm\Delivery$delivery- объект доставки
Возвращает
string
Исключения
\Exception
\RS\Event\Exception
\SmartyException
getPvzByAddress ( Address  $address)

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

Аргументы
Address$address- адрес получателя
Возвращает
Pvz[]
getPvzList ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Address  $address = null 
)

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

Аргументы
\Shop\Model\Orm\Order$order
Возвращает
array|boolean
getRequiredAddressFields ( )

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

Возвращает
string[]
getRightTaxForProduct ( \Shop\Model\Orm\Order  $order,
\Catalog\Model\Orm\Product  $product 
)
protected

Возвращает правильный идентификатор налога

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
\Catalog\Model\Orm\Product$product- объект товара
Возвращает
string
getSecure (   $date_execute)
protected

Получает секретный код основанный на MD5 и текущей дате

Аргументы
string$date_execute- дата для ключа
Возвращает
string
getSelectedFirstTariffId ( )
protected

Возвращет первый выбранный пользователем тариф

Возвращает
integer
getSelectedFirstTariffInfo ( )
protected

Возвращает информацию по первому выбранному тарифу пользователем

Возвращает
false|array
getSelectedPvz ( Order  $order)

Возвращает указанный в заказе ПВЗ

Аргументы
Order$order- заказ
Возвращает
Pvz|null
getSelectedTariffs ( )
protected

Получает выбранные тарифы для отправки доставки

Возвращает
array
getSelectError ( Order  $order)

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

Аргументы
Order$order- заказ
Возвращает
string
getShortName ( )

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

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

Получает id тарифа по которому будет произведена доставка после подсчёта стоимости

getTaxRateById (   $tax_id)
protected

Возвращает ставку налога по идентификатору

Аргументы
string$tax_id
Возвращает
float
getTitle ( )

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

Возвращает
string
getTrackNumber ( \Shop\Model\Orm\Order  $order)

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

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
bool
getTrackNumberUrl ( \Shop\Model\Orm\Order  $order)

Возвращает ссылку на отслеживание заказа

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
string
hasPvz ( )

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

Возвращает
bool
loadOptions ( array  $opt = null)
onOrderCreate ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Address  $address = null,
  $isorderquerry = false 
)

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

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
\Shop\Model\Orm\Address$address- Объект адреса
Возвращает
void
Исключения
\RS\Db\Exception
\RS\Exception
requestDeleteOrder ( \Shop\Model\Orm\Order  $order)
protected

Запрос на удаление заказа

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
Исключения
\RS\Exception
requestGetCallCourier (   $call,
\Shop\Model\Orm\Order  $order 
)
protected

Запрос вызова курьера

Аргументы
array$call- массив со сведениями об отправке
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
Исключения
\RS\Exception
requestGetInfo ( \Shop\Model\Orm\Order  $order)
protected

Запрос на информацию по заказу

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
Исключения
\RS\Exception
requestOrderStatus ( \Shop\Model\Orm\Order  $order)
protected

Запрос статусов заказа

Аргументы
\Shop\Model\Orm\Order$order- объект заказа
Возвращает
Исключения
\RS\Exception
requestPochtomat ( \Shop\Model\Orm\Order  $order,
  $tariff,
\Shop\Model\Orm\Address  $address = null 
)
protected

Отправляет запрос на получение почтоматов для забора товара пользователем

Аргументы
Order$order- объект заказа
Address$address- объект адреса
array$tariff- массив сведений по тарифу
Возвращает
array
setTariffId (   $id)

Устанавливает тариф по которому будет произведена доставка после подсчёта стоимости

Аргументы
integer$id
somethingWrong ( \Shop\Model\Orm\Order  $order,
\Shop\Model\Orm\Address  $address = null 
)

Возвращает текст, в случае если доставка невозможна. false - в случае если доставка возможна

Аргументы
\Shop\Model\Orm\Order$order
\Shop\Model\Orm\Address$address- Адрес доставки
Возвращает
bool|mixed|string
Исключения
\RS\Exception

Поля

$api
protected
$cache_api_requests = []
staticprotected
$cache_city_id = []
protected
$cache_pochtomates
protected
$delivery_cost_info = []
protected
$log
$tariffId = []
protected
const API_CALCULATE_VERSION = "1.0"
const API_URL = "https://integration.cdek.ru/"
const API_URL_CALCULATE = "http://api.cdek.ru/calculator/calculate_price_by_json.php"
const DEVELOPER_KEY ='r5$E7UPuZG:%X$r0j8N-5bUR~go$mKFr'