Maztech\InstagramResponse

Complexity

Total Complexity

33

Size/Duplication

Total Lines	374
Duplicated Lines	0 %

Importance

Changes

0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	getRequest()	0	3	1
A	getGraphSessionInfo()	0	5	1
A	getGraphGroup()	0	5	1
A	getGraphList()	0	3	1
A	__construct()	0	8	1
A	getHttpStatusCode()	0	3	1
A	throwException()	0	3	1
A	getGraphUser()	0	5	1
A	getDecodedBody()	0	3	1
A	getGraphEvent()	0	5	1
A	getBody()	0	3	1
A	getGraphEdge()	0	5	1
A	getThrownException()	0	3	1
A	getGraphVersion()	0	3	2
A	getAccessToken()	0	3	1
A	getAppSecretProof()	0	3	1
A	makeException()	0	3	1
A	getGraphNode()	0	5	1
A	decodeBody()	0	22	6
A	getApp()	0	3	1
A	getGraphAlbum()	0	5	1
A	isError()	0	3	1
A	getGraphPage()	0	5	1
A	getHeaders()	0	3	1
A	getETag()	0	3	2
A	getGraphObject()	0	3	1

<?php

namespace Maztech;

use Maztech\GraphNodes\GraphNodeFactory;
use Maztech\Exceptions\InstagramResponseException;
use Maztech\Exceptions\InstagramSDKException;

/**
 * Class InstagramResponse
 *
 * @package Instagram
 */
class InstagramResponse
{
    /**
     * @var int The HTTP status code response from Graph.
     */
    protected $httpStatusCode;

    /**
     * @var array The headers returned from Graph.
     */
    protected $headers;

    /**
     * @var string The raw body of the response from Graph.
     */
    protected $body;

    /**
     * @var array The decoded body of the Graph response.
     */
    protected $decodedBody = [];

    /**
     * @var InstagramRequest The original request that returned this response.
     */
    protected $request;

    /**
     * @var InstagramSDKException The exception thrown by this request.
     */
    protected $thrownException;

    /**
     * Creates a new Response entity.
     *
     * @param InstagramRequest $request
     * @param string|null     $body
     * @param int|null        $httpStatusCode
     * @param array|null      $headers
     */
    public function __construct(InstagramRequest $request, $body = null, $httpStatusCode = null, array $headers = [])
    {
        $this->request = $request;
        $this->body = $body;
        $this->httpStatusCode = $httpStatusCode;
        $this->headers = $headers;

        $this->decodeBody();
    }

    /**
     * Return the original request that returned this response.
     *
     * @return InstagramRequest
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Return the InstagramApp entity used for this response.
     *
     * @return InstagramApp
     */
    public function getApp()
    {
        return $this->request->getApp();
    }

    /**
     * Return the access token that was used for this response.
     *
     * @return string|null
     */
    public function getAccessToken()
    {
        return $this->request->getAccessToken();
    }

    /**
     * Return the HTTP status code for this response.
     *
     * @return int
     */
    public function getHttpStatusCode()
    {
        return $this->httpStatusCode;
    }

    /**
     * Return the HTTP headers for this response.
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->headers;
    }

    /**
     * Return the raw body response.
     *
     * @return string
     */
    public function getBody()
    {
        return $this->body;
    }

    /**
     * Return the decoded body response.
     *
     * @return array
     */
    public function getDecodedBody()
    {
        return $this->decodedBody;
    }

    /**
     * Get the app secret proof that was used for this response.
     *
     * @return string|null
     */
    public function getAppSecretProof()
    {
        return $this->request->getAppSecretProof();
    }

    /**
     * Get the ETag associated with the response.
     *
     * @return string|null
     */
    public function getETag()
    {
        return isset($this->headers['ETag']) ? $this->headers['ETag'] : null;
    }

    /**
     * Get the version of Graph that returned this response.
     *
     * @return string|null
     */
    public function getGraphVersion()
    {
        return isset($this->headers['Instagram-API-Version']) ? $this->headers['Instagram-API-Version'] : null;
    }

    /**
     * Returns true if Graph returned an error message.
     *
     * @return boolean
     */
    public function isError()
    {
        return isset($this->decodedBody['error']);
    }

    /**
     * Throws the exception.
     *
     * @throws InstagramSDKException
     */
    public function throwException()
    {
        throw $this->thrownException;
    }

    /**
     * Instantiates an exception to be thrown later.
     */
    public function makeException()
    {
        $this->thrownException = InstagramResponseException::create($this);
    }

    /**
     * Returns the exception that was thrown for this request.
     *
     * @return InstagramResponseException|null
     */
    public function getThrownException()
    {
        return $this->thrownException;
    }

