[ Index ]

PHP Cross Reference of YOURLS

title

Body

[close]

/includes/vendor/maxmind/web-service-common/src/WebService/ -> Client.php (summary)

(no description)

File Size: 546 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Client:: (14 methods):
  __construct()
  post()
  get()
  userAgent()
  createRequest()
  handleResponse()
  jsonErrorDescription()
  urlFor()
  handle4xx()
  handleWebServiceError()
  handle5xx()
  handleUnexpectedStatus()
  handleSuccess()
  getCaBundle()


Class: Client  - X-Ref

This class is not intended to be used directly by an end-user of a
MaxMind web service. Please use the appropriate client API for the service
that you are using.

__construct(int $accountId,string $licenseKey,array $options = [])   X-Ref

param: int    $accountId  your MaxMind account ID
param: string $licenseKey your MaxMind license key
param: array  $options    an array of options. Possible keys:

post(string $service, string $path, array $input)   X-Ref

return: array|null The decoded content of a successful response
param: string $service name of the service querying
param: string $path    the URI path to use
param: array  $input   the data to be posted as JSON

get(string $service, string $path)   X-Ref
No description

userAgent()   X-Ref
No description

createRequest(string $path, array $headers = [])   X-Ref
No description

handleResponse(int $statusCode,?string $contentType,?string $responseBody,string $service,string $path)   X-Ref

return: array|null The decoded content of a successful response
param: int         $statusCode   the HTTP status code of the response
param: string|null $contentType  the Content-Type of the response
param: string|null $responseBody the response body
param: string      $service      the name of the service
param: string      $path         the path used in the request

jsonErrorDescription()   X-Ref

return: string describing the JSON error

urlFor(string $path)   X-Ref

return: string the constructed URL
param: string $path the path to use in the URL

handle4xx(int $statusCode,?string $contentType,?string $body,string $service,string $path)   X-Ref

param: int         $statusCode  the HTTP status code
param: string|null $contentType the response content-type
param: string|null $body        the response body
param: string      $service     the service name
param: string      $path        the path used in the request

handleWebServiceError(string $message,string $code,int $statusCode,string $path)   X-Ref

param: string $message    the error message from the web service
param: string $code       the error code from the web service
param: int    $statusCode the HTTP status code
param: string $path       the path used in the request

handle5xx(int $statusCode, string $service, string $path)   X-Ref

param: int    $statusCode the HTTP status code
param: string $service    the service name
param: string $path       the URI path used in the request

handleUnexpectedStatus(int $statusCode, string $service, string $path)   X-Ref

param: int    $statusCode the HTTP status code
param: string $service    the service name
param: string $path       the URI path used in the request

handleSuccess(int $statusCode, ?string $body, string $service)   X-Ref

return: array|null the decoded request body
param: int         $statusCode the HTTP status code
param: string|null $body       the successful request body
param: string      $service    the service name

getCaBundle()   X-Ref
No description



Generated: Tue Jan 21 05:10:11 2025 Cross-referenced by PHPXref 0.7.1