appertly / minotaur

src/Http/MessageHelper.php

<?php
declare(strict_types=1);
/**
 * Minotaur
 *
 * 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.
 *
 * @copyright 2015-2017 Appertly
 * @license   Apache-2.0
 */
namespace Minotaur\Http;

use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Caridea\Auth\Principal;
use Caridea\Http\PaginationFactory;

/**
 * Controller trait with some handy methods.
 */
trait MessageHelper
{
    /**
     * Gets a `Map` of the request body content.
     *
     * @param $request - The request
     * @return array<string,mixed> The Map of request body content
     */
    protected function getParsedBodyMap(Request $request): \ConstMap
    {
        $body = $request->getParsedBody();
        return is_array($body) ? new \HH\Map($body) : new \HH\Map();
    }

    /**
     * Gets a `Map` of the request query params.
     *
     * @param $request - The request
     * @return array<string,mixed> The Map of query params
     */
    protected function getQueryParamsMap(Request $request): \ConstMap
    {
        return new \HH\Map($request->getQueryParams());
    }

    /**
     * Cleanly writes the body to the response.
     *
     * @param $response - The HTTP response
     * @param $body - The body to write
     * @return - The same or new response

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function write(Response $response, $body): Response
    {
        $response->getBody()->write((string) $body);
        return $response;
    }

    /**
     * Checks the `If-Modified-Since` header, maybe sending 304 Not Modified.
     *
     * @param $request - The HTTP request
     * @param $response - The HTTP response
     * @param $timestamp - The timestamp for comparison
     * @return - The same or new response

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function ifModSince(Request $request, Response $response, int $timestamp): Response
    {
        $ifModSince = $request->getHeaderLine('If-Modified-Since');
        if ($ifModSince && $timestamp <= strtotime($ifModSince)) {
            return $response->withStatus(304, "Not Modified");
        }
        return $response;
    }

    /**
     * Checks the `If-None-Match` header, maybe sending 304 Not Modified.
     *
     * @param $request - The HTTP request
     * @param $response - The HTTP response
     * @param $etag - The ETag for comparison
     * @return - The same or new response

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function ifNoneMatch(Request $request, Response $response, string $etag): Response
    {
        $ifNoneMatch = $request->getHeaderLine('If-None-Match');
        if ($ifNoneMatch && $etag === $ifNoneMatch) {
            return $response->withStatus(304, "Not Modified");
        }
        return $response;
    }

    /**
     * Redirects the user to another URL.
     *
     * @param $response - The HTTP response
     * @return - The new response

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function redirect(Response $response, int $code, string $url): Response
    {
        return $response->withStatus($code)->withHeader('Location', $url);
    }

    /**
     * Gets the stored principal, or the anonymous user if none was found.
     *
     * @param $request - The HTTP request
     * @return - The authenticated principal

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function getPrincipal(Request $request): Principal
    {
        $principal = $request->getAttribute('principal', Principal::getAnonymous());
        if (!($principal instanceof Principal)) {
            throw new \UnexpectedValueException("Type mismatch: principal");
        }
        return $principal;
    }

    /**
     * Gets a pagination factory
     *
     * @return - The pagination factory

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    protected function paginationFactory(): PaginationFactory
    {
        return new PaginationFactory();
    }
}