Класс ApClient

Открытые члены
	__construct (array $connection)
	getConnection ()
	call ($methodName, $additionalParams=null)
	batch ($actions)
	getErrorCollection ()

Открытые статические члены
static	init ()
static	initById ($connectionId)

Поля данных
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 строка 13

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

__construct()

__construct

(

array

$connection

)

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

Методы

batch()

batch

(

$actions

)

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

call()

call	(		$methodName,
			$additionalParams = null )

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

Аргументы

string	$methodName	Method name.
array | null	$additionalParams	Method params.

Возвращает

bool|mixed

Исключения

ArgumentException
ArgumentNullException
SystemException

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

checkConnection()

checkConnection ( array $connection )

protected

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

getConnection()

getConnection

(

)

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

getErrorCollection()

getErrorCollection

(

)

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

getHttpClient()

getHttpClient ( )

protected

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

getRequestUrl()

getRequestUrl ( $methodName )

protected

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

init()

init ( )

static

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

initById()

initById ( $connectionId )

static

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

prepareRequest()

prepareRequest ( $additionalParams )

protected

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

prepareRequestData()

prepareRequestData ( $additionalParams )

protected

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

prepareResponse()

prepareResponse ( $result )

protected

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

Поля

$connection

$connection = null

protected

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

$errorCollection

$errorCollection = null

protected

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

$requiredKeys

$requiredKeys = array('ENDPOINT')

staticprotected

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

ERROR_WRONG_ANSWER

const ERROR_WRONG_ANSWER = 'WRONG_ANWSER'

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

HTTP_SOCKET_TIMEOUT

const HTTP_SOCKET_TIMEOUT = 10

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

HTTP_STREAM_TIMEOUT

const HTTP_STREAM_TIMEOUT = 10

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

METHOD_BATCH

const METHOD_BATCH = 'batch'

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

---

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

• C:/bitrix/modules/socialservices/lib/apclient.php