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

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

Абстрактный класс для загрузки списка объектов

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

 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')
 
 getToken ()
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName ($version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

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

 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)
 

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

- Поля данных унаследованные от 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
 
- Защищенные данные унаследованные от AbstractFilteredList
 $dao
 
- Защищенные данные унаследованные от AbstractAuthorizedMethod
 $token_require = true
 
 $token_param_name = 'token'
 
 $token
 
- Защищенные данные унаследованные от AbstractMethod
 $external_api_config
 

Методы

getResultList (   $dao,
  $page,
  $pageSize 
)

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

Аргументы
\RS\Module\AbstractModel\EntityList$dao
integer$page
integer$pageSize
Возвращает
array
process (   $token,
  $filter = [],
  $sort = 'id desc',
  $page = "1",
  $pageSize = "20" 
)
protected

Выполняет запрос на выборку объектов

Аргументы
string$token- авторизовационный токен
array$filter- массив из фильтров для применения
string$sort- сортировка
string$page- текущий номер страницы
string$pageSize- размер элементов в порции
Возвращает
array Возвращает список объектов и связанные с ним сведения.
Исключения
\ExternalApi\Model\Exception