Версия: 6.x
burger close
Класс GetList
Граф наследования:GetList:
AbstractGetList AbstractFilteredList AbstractAuthorizedMethod AbstractMethod

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

Возвращает товар по ID

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

 getRightTitles ()
 
 getDaoObject ()
 
 getAllowableFilterKeys ()
 
 getAllowableOrderValues ()
 
 setFilter ($dao, $filter)
 
 getResultList ($dao, $page, $pageSize)
 
 getFilterPropertyList ($category_id)
 
 getBrandsList ()
 
 setOrder ($dao, $sort)
 
 getResultCount ($dao)
 
 process ($token=null, $fulltext_filter= '', $filter=[], $sort= 'dateof desc', $page=1, $pageSize=20, $sections=['image', 'cost', 'property', 'concomitant', 'unit', 'current_currency', 'filters'])
 
- Открытые члены унаследованные от AbstractGetList
 getResultList ($dao, $page, $pageSize)
 
- Открытые члены унаследованные от AbstractFilteredList
 getRightTitles ()
 
 getAllowableFilterKeys ()
 
 getAllowableOrderValues ()
 
 getDaoObject ()
 
 getObjectSectionName ()
 
 setFilter ($dao, $filter)
 
 setOrder ($dao, $order)
 
 getResultCount ($dao)
 
- Открытые члены унаследованные от AbstractAuthorizedMethod
 validateRights ($params, $version)
 
 checkAccessError ($rights)
 
 getRunRights ()
 
 getRightTitles ()
 
 run ($params, $version=null, $lang= 'ru')
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName ($version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

Поля данных

const RIGHT_LOAD = 1
 
const RIGHT_COST_LOAD = 2
 
const FILTER_TYPE_BFILTER = 'bfilter'
 
const FILTER_TYPE_PF = 'pf'
 
const FILTER_TYPE_DIR = 'dir'
 
const FILTER_TYPE_ALREADY_BUY = 'alreadybuy'
 
 $costs_loaded = false
 
 $current_currency
 
 $dirs_x_id = []
 
 $list_products
 
 $filter_cache
 
- Поля данных унаследованные от AbstractFilteredList
const RIGHT_LOAD = 1
 
const FILTER_TYPE_EQ = 'eq'
 
const FILTER_TYPE_LIKE = 'like'
 
const FILTER_TYPE_IN = 'in'
 
- Поля данных унаследованные от AbstractAuthorizedMethod
 $token_is_invalid = false
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $params
 

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

 makeFilterBFilter ($key, $value, $filters, $filter_settings)
 
 makeFilterPF ($key, $value, $filters, $filter_settings)
 
 makeFilterAlreadyBuy ($key, $value, $filters, $filter_settings)
 
 getDirByID ($id)
 
 addImageData ($dao)
 
 addCostData ($dao)
 
- Защищенные члены унаследованные от AbstractGetList
 process ($token, $filter=[], $sort= 'id desc', $page="1", $pageSize="20")
 
- Защищенные члены унаследованные от AbstractFilteredList
 makeFilter ($filters)
 
 makeFilterEq ($key, $value, $filters, $filter_settings)
 
 makeFilterLike ($key, $value, $filters, $filter_settings)
 
 makeFilterIn ($key, $value, $filters, $filter_settings)
 
 prepareAllowableOrderValues ()
 
 makeOrder ($order)
 
 prepareDocComment ($text, $lang)
 
 prepareFilterInfo ()
 
 prepareSortInfo ()
 
- Защищенные члены унаследованные от AbstractMethod
 addMethodHelpUrlToException (\ExternalApi\Model\AbstractException $api_exception)
 
 getParamComment ($comment, $param, $lang)
 
 prepareDocComment ($text, $lang)
 
 getParamType ($comment, $param)
 
 getMethodComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 

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

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

Методы

addCostData (   $dao)
protected

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

Аргументы
mixed$dao
Возвращает
void
addImageData (   $dao)
protected

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

Аргументы
\Catalog\Model\Api$dao
Возвращает
void
getAllowableFilterKeys ( )

Возвращает возможные ключи для фильтров

Возвращает
[ 'поле' => [ 'title' => 'Описание поля. Если не указано, будет загружено описание из ORM Объекта' 'type' => 'тип значения', 'func' => 'постфикс для функции makeFilter в текущем классе, которая будет готовить фильтр, например eq', 'values' => [возможное значение1, возможное значение2] ] ]
getAllowableOrderValues ( )

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

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

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

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

Возвращает объект, который позволит производить выборку товаров

Возвращает
getDirByID (   $id)
protected

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

Аргументы
integer$id- id категории
Возвращает
array
getFilterPropertyList (   $category_id)

Возвращает список характеристик фильтров для товаров

Аргументы
integer$category_id- id категории
Возвращает
array
getResultCount (   $dao)

Возвращает общее количество элементов, согласно условию.

Аргументы
\Catalog\Model\Api$dao- объект API
Возвращает
integer
getResultList (   $dao,
  $page,
  $pageSize 
)

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

Аргументы
\Catalog\Model\Api$dao
integer$page
integer$pageSize
Возвращает
array
getRightTitles ( )

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

Возвращает
[ КОД => КОММЕНТАРИЙ, КОД => КОММЕНТАРИЙ, ... ]
makeFilterAlreadyBuy (   $key,
  $value,
  $filters,
  $filter_settings 
)
protected

Устанавливает фильтр по секции already_buy - уже покупали

Аргументы
string$key- секция фильтров
array$value- значение фильтров секции
array$filters- все фильтры
array$filter_settings- настройки фильтров
Возвращает
array
makeFilterBFilter (   $key,
  $value,
  $filters,
  $filter_settings 
)
protected

Устаналивает фильтр по секции bfilter - базовые фильтры

Аргументы
string$key- секция фильтров
array$value- значение фильтров секции
array$filters- все фильтры
array$filter_settings- настройки фильтров
Возвращает
array
makeFilterPF (   $key,
  $value,
  $filters,
  $filter_settings 
)
protected

Устаналивает фильтр по секции pf - фильтр по характеристикам

Аргументы
string$key- секция фильтров
array$value- значение фильтров секции
array$filters- все фильтры
array$filter_settings- настройки фильтров
Возвращает
array
process (   $token = null,
  $fulltext_filter = '',
  $filter = [],
  $sort = 'dateof desc',
  $page = 1,
  $pageSize = 20,
  $sections = ['image',
'cost'  ,
'property'  ,
'concomitant'  ,
'unit'  ,
'current_currency'  ,
'filters']   
)
setFilter (   $dao,
  $filter 
)

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

Аргументы
\Catalog\Model\Api$dao- api
array$filter- значение фильтров
Исключения
\RS\Exception
Возвращает
void
setOrder (   $dao,
  $sort 
)

Устанавливает сортировку при выборке

Аргументы
\Catalog\Model\Api$dao- объект текущего API
string$sort- сортировка

Поля

$costs_loaded = false
$current_currency
Catalog Model Api $dao
protected
$dirs_x_id = []
$filter_cache
$list_products
$token_require = false
protected
const FILTER_TYPE_ALREADY_BUY = 'alreadybuy'
const FILTER_TYPE_BFILTER = 'bfilter'
const FILTER_TYPE_DIR = 'dir'
const FILTER_TYPE_PF = 'pf'
const RIGHT_COST_LOAD = 2
const RIGHT_LOAD = 1