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

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

Возвращает список категорий по ID родителя

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

 getRightTitles ()
 
 getDaoObject ()
 
 getAllowableFilterKeys ()
 
 getAllowableOrderValues ()
 
 getResultList ($dao, $parent_id)
 
- Открытые члены унаследованные от AbstractGetTreeList
 getResultList ($dao, $parent_id)
 
- Открытые члены унаследованные от 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
 
 $category_list
 
- Поля данных унаследованные от 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
 

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

 process ($token=null, $parent_id=0, $filter=[], $sort= 'sortn', $sections=['image'])
 
- Защищенные члены унаследованные от AbstractGetTreeList
 process ($token, $parent_id=0, $filter=[], $sort= 'id desc')
 
- Защищенные члены унаследованные от 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
 
- Защищенные данные унаследованные от AbstractFilteredList
 $dao
 
- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

getAllowableFilterKeys ( )

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

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

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

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

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

Возвращает
getResultList (   $dao,
  $parent_id 
)

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

Аргументы
\Catalog\Model\DirApi$dao- объект API
integer$parent_id- объект API
Возвращает
array
getRightTitles ( )

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

Возвращает
[ КОД => КОММЕНТАРИЙ, КОД => КОММЕНТАРИЙ, ... ]
process (   $token = null,
  $parent_id = 0,
  $filter = [],
  $sort = 'sortn',
  $sections = ['image'] 
)
protected

Поля

$category_list
$token_require = false
protected
const RIGHT_LOAD = 1