Версия: 5.x
Класс AbstractFilteredList
Граф наследования:AbstractFilteredList:
AbstractAuthorizedMethod AbstractMethod GetList AbstractGetList AbstractGetTreeList GetList GetList GetList GetList GetList GetList GetList GetList GetList GetList GetList GetAddresses GetCourierList GetList GetCategoryList GetList GetList

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

Абстрактный класс для получения отфильтрованных списков

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

 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 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 = array()
 
 $version
 
 $params
 

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

 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)
 

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

 $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 ( )
abstract

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

Возвращает
getObjectSectionName ( )

Возвращает название секции ответа, в которой должен вернуться список объектов

Возвращает
string
getResultCount (   $dao)

Возвращает общее число объектов для данной выборки

Аргументы
\RS\Module\AbstractModel\EntityList$dao
Возвращает
integer
getRightTitles ( )

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

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

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

Аргументы
array$filters- весь список фильтров
Возвращает
array
Исключения
ApiException
makeFilterEq (   $key,
  $value,
  $filters,
  $filter_settings 
)
protected

Возвращает готовое условие для установки фильтра. (Тип фильтра - полное соответствие(равно))

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

Возвращает готовое условие для установки фильтра. (Тип фильтра - поиск через ИЛИ)

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

Возвращает готовое условие для установки фильтра. (Тип фильтра - частичное совпадение like%)

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

Проверяет условие для сортировки

Аргументы
string$order- направление сортирвки
Возвращает
string
Исключения
ApiException
prepareAllowableOrderValues ( )
protected

Подготавливает поля для сортировки

Возвращает
array
Исключения
RS
prepareDocComment (   $text,
  $lang 
)
protected

Форматирует комментарий, полученный из PHPDoc

Аргументы
string$text- комментарий
Возвращает
string
prepareFilterInfo ( )
protected

Возвращает информацию по возможным ключам фильтра, основываясь на результате функции $this->getAllowableFilterKeys()

Возвращает
string готовый HTML код
Исключения
Exception
SmartyException
prepareSortInfo ( )
protected

Возвращает информацию о возможных способах сортировки, основываясь на результатах функции $this->getAllowableOrderValues()

Возвращает
string готовый HTML код
Исключения
Exception
SmartyException
setFilter (   $dao,
  $filter 
)

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

Аргументы
\RS\Module\AbstractModel\EntityList$dao
array$filter
Исключения
ApiException
setOrder (   $dao,
  $order 
)

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

Аргументы
\RS\Module\AbstractModel\EntityList$dao
string$order- предложенная сортировка
Исключения
ApiException

Поля

RS Module AbstractModel EntityList $dao
protected
const FILTER_TYPE_EQ = 'eq'

Тип фильтра - полное соответствие

const FILTER_TYPE_IN = 'in'
const FILTER_TYPE_LIKE = 'like'
const RIGHT_LOAD = 1

Право на загрузку списка объектов