Result.php

<?php declare(strict_types=1);
/**
 * HyperPlug
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace modethirteen\Http;

use modethirteen\Http\Content\ContentType;
use modethirteen\Http\Content\IContent;
use modethirteen\XArray\Serialization\XmlSerializer;
use modethirteen\XArray\XArray;

/**
 * Class Result - wraps http result with accessors
 *
 * @package modethirteen\Http
 */
class Result extends XArray {

    public function __clone() {

        // deep copy internal data objects and arrays
        $this->array = unserialize(serialize($this->array));
    }

    /**
     * Return an instance with the added request information
     *
     * @param string $method
     * @param XUri $uri
     * @param IHeaders $headers
     * @param float $start - curl start timestamp
     * @param float $end - curl stop timestamp
     * @return static
     */
    public function withRequestInfo(string $method, XUri $uri, IHeaders $headers, float $start, float $end) : object {
        $result = clone $this;
        $result->array['request'] = [
            'method' => $method,
            'uri' => $uri->toString(),
            'headers' => $headers->toArray(),
            'start' => $start,
            'end' => $end
        ];
        return $result;
    }

    /**
     * Return an instance with the specified HTTP status code
     *
     * @param int $status
     * @return static
     */
    public function withStatus(int $status) : object {
        $result = clone $this;
        $result->array['status'] = $status;
        return $result;
    }

    /**
     * Return an instance with the specified HTTP headers
     *
     * @param IHeaders $headers
     * @return static
     */
    public function withHeaders(IHeaders $headers) : object {
        $result = clone $this;
        $result->array['headers'] = $headers->toArray();
        return $result;
    }

    /**
     * Return an instance with the specified body
     *
     * @param string|array $body
     * @return static
     */
    public function withBody($body) : object {
        $result = clone $this;
        $result->array['body'] = $body;
        return $result;
    }

    /**
     * Return an instance with the specified result content body and content type
     *
     * @param IContent $content
     * @return static
     */
    public function withContent(IContent $content) : object {
        $result = clone $this;
        $contentType = $content->getContentType();
        $result->array['body'] = $content->toString();
        $result->array['type'] = $contentType !== null ? $contentType->toString() : null;
        return $result;
    }

    /**
     * Retrieve the HTTP response status code
     *
     * @return int
     */
    public function getStatus() : int {
        return isset($this->array['status']) ? $this->array['status'] : 0;
    }

    /**
     * Retrieve the HTTP response content type
     *
     * @return ContentType|null - returns null if not set or invalid content type
     */
    public function getContentType() : ?ContentType {
        return isset($this->array['type']) ? ContentType::newFromString($this->array['type']) : null;
    }

    /**
     * Retrieve an instance of HTTP response headers
     *
     * @return IHeaders
     */
    public function getHeaders() : IHeaders {
        $headers = new Headers();
        if(empty($this->getVal('headers'))) {
            return $headers;
        }
        foreach($this->getVal('headers') as $name => $values) {
            foreach($values as $value) {
                $headers->addHeader($name, $value);
            }
        }
        return $headers;
    }

    /**
     * Return a XArray representation of the HTTP response body (unparsed Result will return ['body' => string])
     *
     * @return XArray
     */
    public function getBody() : XArray {
        $body = $this->getVal('body');
        if(!is_array($body)) {
            $body = ['body' => $body];
        }
        return new XArray($body);
    }

    /**
     * Retrieve an XML string representation of a result value, or the entire result
     *
     * @param string|null $key - result key name (ex: body/content), empty returns entire result as xml (aliases Result::toXml)
     * @return string
     */
    public function getXml(string $key = null) : string {
        $serializer = new XmlSerializer();
        if(!is_string($key)) {

            /** @noinspection HtmlUnknownTag */
            return "<result>{$this->withSerializer($serializer)->toString()}</result>";
        }
        $value = $this->getVal($key);
        return (new XArray($value))->withSerializer($serializer)->toString();
    }

    /**
     * What is the HTTP response status code?
     *
     * @param int $status
     * @return bool
     */
    public function is(int $status) : bool {
        return $this->getStatus() === $status;
    }

    /**
     * Is the response status code in the HTTP 2xx range?
     *
     * @return bool
     */
    public function isSuccess() : bool {
        $status = $this->getStatus();
        return $status >= 200 && $status < 300;
    }

    /**
     * Is the response status code in the HTTP 3xx range?
     *
     * @return bool
     */
    public function isRedirect() : bool {
        $status = $this->getStatus();
        return $status >= 300 && $status < 400;
    }

    /**
     * Did the request fail due to a server problem?
     *
     * @return bool
     */
    public function isServerError() : bool {
        $status = $this->getStatus();
        return $status >= 500 && $status < 600;
    }

    /**
     * Did the request fail due to a request problem?
     *
     * @return bool
     */
    public function isRequestError() : bool {
        $status = $this->getStatus();
        return $status >= 400 && $status < 500;
    }

    /**
     * Is there a connection problem or internal curl error?
     *
     * @return bool
     */
    public function isCurlError() : bool {
        return $this->array['errno'] > 0;
    }

    /**
     * Get curl internal error message
     *
     * @return string|null
     */
    public function getCurlError() : ?string {
        return (isset($this->array['error'])) ? $this->array['error'] : null;
    }
}