PHP Класс App\services\RESTfulService

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$client Client; The GuzzleHttp client to talk to the API.
$endpoint string The API endpoint.
$key string The API key.
$keyParam string For example, Last.fm use api_key, like this: https://ws.audioscrobbler.com/2.0?method=artist.getInfo&artist=Kamelot&api_key=API_KEY.
$responseFormat
$secret string The API secret.

Открытые методы

Метод Описание
__call ( string $method, array $args ) : object Make an HTTP call to the external resource.
__construct ( $key, $secret, $endpoint, Client $client )
buildUrl ( string $uri, boolean $appendKey = true ) : string Turn a URI segment into a full API URL.
getClient ( ) : Client
getEndpoint ( ) : string
getKey ( ) : string
getSecret ( ) : string
request ( string $verb, string $uri, boolean $appendKey = true, array $params = [] ) : object | string Make a request to the API.
setClient ( Client $client )
setEndpoint ( string $endpoint )
setKey ( string $key )
setSecret ( string $secret )

Описание методов

__call() публичный Метод

Make an HTTP call to the external resource.
public __call ( string $method, array $args ) : object
$method string The HTTP method
$args array An array of parameters
Результат object

__construct() публичный Метод

public __construct ( $key, $secret, $endpoint, Client $client )
$client GuzzleHttp\Client

buildUrl() публичный Метод

Turn a URI segment into a full API URL.
public buildUrl ( string $uri, boolean $appendKey = true ) : string
$uri string
$appendKey boolean Whether to automatically append the API key into the URL.
Результат string

getClient() публичный Метод

public getClient ( ) : Client
Результат GuzzleHttp\Client

getEndpoint() публичный Метод

public getEndpoint ( ) : string
Результат string

getKey() публичный Метод

public getKey ( ) : string
Результат string

getSecret() публичный Метод

public getSecret ( ) : string
Результат string

request() публичный Метод

Make a request to the API.
public request ( string $verb, string $uri, boolean $appendKey = true, array $params = [] ) : object | string
$verb string The HTTP verb
$uri string The API URI (segment)
$appendKey boolean Whether to automatically append the API key into the URI. While it's usually the case, some services (like Last.fm) requires an "API signature" of the request. Appending an API key will break the request.
$params array An array of parameters
Результат object | string

setClient() публичный Метод

public setClient ( Client $client )
$client GuzzleHttp\Client

setEndpoint() публичный Метод

public setEndpoint ( string $endpoint )
$endpoint string

setKey() публичный Метод

public setKey ( string $key )
$key string

setSecret() публичный Метод

public setSecret ( string $secret )
$secret string

Описание свойств

$client защищенное свойство

The GuzzleHttp client to talk to the API.
protected Client; $client
Результат Client;

$endpoint защищенное свойство

The API endpoint.
protected string $endpoint
Результат string

$key защищенное свойство

The API key.
protected string $key
Результат string

$keyParam защищенное свойство

For example, Last.fm use api_key, like this: https://ws.audioscrobbler.com/2.0?method=artist.getInfo&artist=Kamelot&api_key=API_KEY.
protected string $keyParam
Результат string

$responseFormat защищенное свойство

protected $responseFormat

$secret защищенное свойство

The API secret.
protected string $secret
Результат string