Класс CRestProvider

Граф наследования:CRestProvider:

Открытые члены
	getDescription ()

Открытые статические члены
static	getProfile ($params, $n, CRestServer $server)
static	methodsBatch ($arQuery, $start, CRestServer $server)
static	scopeList ($arQuery, $n, CRestServer $server)
static	methodsList ($arQuery, $n, CRestServer $server)
static	appInfo ($params, $n, CRestServer $server)
static	getFeature ($params, $n, CRestServer $server)
static	appOptionGet ($params, $n, CRestServer $server)
static	appOptionSet ($params, $n, CRestServer $server)
static	userOptionGet ($params, $n, CRestServer $server)
static	userOptionSet ($params, $n, CRestServer $server)
static	getServerTime ($params)
static	OnAppEvent ($arParams, $arHandler)
static	OnAppPayment ($arParams, $arHandler)

Поля данных
const	ERROR_BATCH_LENGTH_EXCEEDED = 'ERROR_BATCH_LENGTH_EXCEEDED'
const	ERROR_BATCH_METHOD_NOT_ALLOWED = 'ERROR_BATCH_METHOD_NOT_ALLOWED'
const	LICENSE_DEFAULT = "project"
Поля данных унаследованные от IRestService
const	LIST_LIMIT = 50

Защищенные статические члены
static	getApp (CRestServer $server)
static	getScope (CRestServer $server)
Защищенные статические члены унаследованные от IRestService
static	getNavData ($start, $bORM=false)
static	setNavData ($result, $dbRes)
static	sanitizeFilter ($filter, array $availableFields=null, $valueCallback=null, array $availableOperations=null)
static	sanitizeOrder ($order, array $availableFields=null)

Статические защищенные данные
static	$licenseList
static	$arApp = null
static	$arScope = null
static	$arMethodsList = null

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

См. определение в файле rest_provider.php строка 19

Методы

appInfo()

appInfo ( $params, $n, CRestServer $server )

static

См. определение в файле rest_provider.php строка 523

appOptionGet()

appOptionGet ( $params, $n, CRestServer $server )

static

Gets application option values

Аргументы

array	$params	array([option => option_name])
int	$n	Standard pagination param
CRestServer	$server	Standard Server object link

Возвращает

array|mixed|null|string

Исключения

AccessException

См. определение в файле rest_provider.php строка 674

appOptionSet()

appOptionSet ( $params, $n, CRestServer $server )

static

Sets application options values

Аргументы

array	$params	array(option_name => option_value) || array(options => array(option_name => option_value,....))
int	$n	Standard pagination param
CRestServer	$server	Standard Server object link

Возвращает

true

Исключения

AccessException

Bitrix\Main\ArgumentOutOfRangeException

См. определение в файле rest_provider.php строка 721

getApp()

getApp ( CRestServer $server )

staticprotected

См. определение в файле rest_provider.php строка 923

getDescription()

getDescription

(

)

Переопределяет метод предка IRestService.

См. определение в файле rest_provider.php строка 64

getFeature()

getFeature ( $params, $n, CRestServer $server )

static

Return feature information.

Аргументы

	$params
	$n
CRestServer	$server

Возвращает

array

Исключения

RestException

Bitrix\Main\LoaderException

См. определение в файле rest_provider.php строка 612

getProfile()

getProfile ( $params, $n, CRestServer $server )

static

См. определение в файле rest_provider.php строка 214

getScope()

getScope ( CRestServer $server )

staticprotected

См. определение в файле rest_provider.php строка 957

getServerTime()

getServerTime ( $params )

static

См. определение в файле rest_provider.php строка 850

methodsBatch()

methodsBatch ( $arQuery, $start, CRestServer $server )

static

См. определение в файле rest_provider.php строка 257

methodsList()

methodsList ( $arQuery, $n, CRestServer $server )

static

См. определение в файле rest_provider.php строка 401

OnAppEvent()

OnAppEvent ( $arParams, $arHandler )

static

См. определение в файле rest_provider.php строка 855

OnAppPayment()

OnAppPayment ( $arParams, $arHandler )

static

См. определение в файле rest_provider.php строка 871

scopeList()

scopeList ( $arQuery, $n, CRestServer $server )

static

См. определение в файле rest_provider.php строка 385

userOptionGet()

userOptionGet ( $params, $n, CRestServer $server )

static

Gets user option values for application

Аргументы

array	$params	array([option => option_name])
int	$n	Standard pagination param
CRestServer	$server	Standard Server object link

Возвращает

array|mixed|null|string

Исключения

AccessException

См. определение в файле rest_provider.php строка 776

userOptionSet()

userOptionSet ( $params, $n, CRestServer $server )

static

Sets user options values for application

Аргументы

array	$params	array(option_name => option_value) || array(options => array(option_name => option_value,....))
int	$n	Standard pagination param.
CRestServer	$server	Standard Server object link

Возвращает

bool

Исключения

AccessException
ArgumentNullException

См. определение в файле rest_provider.php строка 814

Поля

$arApp

$arApp = null

staticprotected

См. определение в файле rest_provider.php строка 60

$arMethodsList

$arMethodsList = null

staticprotected

См. определение в файле rest_provider.php строка 62

$arScope

$arScope = null

staticprotected

См. определение в файле rest_provider.php строка 61

$licenseList

$licenseList

staticprotected

См. определение в файле rest_provider.php строка 28

ERROR_BATCH_LENGTH_EXCEEDED

const ERROR_BATCH_LENGTH_EXCEEDED = 'ERROR_BATCH_LENGTH_EXCEEDED'

См. определение в файле rest_provider.php строка 21

ERROR_BATCH_METHOD_NOT_ALLOWED

const ERROR_BATCH_METHOD_NOT_ALLOWED = 'ERROR_BATCH_METHOD_NOT_ALLOWED'

См. определение в файле rest_provider.php строка 22

LICENSE_DEFAULT

const LICENSE_DEFAULT = "project"

См. определение в файле rest_provider.php строка 25

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/rest/classes/general/rest_provider.php