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

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

 __construct (HttpClient $httpClient, ContextInterface $context)
 
 request (string $method, string $uri, array $params)
 
 get (string $uri, array $params=[])
 
 post (string $uri, array $params=[])
 
 delete (string $uri, array $params=[])
 
 put (string $uri, array $params=[])
 
 patch (string $uri, array $params=[])
 

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

 multipartDecode (string $response, string $boundary)
 
 prepareParams (array $params)
 
 formatParams (array $params)
 
 prepareResponse ()
 

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

HttpClient $httpClient
 
RequestLogger $logger
 

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

Low level controller for working with rest-api.

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

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

◆ __construct()

__construct ( HttpClient $httpClient,
ContextInterface $context )
Аргументы
HttpClient$httpClient
Office365Context$context

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

Методы

◆ delete()

delete ( string $uri,
array $params = [] )
Аргументы
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

◆ formatParams()

formatParams ( array $params)
protected
Аргументы
array$params
Возвращает
string|null
Исключения
ArgumentException

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

◆ get()

get ( string $uri,
array $params = [] )
Аргументы
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

◆ multipartDecode()

multipartDecode ( string $response,
string $boundary )
protected
Аргументы
string$response
string | null$boundary
Возвращает
array

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

◆ patch()

patch ( string $uri,
array $params = [] )
Аргументы
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

◆ post()

post ( string $uri,
array $params = [] )
Аргументы
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

◆ prepareParams()

prepareParams ( array $params)
protected
Аргументы
array$params
Возвращает
string|null
Исключения
ArgumentException

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

◆ prepareResponse()

prepareResponse ( )
protected
Возвращает
array|mixed
Исключения
ArgumentException

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

◆ put()

put ( string $uri,
array $params = [] )
Аргументы
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

◆ request()

request ( string $method,
string $uri,
array $params )
Аргументы
string$method
string$uri
array$params
Возвращает
array
Исключения
ApiException
ArgumentException
AuthException
ConflictException
GoneException
NotFoundException

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

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

◆ $httpClient

HttpClient $httpClient
protected

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

◆ $logger

RequestLogger $logger
protected

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