    /**
     * Convert the raw response into an array if possible.
     *
     * Graph will return 2 types of responses:
     * - JSON(P)
     *    Most responses from Graph are JSON(P)
     * - application/x-www-form-urlencoded key/value pairs
     *    Happens on the `/oauth/access_token` endpoint when exchanging
     *    a short-lived access token for a long-lived access token
     * - And sometimes nothing :/ but that'd be a bug.
     */
    public function decodeBody()
    {
        $this->decodedBody = json_decode($this->body, true);

        if ($this->decodedBody === null) {
            $this->decodedBody = [];
            parse_str($this->body, $this->decodedBody);
        } elseif (is_bool($this->decodedBody)) {
            // Backwards compatibility for Graph < 2.1.
            // Mimics 2.1 responses.
            // @TODO Remove this after Graph 2.0 is no longer supported
            $this->decodedBody = ['success' => $this->decodedBody];
        } elseif (is_numeric($this->decodedBody)) {
            $this->decodedBody = ['id' => $this->decodedBody];
        }

        if (!is_array($this->decodedBody)) {
            $this->decodedBody = [];
        }

        if ($this->isError()) {
            $this->makeException();
        }
    }

    /**
     * Instantiate a new GraphObject from response.
     *
     * @param string|null $subclassName The GraphNode subclass to cast to.
     *
     * @return \Instagram\GraphNodes\GraphObject

The type Instagram\GraphNodes\GraphObject was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     *
     * @deprecated 5.0.0 getGraphObject() has been renamed to getGraphNode()
     * @todo v6: Remove this method
     */
    public function getGraphObject($subclassName = null)
    {
        return $this->getGraphNode($subclassName);
    }

    /**
     * Instantiate a new GraphNode from response.
     *
     * @param string|null $subclassName The GraphNode subclass to cast to.
     *
     * @return \Instagram\GraphNodes\GraphNode

The type Instagram\GraphNodes\GraphNode was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphNode($subclassName = null)
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphNode($subclassName);
    }

    /**
     * Convenience method for creating a GraphAlbum collection.
     *
     * @return \Instagram\GraphNodes\GraphAlbum

The type Instagram\GraphNodes\GraphAlbum was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphAlbum()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphAlbum();
    }

    /**
     * Convenience method for creating a GraphPage collection.
     *
     * @return \Instagram\GraphNodes\GraphPage

The type Instagram\GraphNodes\GraphPage was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphPage()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphPage();
    }

    /**
     * Convenience method for creating a GraphSessionInfo collection.
     *
     * @return \Instagram\GraphNodes\GraphSessionInfo

The type Instagram\GraphNodes\GraphSessionInfo was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphSessionInfo()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphSessionInfo();
    }

    /**
     * Convenience method for creating a GraphUser collection.
     *
     * @return \Instagram\GraphNodes\GraphUser

The type Instagram\GraphNodes\GraphUser was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphUser()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphUser();
    }

    /**
     * Convenience method for creating a GraphEvent collection.
     *
     * @return \Instagram\GraphNodes\GraphEvent

The type Instagram\GraphNodes\GraphEvent was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphEvent()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphEvent();
    }

    /**
     * Convenience method for creating a GraphGroup collection.
     *
     * @return \Instagram\GraphNodes\GraphGroup

The type Instagram\GraphNodes\GraphGroup was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphGroup()
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphGroup();
    }

    /**
     * Instantiate a new GraphList from response.
     *
     * @param string|null $subclassName The GraphNode subclass to cast list items to.
     * @param boolean     $auto_prefix  Toggle to auto-prefix the subclass name.
     *
     * @return \Instagram\GraphNodes\GraphList

The type Instagram\GraphNodes\GraphList was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     *
     * @deprecated 5.0.0 getGraphList() has been renamed to getGraphEdge()
     * @todo v6: Remove this method
     */
    public function getGraphList($subclassName = null, $auto_prefix = true)
    {
        return $this->getGraphEdge($subclassName, $auto_prefix);
    }

    /**
     * Instantiate a new GraphEdge from response.
     *
     * @param string|null $subclassName The GraphNode subclass to cast list items to.
     * @param boolean     $auto_prefix  Toggle to auto-prefix the subclass name.
     *
     * @return \Instagram\GraphNodes\GraphEdge

The type Instagram\GraphNodes\GraphEdge was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @throws InstagramSDKException
     */
    public function getGraphEdge($subclassName = null, $auto_prefix = true)
    {
        $factory = new GraphNodeFactory($this);

        return $factory->makeGraphEdge($subclassName, $auto_prefix);

The expression return $factory->makeGraphEdge($subclassName, $auto_prefix) returns the type Maztech\GraphNodes\GraphEdge which is incompatible with the documented return type Instagram\GraphNodes\GraphEdge.

    }
}