Choccybiccy\HumanApi\Endpoint

Complexity

Total Complexity

7

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setAccessToken()	0	5	1
A	getAccessToken()	0	4	1
A	getList()	0	7	1
A	getById()	0	6	1
A	getRecent()	0	5	1
B	fetchResults()	0	26	2
	buildListUrl()	0	1	?
	buildSpecificEntryUrl()	0	1	?
	buildRecentUrl()	0	1	?

<?php

namespace Choccybiccy\HumanApi;

use Choccybiccy\HumanApi\Collection;

/**
 * Class Endpoint
 * @package Choccybiccy\HumanApi
 */
abstract class Endpoint extends Api
{

    /**
     * @var string
     */
    protected $type;

    /**
     * @var string
     */
    protected $plural;

    /**
     * @var string
     */
    protected $accessToken;

    /**
     * @var bool
     */
    protected $listReturnsArray = true;

    /**
     * Set access token
     *
     * @param string $accessToken Access token
     * @return $this
     */
    public function setAccessToken($accessToken)
    {
        $this->accessToken = $accessToken;
        return $this;
    }

    /**
     * Get access token
     *
     * @return string
     */
    public function getAccessToken()
    {
        return $this->accessToken;
    }

    /**
     * Get list of entries
     *
     * @param array $params
     * @return Collection
     */
    public function getList(array $params = array())
    {

        $url = $this->buildListUrl();
        return $this->fetchResults($url, $params);

    }

    /**
     * Get entry by ID
     *
     * @param int $id
     * @param array $params
     * @return Collection
     */
    public function getById($id, array $params = array())
    {
        $this->listReturnsArray = false;
        $url = $this->buildSpecificEntryUrl($id);
        return $this->fetchResults($url, $params);
    }

    /**
     * Get recent entry
     *
     * @param array $params
     * @return Collection
     */
    public function getRecent(array $params = array())
    {
        $url = $this->buildRecentUrl();
        return $this->fetchResults($url, $params);
    }

    /**
     * Fetch results
     *
     * @param string $url
     * @param array $params
     * @return Collection
     */
    protected function fetchResults($url, array $params = array())
    {
        /** @var \GuzzleHttp\Message\Response $response */
        $response = call_user_func_array(
            array($this, $this->method),
            array(
                $url,
                array(
                    "query" => array_merge(
                        array(
                        "access_token" => $this->accessToken,
                        ),
                        $params
                    )
                )
            )
        );

        $responseJson = json_decode($response->getBody(), true);
        if (!$this->listReturnsArray) {
            $responseJson = array($responseJson);
        }

        return $this->buildCollection($responseJson);

    }

    /**
     * Build a url that returns a list of entries
     *
     * @return string
     */
    abstract protected function buildListUrl();

    /**
     * Build a url that returns a specific entry
     *
     * @param int $id ID
     * @return string
     */
    abstract protected function buildSpecificEntryUrl($id);

    /**
     * Build a url that returns recent entry
     *
     * @return string
     */
    abstract protected function buildRecentUrl();
}