Skip to content

client.ru.md

Latest commit

 

History

History
45 lines (29 loc) · 2.26 KB

client.ru.md

File metadata and controls

45 lines (29 loc) · 2.26 KB
Raw

Низкоуровневый клиент

Класс Comindware\Tracker\API\Client предоставляет интерфейс низкого уровня для выполнения произвольных запросов к API Comindware Tracker.

sendRequest

Вызывает методы API.

public function sendRequest(string $path [, string $method [, array $payload ]]): mixed

Список параметров

  • $path — Запрашиваемый URI относительно $baseUri, задаваемого в конструкторе. Например «/Api/Account/123».
  • $method — Метод HTTP. Если не указан, будет использован метод «GET».
  • $payload — Тело запроса в виде ассоциативного массива. Значения могут быть скалярами, массивами, либо экземплярами File.

Возвращаемые значения

В зависимости от вызываемого метода API и ответа сервера метод может возвращать строку, массив или экземпляр Psr\Http\Message\StreamInterface.

Ошибки

В случае внутренних ошибок (например, неправильное составление запроса HTTP) будет вброшено LogicException.

Если получен ответ с сообщением об ошибке API, где указан конкретный тип ошибки, будет вброшено исключение Comindware\Tracker\API\Exception\WebApiClientException или одно из дочерних.

В случае прочих ошибок (например, сервер недоступен или получен неправильный ответ), будет вброшено исключение Comindware\Tracker\API\Exception\RuntimeException.

Примеры

TODO

Журналирование

При помощи метода Client::setLogger() вы можете передать в клиент средство журналирования, поддерживающее интерфейс PSR-3.