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

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

Получает товары из избранного для пользователя

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

 __construct ()
 
 getRightTitles ()
 
 validateRights ($params, $version)
 
 process ($token=null, $page=1, $pageSize=20, $sections=['image', 'cost', 'property', 'current_currency', 'unit'])
 
- Открытые члены унаследованные от AbstractAuthorizedMethod
 validateRights ($params, $version)
 
 checkAccessError ($rights)
 
 hasRights ($rights)
 
 getRunRights ()
 
 getRightTitles ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getToken ()
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 setContextVirtualApp (VirtualApp|null $virtual_app)
 
 getContextVirtualApp ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName (&$version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

Поля данных

const RIGHT_FAVORITE = 1
 
const RIGHT_COST_LOAD = 2
 
 $token_error = []
 
 $product_api
 
 $favorite_api
 
- Поля данных унаследованные от AbstractAuthorizedMethod
 $token_is_invalid = false
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $lang
 
 $params
 
 $context_virtual_app
 

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

 addImageData ($list)
 
 addCostData ($list)
 
 getDirByID ($id)
 
 getList ($page, $pageSize)
 
- Защищенные члены унаследованные от AbstractMethod
 addMethodHelpUrlToException (\ExternalApi\Model\AbstractException $api_exception)
 
 getParamComment ($comment, $param, $lang)
 
 prepareDocComment ($text, $lang)
 
 getParamType ($comment, $param)
 
 getMethodComment ($comment, $lang)
 
 getMethodFullComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 

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

 $token_require = false
 
 $dirs_x_id = []
 
- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

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

__construct ( )

Методы

addCostData (   $list)
protected

Добавляет секцию с ценами к товару

Аргументы
array$list- массив товаров
Возвращает
array
addImageData (   $list)
protected

Добавляет секцию с изображениями к товару

Аргументы
array$list- массив товаров
Возвращает
array
getDirByID (   $id)
protected

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

Аргументы
integer$id- id категории
Возвращает
array
getList (   $page,
  $pageSize 
)
protected

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

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

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

Возвращает
[ КОД => КОММЕНТАРИЙ, КОД => КОММЕНТАРИЙ, ... ]
process (   $token = null,
  $page = 1,
  $pageSize = 20,
  $sections = ['image',
'cost'  ,
'property'  ,
'current_currency'  ,
'unit']   
)
validateRights (   $params,
  $version 
)

Проверяет права на выполнение данного метода

Аргументы
array$params- массив приходящих параметров
string$version- текущая версия
Исключения
ApiException

Поля

$dirs_x_id = []
protected
$favorite_api
$product_api
$token_error = []
$token_require = false
protected
const RIGHT_COST_LOAD = 2
const RIGHT_FAVORITE = 1