Версия: 6.x
burger close
Открытые члены | Открытые статические члены | Статические защищенные данные
Класс DeliveryApi
Граф наследования:DeliveryApi:
EntityList BaseModel

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

API функции для работы со способами доставки для текущего сайта

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

 __construct ()
 
 setZoneFilter ($zone)
 
 getCheckoutDeliveryList (User $user, Order $order, $check_public=true, $strict_to_address_filter=false)
 
 setOrderDeliveryFilters ($order)
 
 multiUpdate (array $data, $ids=[])
 
- Открытые члены унаследованные от EntityList
 __construct (AbstractObject $orm_element, array $options=[])
 
 setDefaultOrder ($order)
 
 getNameField ()
 
 setNameField ($field)
 
 setAliasField ($field)
 
 setSortField ($field)
 
 setIdField ($field)
 
 getIdField ()
 
 getSiteIdField ()
 
 setLoadOnDelete ($bool)
 
 setSiteContext ($site_id=null)
 
 getSiteContext ()
 
 setMultisite ($bool)
 
 isMultisite ()
 
 resetQueryObject ()
 
 getCleanQueryObject ()
 
 queryObj ()
 
 setQueryObj (\RS\Orm\Request $q)
 
 defAlias ()
 
 setFilter ($key, $value=null, $type= '=', $prefix= 'AND', array $options=[])
 
 clearFilter ()
 
 getList ($page=null, $page_size=null, $order=null)
 
 getListAsArray ($page=0, $page_size=0, $order= '')
 
 getListAsResource ($page=0, $page_size=0, $order= '')
 
 getPagedList ($page_size)
 
 loadAssocList ($key_field, $value=null)
 
 getAssocList ($key_field, $value=null)
 
 setOrder ($order=null, array $values=null)
 
 setGroup ($group=null)
 
 getListCount ()
 
 getFirst ()
 
 getOneItem ($id)
 
 getById ($id, $request=null)
 
 getElement ()
 
 setElement ($object)
 
 getElementClass ()
 
 getNewElement ()
 
 save ($id=null, array $user_post=[])
 
 addFilterControl (\RS\Html\Filter\Control $filter_control)
 
 addTableControl (\RS\Html\Table\Control $table_control)
 
 del (array $ids)
 
 multiDelete ($ids)
 
 getSelectList ($first=[])
 
 multieditFormView ($tpl_path, $formfile, array $addparam=[])
 
 multiUpdate (array $data, $ids=[])
 
 moveElement ($from, $to, $flag,\RS\Orm\Request $extra_expr=null)
 
 noWriteRights ($right=DefaultModuleRights::RIGHT_UPDATE)
 
 getIdByAlias ($alias_or_id, $alias_field=null)
 
 saveRequest ($key)
 
 getIdsByRequest (\RS\Orm\Request $request)
 
 __set ($name, $value)
 
 __get ($name)
 
 __isset ($name)
 
 __unset ($name)
 
- Открытые члены унаследованные от BaseModel
 addError ($message, $fieldname=null, $form=null)
 
 hasError ()
 
 getErrors ()
 
 cleanErrors ()
 
 getDisplayErrors ()
 
 getErrorsStr ()
 
 getFormErrors ($form, $separator= ', ')
 
 getNonFormErrors ($separator= ', ')
 
 exportErrors ()
 
 importErrors ($data)
 

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

static getTypes ()
 
static getTypesAssoc ()
 
static getListForOrder ()
 
static getListForPayment ()
 
static getTypeByShortName ($name)
 
static getZonesList ()
 
static getPickupPointClasses ()
 
static getPickUpPoints ($order=null)
 
static isHavePickUpPoints ($order=null)
 
static isHaveToAddressDelivery ($order=null)
 
static getCourierList ()
 
static getCourierSelectList ($root=['-Не выбрано-'])
 
- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 

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

static $types
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

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

- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 
- Защищенные члены унаследованные от EntityList
 parseArrayFilter ($filters)
 
 filterLike ($key, $value, $type, $prefix, $options)
 
 filterIs ($key, $value, $type, $prefix, $options)
 
 filterFullText ($key, $value, $type, $prefix, $options)
 
 filterIn ($key, $value, $type, $prefix, $options)
 
 filterNotin ($key, $value, $type, $prefix, $options)
 
 filterDefault ($key, $value, $type, $prefix, $options)
 
 setPage ($page, $pageSize)
 
 moveArrayUp ($arr)
 
 moveArrayDown ($arr)
 
- Защищенные данные унаследованные от EntityList
 $default_order
 
 $load_on_delete = false
 
 $id_field = 'id'
 
 $alias_field
 
 $sort_field
 
 $name_field
 
 $site_id_field = 'site_id'
 
 $is_multisite = false
 
 $site_context
 
 $def_table_alias = 'A'
 
 $obj
 
 $obj_instance
 
 $filter_active = false
 
 $multiedit_template = '%system%/coreobject/multiedit_form.tpl'
 
 $assocPlainList = []
 
 $parsePrefixes = ['&' => 'AND'
 
 $cache_alias = []
 
 $options = []
 
 $q
 
- Защищенные данные унаследованные от BaseModel
 $default_error_fieldname = 'Информация'
 

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

__construct ( )

Методы

getCheckoutDeliveryList ( User  $user,
Order  $order,
  $check_public = true,
  $strict_to_address_filter = false 
)

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

Аргументы
User$user- объект пользователя
Order$order- объект заказа
bool$check_public- возвращать только публичные доставки
bool$strict_to_address_filter- не включать самовывоз к доставкам до адреса
Возвращает
Delivery[]
static getCourierList ( )
static

Возвращает список пользователей-курьеров

Возвращает
array
static getCourierSelectList (   $root = ['- Не выбрано -'])
static

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

Аргументы
array$root- корневой элемент
Возвращает
array
static getListForOrder ( )
static

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

Возвращает
array
static getListForPayment ( )
static

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

static getPickupPointClasses ( )
static

Возвращает массив классов отвечающих за самовывоз в системе

Возвращает
string[]
static getPickUpPoints (   $order = null)
static

Возвращает список пунктов самовывоза в системе. Если передать объект заказа, то вернутся пункты подходящие под данный заказ

Аргументы
Order$order- объект заказа
Возвращает
Delivery[]
static getTypeByShortName (   $name)
static

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

Аргументы
string$name- идентификатор типа доставкиъ
Возвращает
DeliveryType
static getTypes ( )
static

Возвращает Имеющиеся в системе обработчики типов доставок.

Возвращает
DeliveryType[]
Исключения
RSException
static getTypesAssoc ( )
static

Возвращает массив ключ => название типа доставки

Возвращает
string[]
static getZonesList ( )
static
static isHavePickUpPoints (   $order = null)
static

Проверяет есть пункты самовывоза в системе. Проверяет наличие таких доставок, а затем пунктов самовывоза, если на находит доставок этого типа

Аргументы
Order$order- объект заказа
Возвращает
boolean
static isHaveToAddressDelivery (   $order = null)
static

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

Аргументы
Order$order- объект заказа
Возвращает
boolean
multiUpdate ( array  $data,
  $ids = [] 
)

Обновляет свойства у группы объектов

Аргументы
array$data- ассоциативный массив со значениями обновляемых полей
array$ids- список id объектов, которые нужно обновить
Возвращает
int - возвращает количество обновленных элементов
setOrderDeliveryFilters (   $order)

Устанавливает фильтры для отбора доставок по параметрам заказа

Аргументы
Order$order
Возвращает
bool Возвращает true, если фильтры были установлены
setZoneFilter (   $zone)

Устанавливает фильтр по магистральным поясам

Аргументы
array$zone- массив с магистральными поясами

Поля

$types
staticprotected