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

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

Класс определяет объект - избранные товары

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

 __construct ()
 
 addToFavorite ($product_id)
 
 loadInFavoriteList ()
 
 alreadyInFavorite ($product_id)
 
 getGuestId ()
 
 getUserId ()
 
 getFavoriteCount ()
 
 getFavoriteList ($page=1, $pageSize=null)
 
 mergeFavorites ()
 
 removeFromFavorite ($product_id)
 
 removeAllFromFavorite ()
 
 setGuestId ($guest_id)
 
 setUserId ($user_id)
 
 cleanLocalCache ()
 
- Открытые члены унаследованные от 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)
 

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

 $user_id
 
 $guest_id
 
 $cache
 
- Защищенные данные унаследованные от 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 getInstance ($key= 'default')
 
static staticSelectList ($first=[])
 
static getSavedRequest ($key, $default=null)
 
- Поля данных унаследованные от 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
static $instance = []
 

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

__construct ( )

Методы

addToFavorite (   $product_id)

Добавляет товар в избранное

Аргументы
int$product_id- id товара
Возвращает
void
alreadyInFavorite (   $product_id)

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

Аргументы
$product_id
Возвращает
bool
cleanLocalCache ( )

Очищает локальный кэш Кэш применяется для ускорения метода alreadyInFavorite

getFavoriteCount ( )

Возвращает количество товаров в избранном

Возвращает
int
getFavoriteList (   $page = 1,
  $pageSize = null 
)

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

Аргументы
integer$pageномер страницы
integer$pageSizeколичество элементов на странице
Возвращает
array
getGuestId ( )

Возвращает установленный $guest_id если $guest_id не установлен - возврщает идентификатор текущего гостя

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

Возвращает установленный $user_id если $user_id не установлен - возврщает id текущего пользователя

Возвращает
int
loadInFavoriteList ( )

Загружает список товаров в избранном у данного пользователя

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

Сливает избранные товары гостя с избранным пользователя

вызывается при авторизации

removeAllFromFavorite ( )

Удаляет все товары из избранного

removeFromFavorite (   $product_id)

Удаляет товар из избранного

Аргументы
int$product_id- id товара
setGuestId (   $guest_id)

Устанавливает $guest_id для дальнейшего использования

Аргументы
int$guest_id- id гостя
setUserId (   $user_id)

Устанавливает $user_id для дальнейшего использования

Аргументы
int$user_id- id пользователя

Поля

$cache
protected
$guest_id
protected
$user_id
protected