Endpoint

Crew\Unsplash\Endpoint

• Class name: Endpoint
• Namespace: Crew\Unsplash

Properties

$parameters

private array $parameters

All parameters that an endpoint can have.

• Visibility: private

$acceptedHttpMethod

private array $acceptedHttpMethod = array('get', 'post', 'put')

List of accepted http actions that the application can execute.

• Visibility: private
• This property is static.

Methods

__construct

mixed Crew\Unsplash\Endpoint::__construct($parameters)

Construct an new endpoint object and set the parameters from an array.

• Visibility: public

Arguments

• $parameters mixed

update

void Crew\Unsplash\Endpoint::update(array $parameters)

Merge the old parameters with the new one.

• Visibility: public

Arguments

• $parameters array

__get

mixed Crew\Unsplash\Endpoint::__get(string $key)

Magic method to retrieve a specific parameter in the parameters array.

• Visibility: public

Arguments

• $key string

__callStatic

string Crew\Unsplash\Endpoint::__callStatic(string $method, array $arguments)

Validate if the http method is accepted and send an http request to it.

Retrieve error from the request and throw a new error.

• Visibility: public
• This method is static.

Arguments

• $method string - <p>Http action to trigger</p>
• $arguments array - <p>Array containing all the parameters pass to the magic method</p>

getArray

mixed Crew\Unsplash\Endpoint::getArray($responseBody, $object)

• Visibility: protected
• This method is static.

Arguments

• $responseBody mixed
• $object mixed

isGoodRequest

boolean Crew\Unsplash\Endpoint::isGoodRequest(\Crew\Unsplash\GuzzleHttp\Psr7\Response $response)

Retrieve the response status code and determine if the request was a success or not.

• Visibility: private
• This method is static.

Arguments

• $response Crew\Unsplash\GuzzleHttp\Psr7\Response - <p>of the http request</p>

getErrorMessage

string Crew\Unsplash\Endpoint::getErrorMessage(\Crew\Unsplash\GuzzleHttp\Psr7\Response $response)

Retrieve the error message in the body.

• Visibility: private
• This method is static.

Arguments

• $response Crew\Unsplash\GuzzleHttp\Psr7\Response - <p>of the http request</p>