Версия: 6.x
burger close
Класс Requester

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

Класс, необходимый для выполнения запросов к провайдеру телефонии.

В случае если AccessToken протух, умеет обновлять токен и повторять запрос автоматически Позволяет логировать запросы.

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

 __construct ($provider)
 
 getProvider ()
 
 clean ()
 
 addHeader ($key, $value)
 
 getHeader ($key=null)
 
 removeHeader ($key)
 
 setMethod ($method)
 
 getMethod ()
 
 setData ($data)
 
 getData ()
 
 getHeadersInline ()
 
 setAuthorizeCallback ($callback)
 
 authorize ($force=false)
 
 request ($url, $auto_auth=true, $retry=true, $no_log_response_content=false)
 
 logRequestHeader ($url, $context)
 

Поля данных

 $retry_status_code_min = 400
 
 $retry_status_code_max = 499
 

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

__construct (   $provider)

Методы

addHeader (   $key,
  $value 
)

Добавляет заголовок

Аргументы
$key
$value
authorize (   $force = false)

Выполняет авторизацию

Аргументы
bool$force
clean ( )

Сбрасывает установленные ранее заголовки, данные и метод запроса

Возвращает
self
getData ( )

Возвращает массив с данными для запроса

Возвращает
array
getHeader (   $key = null)

Возвращает заголовки

Аргументы
$key
Возвращает
array|mixed
getHeadersInline ( )

Возвращает заголовки, которые необходимо добавить в запрос

Возвращает
string
getMethod ( )

Возвращает метод запроса

Аргументы
$method
Возвращает
string
getProvider ( )

Возвращает объект провайдера телефонии, запросы к которому будут логироваться

Возвращает
Provider
logRequestHeader (   $url,
  $context 
)

Записывает в лог-файл заголовок происходящего звонка

Аргументы
$url
$context
removeHeader (   $key)

Удаляет заголовок с ключем $key

Аргументы
$key
request (   $url,
  $auto_auth = true,
  $retry = true,
  $no_log_response_content = false 
)

Выполняет запрос на удаленный сервер

Аргументы
string$urlURL запроса
bool$auto_authЕсли true, то предварительно будет вызываться метод установки авторизации
bool$retryЕсли true, то при получении статуса ответа в диапазоне $retry_status_code_min и $retry_status_code_max, будет повторно вызван метод установки авторизации с флагом force
bool$no_log_response_contentЕсли true, то в лог не будет сохраняться тело ответа. (нужно, если возвращаются бинарные данные)
Возвращает
RequesterResult
setAuthorizeCallback (   $callback)

Устанавливает callback, который будет получать accessToken и устанавливать его в параметры запроса текущего объекта

Аргументы
$callback
setData (   $data)

Устанавливает массив с данными для запроса

Аргументы
$data
Возвращает
self
setMethod (   $method)

Устанавливает метод запроса GET, POST, PUT, DELETE ...

Аргументы
$method

Поля

$retry_status_code_max = 499
$retry_status_code_min = 400