Абстрактный класс для получения отфильтрованных списков
Открытые члены | |
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 () | |
Поля данных | |
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 | |
Защищенные члены | |
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 | ( | ) |
Возвращает возможный ключи для фильтров
getAllowableOrderValues | ( | ) |
Возвращает возможные значения для сортировки
|
abstract |
Возвращает объект выборки объектов
getObjectSectionName | ( | ) |
Возвращает название секции ответа, в которой должен вернуться список объектов
getResultCount | ( | $dao | ) |
Возвращает общее число объектов для данной выборки
\RS\Module\AbstractModel\EntityList | $dao |
getRightTitles | ( | ) |
Возвращает комментарии к кодам прав доступа
|
protected |
Возвращает условия для фильтра
array | $filters | - весь список фильтров |
ApiException |
|
protected |
Возвращает готовое условие для установки фильтра. (Тип фильтра - полное соответствие(равно))
string | $key | - поле фильтрации |
mixed | $value | - значение фильтра |
array | $filters | - весь список фильтров |
array | $filter_settings | - параметры фильтра |
|
protected |
Возвращает готовое условие для установки фильтра. (Тип фильтра - поиск через ИЛИ)
string | $key | - поле фильтрации |
mixed | $value | - значение фильтра |
array | $filters | - весь список фильтров |
array | $filter_settings | - параметры фильтра, |
|
protected |
Возвращает готовое условие для установки фильтра. (Тип фильтра - частичное совпадение like%)
string | $key | - поле фильтрации |
mixed | $value | - значение фильтра |
array | $filters | - весь список фильтров |
array | $filter_settings | - параметры фильтра, |
|
protected |
Проверяет условие для сортировки
string | $order | - направление сортирвки |
ApiException |
|
protected |
Подготавливает поля для сортировки
\RS\Event\Exception |
|
protected |
Форматирует комментарий, полученный из PHPDoc
string | $text | - комментарий |
|
protected |
Возвращает информацию по возможным ключам фильтра, основываясь на результате функции $this->getAllowableFilterKeys()
\Exception | |
\SmartyException |
|
protected |
Возвращает информацию о возможных способах сортировки, основываясь на результатах функции $this->getAllowableOrderValues()
\Exception | |
\SmartyException |
setFilter | ( | $dao, | |
$filter | |||
) |
Устанавливает фильтр для выборки
\RS\Module\AbstractModel\EntityList | $dao | |
array | $filter |
ApiException |
setOrder | ( | $dao, | |
$order | |||
) |
Устанавливает сортировку для выборки
\RS\Module\AbstractModel\EntityList | $dao | |
string | $order | - предложенная сортировка |
ApiException |
|
protected |
const FILTER_TYPE_EQ = 'eq' |
Тип фильтра - полное соответствие
const FILTER_TYPE_IN = 'in' |
const FILTER_TYPE_LIKE = 'like' |
const RIGHT_LOAD = 1 |
Право на загрузку списка объектов