bakaphp / phalcon-api

library/Http/Response.php

<?php

End of line character is invalid; expected "\n" but found "\r\n"

declare(strict_types=1);


namespace Gewaer\Http;


use Phalcon\Http\Response as PhResponse;

use Phalcon\Mvc\Model\MessageInterface as ModelMessage;

use Phalcon\Validation\Message\Group as ValidationMessage;


class Response extends PhResponse

{

    const OK = 200;

    const CREATED = 201;

    const ACCEPTED = 202;

    const MOVED_PERMANENTLY = 301;

    const FOUND = 302;

    const TEMPORARY_REDIRECT = 307;

    const PERMANENTLY_REDIRECT = 308;

    const BAD_REQUEST = 400;

    const UNAUTHORIZED = 401;

    const FORBIDDEN = 403;

    const NOT_FOUND = 404;

    const NOT_ACCEPTABLE = 406;

    const INTERNAL_SERVER_ERROR = 500;

    const NOT_IMPLEMENTED = 501;

    const BAD_GATEWAY = 502;


    private $codes = [

        200 => 'OK',

        301 => 'Moved Permanently',

        302 => 'Found',

        307 => 'Temporary Redirect',

        308 => 'Permanent Redirect',

        400 => 'Bad Request',

        401 => 'Unauthorized',

        403 => 'Forbidden',

        404 => 'Not Found',

        500 => 'Internal Server Error',

        501 => 'Not Implemented',

        502 => 'Bad Gateway',

    ];


    /**

     * Returns the http code description or if not found the code itself

     * @param int $code

     *

     * @return int|string

     */

    public function getHttpCodeDescription(int $code)

    {

        if (true === isset($this->codes[$code])) {

            return sprintf('%d (%s)', $code, $this->codes[$code]);

        }


        return $code;

    }


    /**

     * Send the response back

     *

     * @return PhResponse

     */

    public function send(): PhResponse

    {

        $content = $this->getContent();

        $timestamp = date('c');

        $hash = sha1($timestamp . $content);

        $eTag = sha1($content);


        /** @var array $content */

        $content = json_decode($this->getContent(), true);


        $jsonapi = [

            'jsonapi' => [

                'version' => '1.0',

            ],

        ];

        $meta = [

            'meta' => [

                'timestamp' => $timestamp,

                'hash' => $hash,

            ]

        ];


        /**

         * Join the array again

         */

        $data = $jsonapi + $content + $meta;

        $this

            ->setHeader('E-Tag', $eTag)

            ->setJsonContent($data);


        return parent::send();

    }


    /**

     * Sets the payload code as Error

     *

     * @param string $detail

     *

     * @return Response

     */

    public function setPayloadError(string $detail = ''): Response

    {

        $this->setJsonContent([

            'errors' => [

                'message' => $detail,

                'type' => $this->codes[404]

                ]

        ]);


        return $this;

    }


    /**

     * Traverses the errors collection and sets the errors in the payload

     *

     * @param ModelMessage[]|ValidationMessage $errors

     *

     * @return Response

     */

    public function setPayloadErrors($errors): Response

    {

        $data = [];

        foreach ($errors as $error) {

            $data[] = $error->getMessage();

        }


        $this->setJsonContent(['errors' => $data]);


        return $this;

    }


    /**

     * Sets the payload code as Success

     *

     * @param null|string|array $content The content

     *

     * @return Response

     */

    public function setPayloadSuccess($content = []): Response

    {

        $data = (true === is_array($content)) ? $content : ['data' => $content];

        $data = (true === isset($data['data'])) ? $data : ['data' => $data];


        $this->setJsonContent($data);


        return $this;

    }

}