Открытые статические члены
static	sendHeaders ()
static	getStandardParams ()
static	getRequestData ()
static	isAdmin (?int $userId=null)
static	canInstallApplication ($appInfo=null, ?int $userId=null)
static	appCanBeInstalledByUser (array $appInfo)
static	getInstallAccessList ()
static	setInstallAccessList ($accessList)
static	notifyInstall ($appInfo)
static	signLicenseRequest (array $request, $licenseKey)
static	ConvertDate ($dt)
static	ConvertDateTime ($dt)
static	unConvertDate ($iso8601)
static	unConvertDateTime ($iso8601, $enableOffset=false)
static	getMemberId ()
static	isStatic ($url)
static	GetFile ($fileId, $resizeParam=false)
static	ParseBatchQuery ($query, $arResult)
static	getAuthForEvent ($appId, $userId, array $additionalData=array())
static	getAuth ($appId, $appSecret, $scope, $additionalParams, $user_id=0)
static	checkAuth ($query, $scope, &$res)
static	makeAuth ($res, $application_id=null)
static	checkAppAccess ($appId, $appInfo=null)
static	updateAppStatus (array $tokenInfo)
static	saveFile ($fileContent, $fileName="")
static	CleanApp ($appId, $bClean)
static	InstallApp ($code)
static	UpdateApp ($appId, $oldVersion)
static	getScopeList (array $description=null)
static	getEventList (array $description=null)
static	getApplicationToken (array $application)
static	getDownloadUrl ($query, \CRestServer $server)
static	getLanguage ()
static	getUploadUrl ($query, \CRestServer $server)
static	getSpecialUrl ($method, $query, \CRestServer $server)
static	getWebhookEndpoint ($ap, $userId, $method='')
static	getEndpoint ()
static	getAdministratorIdList ()
static	getApplicationPage ($id, $type='ID', $appInfo=null)
static	isSlider ()

Поля данных
const	GLOBAL_SCOPE = '_global'
const	EVENTS = '_events'
const	PLACEMENTS = '_placements'
const	HANDLER_SESSION_TTL = 7
const	BATCH_MAX_LENGTH = 50
const	METHOD_DOWNLOAD = "download"
const	METHOD_UPLOAD = "upload"
const	TOKEN_DELIMITER = "\|"
const	BITRIX_1C_APP_CODE = 'bitrix.1c'
const	PLACEMENT_APP_URI = 'REST_APP_URI'

Защищенные статические члены
static	processBatchElement ($query, $arResult, $keysCache='')
static	processBatchStructure ($queryParams, $arResult, $keysCache=null)

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

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

Методы

◆ appCanBeInstalledByUser()

appCanBeInstalledByUser ( array $appInfo )

static

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

◆ canInstallApplication()

canInstallApplication	(		$appInfo = null,
		?int	$userId = null )

static

Аргументы

	$appInfo
int \| null	$userId	- if not set - check system user

Возвращает: bool|mixed

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

◆ checkAppAccess()

checkAppAccess	(		$appId,
			$appInfo = null )

static

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

◆ checkAuth()

checkAuth	(		$query,
			$scope,
		&	$res )

static

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

◆ CleanApp()

CleanApp	(		$appId,
			$bClean )

static

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

◆ ConvertDate()

ConvertDate ( $dt )

static

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

◆ ConvertDateTime()

ConvertDateTime ( $dt )

static

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

◆ getAdministratorIdList()

getAdministratorIdList ( )

static

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

◆ getApplicationPage()

getApplicationPage	(	$id,
		$type = 'ID',
		$appInfo = null )

static

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

◆ getApplicationToken()

getApplicationToken ( array $application )

static

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

◆ getAuth()

getAuth	(	$appId,
		$appSecret,
		$scope,
		$additionalParams,
		$user_id = 0 )

static

use \Bitrix\Rest\OAuth\Auth::get

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

◆ getAuthForEvent()

getAuthForEvent	(		$appId,
			$userId,
		array	$additionalData = array() )

static

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

◆ getDownloadUrl()

getDownloadUrl	(		$query,
		\CRestServer	$server )

static

Generates link to file download

Аргументы

array \| string	$query	Params, which will be transferred to download handler
CRestServer	$server	REST Server object

Возвращает: string Absolute file download URL.

Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\LoaderException

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

◆ getEndpoint()

getEndpoint ( )

static

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

◆ getEventList()

getEventList ( array $description = null )

static

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

◆ GetFile()

GetFile	(		$fileId,
			$resizeParam = false )

static

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

◆ getInstallAccessList()

getInstallAccessList ( )

static

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

◆ getLanguage()

getLanguage ( )

static

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

◆ getMemberId()

getMemberId ( )

static

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

◆ getRequestData()

getRequestData ( )

static

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

◆ getScopeList()

getScopeList ( array $description = null )

static

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

◆ getSpecialUrl()

getSpecialUrl	(		$method,
			$query,
		\CRestServer	$server )

static

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

◆ getStandardParams()

getStandardParams ( )

static

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

◆ getUploadUrl()

getUploadUrl	(		$query,
		\CRestServer	$server )

static

Generates link to file upload

Аргументы

array \| string	$query	Params, which will be transferred to upload handler
CRestServer	$server	REST Server object

