ryanwinchester / hubspot-php

src/Http/Response.php

<?php

namespace SevenShores\Hubspot\Http;

use ArrayAccess;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamInterface;

class Response implements ResponseInterface, ArrayAccess
{
    /**
     * @var \Psr\Http\Message\ResponseInterface
     */
    protected $response;

    /**
     * @var mixed
     */
    public $data;

    /**
     * @param \Psr\Http\Message\ResponseInterface $response
     */
    function __construct(ResponseInterface $response)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->response = $response;
        $this->data = $this->getDataFromResponse($response);
    }

    /**
     * Get the api data from the response as usual.
     *
     * @param  string  $name
     * @return mixed
     */
    function __get($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->data->$name;
    }

    /**
     * @param  ResponseInterface $response
     * @return mixed
     */
    private function getDataFromResponse(ResponseInterface $response)
    {
        $contents = $response->getBody()->getContents();

        return $contents ? json_decode($contents) : null;
    }

    /**
     * Get the underlying data.
     *
     * @return mixed
     */
    function getData()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->data;
    }

    /**
     * Return an array of the data.
     *
     * @return array
     */
    function toArray()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return json_decode(json_encode($this->data), true);
    }

    /**
     * Whether a offset exists
     *
     * @param  mixed  $offset
     * @return boolean
     */
    function offsetExists($offset)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return isset($this->data->$offset);
    }

    /**
     * Offset to retrieve
     *
     * @param  mixed  $offset
     * @return mixed
     */
    function offsetGet($offset)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $data = $this->toArray();

        return $data[$offset];
    }

    /**
     * Offset to set
     *
     * @param  mixed  $offset
     * @param  mixed  $value
     * @return void
     */
    function offsetSet($offset, $value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->data->$offset = $value;
    }

    /**
     * Offset to unset
     *
     * @param  mixed  $offset
     * @return void
     */
    function offsetUnset($offset)

