Caridea\Http\JsonHelper

Complexity

Total Complexity

11

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	sendJson()	0	5	1
A	sendCreated()	0	5	1
A	sendDeleted()	0	4	1
A	sendUpdated()	0	4	1
A	sendVerb()	0	10	1
B	sendItems()	0	13	6

<?php
declare(strict_types=1);
/**
 * Caridea
 *
 * 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
 * @copyright 2017-2018 LibreWorks contributors
 * @license   Apache-2.0
 */
namespace Caridea\Http;

use Psr\Http\Message\ResponseInterface as Response;
use Caridea\Http\Pagination;

/**
 * A trait that can be used by any class that needs to output typical JSON.
 */
trait JsonHelper
{
    /**
     * Send something as JSON.
     *
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param mixed $payload  The object to serialize
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendJson(Response $response, $payload): Response
    {
        $response->getBody()->write(json_encode($payload));
        return $response->withHeader('Content-Type', 'application/json');
    }

    /**
     * Sends a Content-Range header for pagination.
     *
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param iterable $items  The items to serialize
     * @param \Caridea\Http\Pagination|null $pagination  The pagination object
     * @param int|null $total  The total number of records, if `$items` is a subset
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendItems(Response $response, iterable $items, ?Pagination $pagination = null, ?int $total = null): Response
    {
        $items = is_array($items) ? $items : ($items instanceof \Traversable ? iterator_to_array($items, false) : []);
        $total = $total ?? count($items);
        $start = $pagination === null ? 0 : $pagination->getOffset();
        $max = $pagination === null ? 0 : $pagination->getMax();
        // make sure $end is no higher than $total and isn't negative
        $end = max(min((PHP_INT_MAX - $max < $start ? PHP_INT_MAX : $start + $max), $total) - 1, 0);
        return $this->sendJson(
            $response->withHeader('Content-Range', "items $start-$end/$total"),
            $items
        );
    }

    /**
     * Send notice that an entity was created.
     *
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param string $type  The entity type
     * @param array<mixed> $ids  The entity ids
     * @param array<string,mixed> $extra  Any extra data to serialize
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendCreated(Response $response, string $type, array $ids, array $extra = []): Response
    {
        return $this->sendVerb('created', $response, $type, $ids, $extra)
            ->withStatus(201, "Created");
    }

    /**
     * Send notice that objects were deleted.
     *
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param string $type  The entity type
     * @param array<mixed> $ids  The entity ids
     * @param array<string,mixed> $extra  Any extra data to serialize
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendDeleted(Response $response, string $type, array $ids, array $extra = []): Response
    {
        return $this->sendVerb('deleted', $response, $type, $ids, $extra);
    }

    /**
     * Send notice that objects were updated.
     *
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param string $type  The entity type
     * @param array<mixed> $ids  The entity ids
     * @param array<string,mixed> $extra  Any extra data to serialize
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendUpdated(Response $response, string $type, array $ids, array $extra = []): Response
    {
        return $this->sendVerb('updated', $response, $type, $ids, $extra);
    }

    /**
     * Sends a generic notice that objects have been operated on.
     *
     * @param string $verb  The verb
     * @param \Psr\Http\Message\ResponseInterface $response  The response
     * @param string $type  The entity type
     * @param array<mixed> $ids  The entity ids
     * @param array<string,mixed> $extra  Any extra data to serialize
     * @return \Psr\Http\Message\ResponseInterface  The JSON response
     */
    protected function sendVerb(string $verb, Response $response, string $type, array $ids, array $extra = []): Response
    {
        $send = array_merge([], $extra);
        $send['success'] = true;
        $send['message'] = "Objects $verb successfully";
        $send['objects'] = array_map(function ($id) use ($type) {
            return ['type' => $type, 'id' => $id];
        }, $ids);
        return $this->sendJson($response, $send);
    }
}