Category

Crew\Unsplash\Category

• Class name: Category
• Namespace: Crew\Unsplash
• Parent class: Crew\Unsplash\Endpoint

Properties

$photos

private mixed $photos = array()

• Visibility: private

$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

find

\Crew\Unsplash\Category Crew\Unsplash\Category::find(integer $id)

Retrieve the Category object from the id specified.

• Visibility: public
• This method is static.

Arguments

• $id integer - <p>Id of the category to find</p>

all

\Crew\Unsplash\ArrayObject Crew\Unsplash\Category::all(integer $page, integer $per_page)

Retrieve all the categories on a specific page.

The function retrieve an ArrayObject that contains Category object.

• Visibility: public
• This method is static.

Arguments

• $page integer - <p>Page from which the categories need to be retrieve</p>
• $per_page integer - <p>Number of element in a page</p>

photos

mixed Crew\Unsplash\Category::photos(integer $page, integer $per_page)

Retrieve all the photos for a specific category on a specific page.

The function retrieve an ArrayObject that contains Photo object.

• Visibility: public

Arguments

• $page integer - <p>Page from which the photos need to be retrieve</p>
• $per_page integer - <p>Number of element in a page</p>

__construct

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

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

• Visibility: public
• This method is defined by Crew\Unsplash\Endpoint

Arguments

• $parameters mixed

update

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

Merge the old parameters with the new one.

• Visibility: public
• This method is defined by Crew\Unsplash\Endpoint

Arguments

• $parameters array

__get

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

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

• Visibility: public
• This method is defined by Crew\Unsplash\Endpoint

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.
• This method is defined by Crew\Unsplash\Endpoint

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.
• This method is defined by Crew\Unsplash\Endpoint

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.
• This method is defined by Crew\Unsplash\Endpoint

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.
• This method is defined by Crew\Unsplash\Endpoint

Arguments

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