Возвращает: string Absolute file download URL.

Исключения

Bitrix\Main\ArgumentNullException

Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\LoaderException

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

◆ getWebhookEndpoint()

getWebhookEndpoint	(	$ap,
		$userId,
		$method = '' )

static

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

◆ InstallApp()

InstallApp ( $code )

static

Simple app installation without checks.

Аргументы

string $appCode Application code.

Возвращает: boolean

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

◆ isAdmin()

isAdmin ( ?int $userId = null )

static

Аргументы

int | null $userId - if not set - check system user

Возвращает: bool

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

◆ isSlider()

isSlider ( )

static

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

◆ isStatic()

isStatic ( $url )

static

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

◆ makeAuth()

makeAuth	(		$res,
			$application_id = null )

static

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

◆ notifyInstall()

notifyInstall ( $appInfo )

static

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

◆ ParseBatchQuery()

ParseBatchQuery	(		$query,
			$arResult )

static

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

◆ processBatchElement()

processBatchElement	(	$query,
		$arResult,
		$keysCache = '' )

staticprotected

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

◆ processBatchStructure()

processBatchStructure	(	$queryParams,
		$arResult,
		$keysCache = null )

staticprotected

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

◆ saveFile()

saveFile	(		$fileContent,
			$fileName = "" )

static

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

◆ sendHeaders()

sendHeaders ( )

static

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

◆ setInstallAccessList()

setInstallAccessList ( $accessList )

static

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

◆ signLicenseRequest()

signLicenseRequest	(	array	$request,
			$licenseKey )

static

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

◆ unConvertDate()

unConvertDate ( $iso8601 )

static

Аргументы

string $iso8601 date in ISO-8601 format (for example: '2013-05-14T12:00:50+04:00')

Возвращает: string date in Bitrix format, or FALSE (bool) on error

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

◆ unConvertDateTime()

unConvertDateTime	(		$iso8601,
			$enableOffset = false )

static

Аргументы

string	$iso8601	Datetime in ISO-8601 format (for example: '2013-05-14T12:00:50+04:00').
bool	$enableOffset	Add user timezone offset. If $enableOffset == false, time in server timezone will be returned. If $enableOffset == true, time in user timezone will be returned.

Возвращает: string datetime in Bitrix format, or FALSE (bool) on error

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

◆ UpdateApp()

UpdateApp	(		$appId,
			$oldVersion )

static

use \Bitrix\Rest\AppTable::update

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

◆ updateAppStatus()

updateAppStatus ( array $tokenInfo )

static

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

Поля

◆ BATCH_MAX_LENGTH

const BATCH_MAX_LENGTH = 50

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

◆ BITRIX_1C_APP_CODE

const BITRIX_1C_APP_CODE = 'bitrix.1c'

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

◆ EVENTS

const EVENTS = '_events'

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

◆ GLOBAL_SCOPE

const GLOBAL_SCOPE = '_global'

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

◆ HANDLER_SESSION_TTL

const HANDLER_SESSION_TTL = 7

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

◆ METHOD_DOWNLOAD

const METHOD_DOWNLOAD = "download"

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

◆ METHOD_UPLOAD

const METHOD_UPLOAD = "upload"

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

◆ PLACEMENT_APP_URI

const PLACEMENT_APP_URI = 'REST_APP_URI'

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

◆ PLACEMENTS

const PLACEMENTS = '_placements'

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

◆ TOKEN_DELIMITER

const TOKEN_DELIMITER = "|"

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

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

C:/bitrix/modules/rest/classes/general/rest_util.php

Открытые статические члены

Поля данных

Защищенные статические члены

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

Методы

◆ appCanBeInstalledByUser()

◆ canInstallApplication()

◆ checkAppAccess()

◆ checkAuth()

◆ CleanApp()

◆ ConvertDate()

◆ ConvertDateTime()

◆ getAdministratorIdList()

◆ getApplicationPage()

◆ getApplicationToken()

◆ getAuth()

◆ getAuthForEvent()

◆ getDownloadUrl()

◆ getEndpoint()

◆ getEventList()

◆ GetFile()

◆ getInstallAccessList()

◆ getLanguage()

◆ getMemberId()

◆ getRequestData()

◆ getScopeList()

◆ getSpecialUrl()

◆ getStandardParams()

◆ getUploadUrl()

◆ getWebhookEndpoint()

◆ InstallApp()

◆ isAdmin()

◆ isSlider()

◆ isStatic()

◆ makeAuth()

◆ notifyInstall()

◆ ParseBatchQuery()

◆ processBatchElement()

◆ processBatchStructure()

◆ saveFile()

◆ sendHeaders()

◆ setInstallAccessList()

◆ signLicenseRequest()

◆ unConvertDate()

◆ unConvertDateTime()

◆ UpdateApp()

◆ updateAppStatus()

Поля

◆ BATCH_MAX_LENGTH

◆ BITRIX_1C_APP_CODE

◆ EVENTS

◆ GLOBAL_SCOPE

◆ HANDLER_SESSION_TTL

◆ METHOD_DOWNLOAD

◆ METHOD_UPLOAD

◆ PLACEMENT_APP_URI

◆ PLACEMENTS

◆ TOKEN_DELIMITER