Output::json() - Code Metrics - jasny/controller - Measure and Improve Code Quality continuously with Scrutinizer

Output::json() A
last analyzed 2023-06-12 21:14 UTC

↳ Parent: Output

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	2

<?php
declare(strict_types=1);

namespace Jasny\Controller\Traits;

use Psr\Http\Message\ResponseInterface;
use Mimey\MimeTypes;

/**
 * Methods for a controller to send a response
 */
trait Output
{
    /**
     * Get response, set for controller
     */
    abstract protected function getResponse(): ResponseInterface;

    /**
     * Set response.
     */
    abstract protected function setResponse(ResponseInterface $response): void;

    /**
     * Get MIME type for extension
     */
    protected function getMime(string $format): string
    {
        // Check if it's already MIME
        if (str_contains($format, '/')) {
            return $format;
        }
        
        $mime = (new MimeTypes())->getMimeType($format);

        if (!isset($mime)) {
            throw new \UnexpectedValueException("Format '$format' doesn't correspond with a MIME type");
        }
        
        return $mime;
    }

    /**
     * Output data as json.
     *
     * @param mixed $data
     * @param int   $flags   Flags for json_encode
     * @return $this
     */
    protected function json(mixed $data, int $flags = 0): static
    {
        return $this->output(json_encode($data, $flags), 'application/json');
    }

    /**
     * Output result
     *
     * @param string      $content
     * @param string|null $format  Output format as MIME or extension
     * @return $this
     */
    protected function output(string $content, ?string $format = null): static
    {
        $response = $this->getResponse();

        if ($format !== null) {
            $contentType = $this->getMime($format);
            $response = $response->withHeader('Content-Type', $contentType);
        }

        $response->getBody()->write($content);
        $this->setResponse($response);

        return $this;
    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace Jasny\Controller\Traits;
5
6			use Psr\Http\Message\ResponseInterface;
7			use Mimey\MimeTypes;
8
9			/**
10			* Methods for a controller to send a response
11			*/
12			trait Output
13			{
14			/**
15			* Get response, set for controller
16			*/
17			abstract protected function getResponse(): ResponseInterface;
18
19			/**
20			* Set response.
21			*/
22			abstract protected function setResponse(ResponseInterface $response): void;
23
24			/**
25			* Get MIME type for extension
26			*/
27			protected function getMime(string $format): string
28			{
29			// Check if it's already MIME
30			if (str_contains($format, '/')) {
31			return $format;
32			}
33
34			$mime = (new MimeTypes())->getMimeType($format);
35
36			if (!isset($mime)) {
37			throw new \UnexpectedValueException("Format '$format' doesn't correspond with a MIME type");
38			}
39
40			return $mime;
41			}
42
43			/**
44			* Output data as json.
45			*
46			* @param mixed $data
47			* @param int $flags Flags for json_encode
48			* @return $this
49			*/
50			protected function json(mixed $data, int $flags = 0): static
51			{
52			return $this->output(json_encode($data, $flags), 'application/json');
53			}
54
55			/**
56			* Output result
57			*
58			* @param string $content
59			* @param string\|null $format Output format as MIME or extension
60			* @return $this
61			*/
62			protected function output(string $content, ?string $format = null): static
63			{
64			$response = $this->getResponse();
65
66			if ($format !== null) {
67			$contentType = $this->getMime($format);
68			$response = $response->withHeader('Content-Type', $contentType);
69			}
70
71			$response->getBody()->write($content);
72			$this->setResponse($response);
73
74			return $this;
75			}
76			}
77

jasny / controller

Output::json() A last analyzed 2023-06-12 21:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Output::json() A
last analyzed 2023-06-12 21:14 UTC