It is generally recommended to explicitly declare the visibility for methods.

    {
        unset($this->data->$offset);
    }

    /**
     * Retrieves the HTTP protocol version as a string.
     *
     * The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
     *
     * @return string HTTP protocol version.
     */
    function getProtocolVersion()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getProtocolVersion();
    }

    /**
     * Return an instance with the specified HTTP protocol version.
     *
     * The version string MUST contain only the HTTP version number (e.g.,
     * "1.1", "1.0").
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that has the
     * new protocol version.
     *
     * @param string $version HTTP protocol version
     * @return self
     */
    function withProtocolVersion($version)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withProtocolVersion($version);
    }

    /**
     * Retrieves all message header values.
     *
     * The keys represent the header name as it will be sent over the wire, and
     * each value is an array of strings associated with the header.
     *
     *     // Represent the headers as a string
     *     foreach ($message->getHeaders() as $name => $values) {
     *         echo $name . ": " . implode(", ", $values);
     *     }
     *
     *     // Emit headers iteratively:
     *     foreach ($message->getHeaders() as $name => $values) {
     *         foreach ($values as $value) {
     *             header(sprintf('%s: %s', $name, $value), false);
     *         }
     *     }
     *
     * While header names are not case-sensitive, getHeaders() will preserve the
     * exact case in which headers were originally specified.
     *
     * @return array Returns an associative array of the message's headers. Each
     *     key MUST be a header name, and each value MUST be an array of strings
     *     for that header.
     */
    function getHeaders()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getHeaders();
    }

    /**
     * Checks if a header exists by the given case-insensitive name.
     *
     * @param string $name Case-insensitive header field name.
     * @return bool Returns true if any header names match the given header
     *     name using a case-insensitive string comparison. Returns false if
     *     no matching header name is found in the message.
     */
    function hasHeader($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->hasHeader($name);
    }

    /**
     * Retrieves a message header value by the given case-insensitive name.
     *
     * This method returns an array of all the header values of the given
     * case-insensitive header name.
     *
     * If the header does not appear in the message, this method MUST return an
     * empty array.
     *
     * @param string $name Case-insensitive header field name.
     * @return string[] An array of string values as provided for the given
     *    header. If the header does not appear in the message, this method MUST
     *    return an empty array.
     */
    function getHeader($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getHeader($name);
    }

    /**
     * Retrieves a comma-separated string of the values for a single header.
     *
     * This method returns all of the header values of the given
     * case-insensitive header name as a string concatenated together using
     * a comma.
     *
     * NOTE: Not all header values may be appropriately represented using
     * comma concatenation. For such headers, use getHeader() instead
     * and supply your own delimiter when concatenating.
     *
     * If the header does not appear in the message, this method MUST return
     * an empty string.
     *
     * @param string $name Case-insensitive header field name.
     * @return string A string of values as provided for the given header
     *    concatenated together using a comma. If the header does not appear in
     *    the message, this method MUST return an empty string.
     */
    function getHeaderLine($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getHeaderLine($name);
    }

    /**
     * Return an instance with the provided value replacing the specified header.
     *
     * While header names are case-insensitive, the casing of the header will
     * be preserved by this function, and returned from getHeaders().
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that has the
     * new and/or updated header and value.
     *
     * @param string $name Case-insensitive header field name.
     * @param string|string[] $value Header value(s).
     * @return self
     * @throws \InvalidArgumentException for invalid header names or values.
     */
    function withHeader($name, $value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withHeader($name, $value);
    }

    /**
     * Return an instance with the specified header appended with the given value.
     *
     * Existing values for the specified header will be maintained. The new
     * value(s) will be appended to the existing list. If the header did not
     * exist previously, it will be added.
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that has the
     * new header and/or value.
     *
     * @param string $name Case-insensitive header field name to add.
     * @param string|string[] $value Header value(s).
     * @return self
     * @throws \InvalidArgumentException for invalid header names or values.
     */
    function withAddedHeader($name, $value)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withAddedHeader($name, $value);
    }

    /**
     * Return an instance without the specified header.
     *
     * Header resolution MUST be done without case-sensitivity.
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that removes
     * the named header.
     *
     * @param string $name Case-insensitive header field name to remove.
     * @return self
     */
    function withoutHeader($name)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withoutHeader($name);
    }

    /**
     * Gets the body of the message.
     *
     * @return StreamInterface Returns the body as a stream.
     */
    function getBody()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getBody();
    }

    /**
     * Return an instance with the specified message body.
     *
     * The body MUST be a StreamInterface object.
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return a new instance that has the
     * new body stream.
     *
     * @param StreamInterface $body Body.
     * @return self
     * @throws \InvalidArgumentException When the body is not valid.
     */
    function withBody(StreamInterface $body)

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withBody($body);
    }

    /**
     * Gets the response status code.
     *
     * The status code is a 3-digit integer result code of the server's attempt
     * to understand and satisfy the request.
     *
     * @return int Status code.
     */
    function getStatusCode()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getStatusCode();
    }

    /**
     * Return an instance with the specified status code and, optionally, reason phrase.
     *
     * If no reason phrase is specified, implementations MAY choose to default
     * to the RFC 7231 or IANA recommended reason phrase for the response's
     * status code.
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that has the
     * updated status and reason phrase.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @param int $code The 3-digit integer result code to set.
     * @param string $reasonPhrase The reason phrase to use with the
     *     provided status code; if none is provided, implementations MAY
     *     use the defaults as suggested in the HTTP specification.
     * @return self
     * @throws \InvalidArgumentException For invalid status code arguments.
     */
    function withStatus($code, $reasonPhrase = '')

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->withStatus($code, $reasonPhrase);
    }

    /**
     * Gets the response reason phrase associated with the status code.
     *
     * Because a reason phrase is not a required element in a response
     * status line, the reason phrase value MAY be null. Implementations MAY
     * choose to return the default RFC 7231 recommended reason phrase (or those
     * listed in the IANA HTTP Status Code Registry) for the response's
     * status code.
     *
     * @link http://tools.ietf.org/html/rfc7231#section-6
     * @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
     * @return string Reason phrase; must return an empty string if none present.
     */
    function getReasonPhrase()

It is generally recommended to explicitly declare the visibility for methods.

    {
        return $this->response->getReasonPhrase();
    }
}