Версия: 6.x
burger close
Класс AbstractAuthorizedMethod
Граф наследования:AbstractAuthorizedMethod:
AbstractMethod Set getNewList getTypeList Add Clear GetList Remove Delete SetStatus SetPrice SetStock AbstractAdd AbstractFilteredList AbstractGet AbstractUpdate SessionStart Delete GetAccessTypes Update Change getList RegisterToken UnregisterToken RunAction Delete Save Add Get GetFields GetList GetPresets Save GetCartData RepeatOrder Update Address Confirm Init SetAdditionalFields SetAddress SetDelivery SetPayment GetPickupPointsList Create DoAction Get GetList Add Delete FindItem GetList AddOrderItem CreateByOneClick CreateByReservation Delete DoPaymentAction GetReceiptList GetStatus PayWithPersonalAccount Save SellOrderStatus SellStatistic SellStatisticMonth SellStatisticYears StatisticAvgOrderSum DeletePaymentMethod GetPaymentMethodsList SetDefaultPaymentMethod Reserve GetReport Delete SetStatus Add BeforeAdd Delete Action AddFunds ChangeBalance CloseTopic CreateAdminTopic CreateTopic DeleteTopic GetAdminTopicMessages GetNewMessageCount GetTopicMessages SendMessage Create Delete Get Update

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

Метод API, требующий авторизационный токен token с необходимым набором прав для выполнения

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

 validateRights ($params, $version)
 
 checkAccessError ($rights)
 
 hasRights ($rights)
 
 getRunRights ()
 
 getRightTitles ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getToken ()
 
- Открытые члены унаследованные от AbstractMethod
 __construct ()
 
 setContextVirtualApp (VirtualApp|null $virtual_app)
 
 getContextVirtualApp ()
 
 run ($params, $version=null, $lang= 'ru')
 
 getProcessFunctionName (&$version)
 
 getAcceptRequestMethod ()
 
 validateRights ($params, $version)
 
 validateParams ($params, $version)
 
 getInfo ($lang=null)
 
 getSelfMethodName ()
 

Поля данных

 $token_is_invalid = false
 
- Поля данных унаследованные от AbstractMethod
const ALLOW_ALL_METHOD = 'all'
 
const BASE_VERSION = 1
 
const DEFAULT_LANGUAGE = 'ru'
 
 $default_version
 
 $method_params = []
 
 $version
 
 $lang
 
 $params
 
 $context_virtual_app
 

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

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

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

- Защищенные члены унаследованные от AbstractMethod
 addMethodHelpUrlToException (\ExternalApi\Model\AbstractException $api_exception)
 
 getParamComment ($comment, $param, $lang)
 
 prepareDocComment ($text, $lang)
 
 getParamType ($comment, $param)
 
 getMethodComment ($comment, $lang)
 
 getMethodFullComment ($comment, $lang)
 
 getMethodReturnComment ($comment, $lang)
 
 getMethodExample ($comment, $lang)
 

Методы

checkAccessError (   $rights)

Проверяет наличие у token'а отдельных необходимых прав. Возвращает текст ошибки, если недостаточно прав

Аргументы
integer  |  array$rights- Одно или несколько прав. Проверка будет происходить с помощью ИЛИ
Возвращает
string | false
getRightTitles ( )
abstract

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

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

Возвращает список прав, требуемых для запуска метода API Для запуска метода нужно, чтобы токен обладал хотя бы одним из перечисленных здесь прав

Возвращает
[код1, код2, ...]
getToken ( )

Возвращает объект авторизационного токена, если он есть

Возвращает
AuthorizationToken|null
hasRights (   $rights)

Возвращает true, если есть права $rigths к данному методу API, иначе - false

Аргументы
string | int | array$rights
Возвращает
bool
run (   $params,
  $version = null,
  $lang = 'ru' 
)

Запускает выполнение метода

Аргументы
array$params- параметры запроса
string$version- версия АПИ
string$lang- язык ответа
Возвращает
mixed
validateRights (   $params,
  $version 
)

Проверяет права на выполнение данного метода. Метод может быть вызван, если на него есть права у пользователя (чей токен передается) или в настройках модуля ExternalAPI, также приложение, к которому привязан токен должно обладать правами на запрашиваемый метод API

Аргументы
array$params- параметры запроса
string$version- версия приложения
Исключения
ApiException
Возвращает
void

Поля

$token
protected
$token_is_invalid = false
$token_param_name = 'token'
protected
$token_require = true
protected

Если указать false, то token можно принимать опционально, чтобы давать в определенных случаях больше прав для вызова данного метода