Версия: 6.x
burger close
Класс OneClickApi
Граф наследования:OneClickApi:
EntityList BaseModel

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

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

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

 __construct ()
 
 checkFieldsFromPostToSend ($click_fields_manager, $use_captcha=true)
 
 send ($products)
 
 getPreparedProductsFromCart ()
 
 createOrderFromOneClick (Orm\OneClickItem $oneclick)
 
 preparedMultiOffers ($offer_fields, $product, $multioffers)
 
 prepareProductOfferFields ($product, $offer_id=null, $multioffers=[])
 
- Открытые члены унаследованные от 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)
 

Поля данных

const EXTRA_FIELDS = 'oneclickfields'
 
- Поля данных унаследованные от EntityList
const WHERE_CONDITION_VAR = 'where_conditions'
 
- Поля данных унаследованные от BaseModel
 $form_fieldname = []
 
 $errors_by_form = []
 
 $errors_non_form = []
 
 $errors = []
 

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

- Открытые статические члены унаследованные от EntityList
static getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 
- Защищенные члены унаследованные от 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 = 'Информация'
 
- Статические защищенные данные унаследованные от EntityList
static $instance = []
 

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

__construct ( )

Методы

checkFieldsFromPostToSend (   $click_fields_manager,
  $use_captcha = true 
)

Проверяет поля для отправки и заполняет массив значений перед отправкой

Аргументы
UserFieldsManager$click_fields_manager- менеджер дополнительных полей
boolean$use_captcha- Использовать каптчу
Возвращает
boolean
createOrderFromOneClick ( Orm\OneClickItem  $oneclick)

Создаёт заказ из Купить в один клик

Аргументы
Orm\OneClickItem$oneclick- объект купить в один клик
Возвращает
Order
Исключения
\RS\Db\Exception
\RS\Event\Exception
\RS\Exception
\RS\Orm\Exception
getPreparedProductsFromCart ( )

Возвращает подготовленные данные (товары) из корзины пользователя для отправки

Возвращает
array
Исключения
\RS\Event\Exception
\RS\Exception
preparedMultiOffers (   $offer_fields,
  $product,
  $multioffers 
)

Подготавливает сведения о многомерных комплектациях для отображения

Аргументы
array$offer_fields- массив доп. сведения
Orm\Product$product- объект товар
array$multioffers- массив с сведениями для установки
Возвращает
array
prepareProductOfferFields (   $product,
  $offer_id = null,
  $multioffers = [] 
)

Подготавливает

Аргументы
Product$product- объект товара
integer | null$offer_id- id комплектации если есть
array$multioffers- массив многомерных комплектаций
Возвращает
array
send (   $products)

Отсылает форму купить в один клик и предварительно проверяет её. Неоходим вызов функции checkFieldsFromPostToSend

Аргументы
array$products- массив объектов товаров со всеми сведениями. сведения о выбранной комплектации храняться в ключено offer_fields [, ...]
Возвращает
void

Поля

const EXTRA_FIELDS = 'oneclickfields'