Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс ApClient

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

 __construct (array $connection)
 
 getConnection ()
 
 call ($methodName, $additionalParams=null)
 
 batch ($actions)
 
 getErrorCollection ()
 

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

static init ()
 
static initById ($connectionId)
 

Открытые атрибуты

const SERVER_ENCODING = 'utf-8'
 
const ERROR_WRONG_ANSWER = 'WRONG_ANWSER'
 
const METHOD_BATCH = 'batch'
 
const HTTP_SOCKET_TIMEOUT = 10
 
const HTTP_STREAM_TIMEOUT = 10
 

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

 getHttpClient ()
 
 getRequestUrl ($methodName)
 
 prepareRequestData ($additionalParams)
 
 prepareRequest ($additionalParams)
 
 prepareResponse ($result)
 
 checkConnection (array $connection)
 

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

 $connection = null
 
 $errorCollection = null
 

Статические защищенные данные

static $requiredKeys = array('ENDPOINT')
 

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

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

Конструктор(ы)

◆ __construct()

__construct ( array $connection)

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

Методы

◆ batch()

batch ( $actions)

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

◆ call()

call ( $methodName,
$additionalParams = null )

Low-level function for REST method call. Returns method response including paging params and error messages.

Аргументы
string$methodNameMethod name.
array | null$additionalParamsMethod params.
Возвращает
bool|mixed
Исключения
ArgumentException
ArgumentNullException
SystemException

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

◆ checkConnection()

checkConnection ( array $connection)
protected

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

◆ getConnection()

getConnection ( )

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

◆ getErrorCollection()

getErrorCollection ( )

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

◆ getHttpClient()

getHttpClient ( )
protected

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

◆ getRequestUrl()

getRequestUrl ( $methodName)
protected

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

◆ init()

static init ( )
static

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

◆ initById()

static initById ( $connectionId)
static

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

◆ prepareRequest()

prepareRequest ( $additionalParams)
protected

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

◆ prepareRequestData()

prepareRequestData ( $additionalParams)
protected

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

◆ prepareResponse()

prepareResponse ( $result)
protected

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

Данные класса

◆ $connection

$connection = null
protected

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

◆ $errorCollection

$errorCollection = null
protected

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

◆ $requiredKeys

$requiredKeys = array('ENDPOINT')
staticprotected

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

◆ ERROR_WRONG_ANSWER

const ERROR_WRONG_ANSWER = 'WRONG_ANWSER'

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

◆ HTTP_SOCKET_TIMEOUT

const HTTP_SOCKET_TIMEOUT = 10

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

◆ HTTP_STREAM_TIMEOUT

const HTTP_STREAM_TIMEOUT = 10

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

◆ METHOD_BATCH

const METHOD_BATCH = 'batch'

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

◆ SERVER_ENCODING

const SERVER_ENCODING = 'utf-8'

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