JsonApiResponseFormatter::format() - Code Metrics - Inspection of "Merge pull request #52 from tuyakhov/fix_empty_res..." - tuyakhov/yii2-json-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f763ca...75bce8 )

by Anton

created 2018-07-21 13:58 UTC

JsonApiResponseFormatter::format() C

↳ Parent: JsonApiResponseFormatter

Complexity

Conditions	12
Paths	36

Size

Total Lines	39
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
eloc	24
nc	36
nop	1
dl	0
loc	39
rs	6.9666
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * @author Anton Tuyakhov <[email protected]>
 */

namespace tuyakhov\jsonapi;

use yii\base\Component;
use yii\helpers\ArrayHelper;
use yii\helpers\Json;
use yii\helpers\Url;
use yii\web\ErrorHandler;
use yii\web\Link;
use yii\web\Response;
use yii\web\ResponseFormatterInterface;

class JsonApiResponseFormatter extends Component implements ResponseFormatterInterface
{
    /**
     * Mapping between the error handler component and JSON API error object
     * @see ErrorHandler::convertExceptionToArray()
     */
    const ERROR_EXCEPTION_MAPPING = [
        'title' => 'name',
        'detail' => 'message',
        'code' => 'code',
        'status' => 'status'
    ];
    /**
     * An error object MAY have the following members
     * @link http://jsonapi.org/format/#error-objects
     */
    const ERROR_ALLOWED_MEMBERS = [
        'id', 'links', 'status', 'code', 'title', 'detail', 'source', 'meta'
    ];
    /**
     * @var integer the encoding options passed to [[Json::encode()]]. For more details please refer to
     * <http://www.php.net/manual/en/function.json-encode.php>.
     * Default is `JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE`.
     */
    public $encodeOptions = 320;
    /**
     * @var bool whether to format the output in a readable "pretty" format. This can be useful for debugging purpose.
     * If this is true, `JSON_PRETTY_PRINT` will be added to [[encodeOptions]].
     * Defaults to `false`.
     */
    public $prettyPrint = false;

    /**
     * Formats response data in JSON format.
     * @link http://jsonapi.org/format/upcoming/#document-structure
     * @param Response $response
     */
    public function format($response)
    {
        $response->getHeaders()->set('Content-Type', 'application/vnd.api+json; charset=UTF-8');
        $options = $this->encodeOptions;
        if ($this->prettyPrint) {
            $options |= JSON_PRETTY_PRINT;
        }

        $apiDocument = $response->data;

        if (!$response->isEmpty) {
            $apiDocument = ['data' => $response->data];
            if (\Yii::$app->controller) {
                $apiDocument['links'] = Link::serialize([
                    Link::REL_SELF => Url::current([], true)
                ]);
            }
        }

        if ($response->isClientError || $response->isServerError) {
            if (ArrayHelper::isAssociative($response->data)) {
                $response->data = [$response->data];
            }
            $formattedErrors = [];
            foreach ($response->data as $error) {
                $formattedError = array_intersect_key($error, array_flip(static::ERROR_ALLOWED_MEMBERS));
                foreach (static::ERROR_EXCEPTION_MAPPING as $member => $key) {
                    if (isset($error[$key])) {
                        $formattedError[$member] = (string) $error[$key];
                    }
                }
                if (!empty($formattedError)) {
                    $formattedErrors[] = $formattedError;
                }
            }
            $apiDocument = ['errors' => $formattedErrors];
        }
        if ($apiDocument !== null) {
            $response->content = Json::encode($apiDocument, $options);
        }
    }
}



1			<?php
2			/**
3			* @author Anton Tuyakhov <[email protected]>
4			*/
5
6			namespace tuyakhov\jsonapi;
7
8			use yii\base\Component;
9			use yii\helpers\ArrayHelper;
10			use yii\helpers\Json;
11			use yii\helpers\Url;
12			use yii\web\ErrorHandler;
13			use yii\web\Link;
14			use yii\web\Response;
15			use yii\web\ResponseFormatterInterface;
16
17			class JsonApiResponseFormatter extends Component implements ResponseFormatterInterface
18			{
19			/**
20			* Mapping between the error handler component and JSON API error object
21			* @see ErrorHandler::convertExceptionToArray()
22			*/
23			const ERROR_EXCEPTION_MAPPING = [
24			'title' => 'name',
25			'detail' => 'message',
26			'code' => 'code',
27			'status' => 'status'
28			];
29			/**
30			* An error object MAY have the following members
31			* @link http://jsonapi.org/format/#error-objects
32			*/
33			const ERROR_ALLOWED_MEMBERS = [
34			'id', 'links', 'status', 'code', 'title', 'detail', 'source', 'meta'
35			];
36			/**
37			* @var integer the encoding options passed to [[Json::encode()]]. For more details please refer to
38			* <http://www.php.net/manual/en/function.json-encode.php>.
39			* Default is `JSON_UNESCAPED_SLASHES \| JSON_UNESCAPED_UNICODE`.
40			*/
41			public $encodeOptions = 320;
42			/**
43			* @var bool whether to format the output in a readable "pretty" format. This can be useful for debugging purpose.
44			* If this is true, `JSON_PRETTY_PRINT` will be added to [[encodeOptions]].
45			* Defaults to `false`.
46			*/
47			public $prettyPrint = false;
48
49			/**
50			* Formats response data in JSON format.
51			* @link http://jsonapi.org/format/upcoming/#document-structure
52			* @param Response $response
53			*/
54			public function format($response)
55			{
56			$response->getHeaders()->set('Content-Type', 'application/vnd.api+json; charset=UTF-8');
57			$options = $this->encodeOptions;
58			if ($this->prettyPrint) {
59			$options \|= JSON_PRETTY_PRINT;
60			}
61
62			$apiDocument = $response->data;
63
64			if (!$response->isEmpty) {
65			$apiDocument = ['data' => $response->data];
66			if (\Yii::$app->controller) {
67			$apiDocument['links'] = Link::serialize([
68			Link::REL_SELF => Url::current([], true)
69			]);
70			}
71			}
72
73			if ($response->isClientError \|\| $response->isServerError) {
74			if (ArrayHelper::isAssociative($response->data)) {
75			$response->data = [$response->data];
76			}
77			$formattedErrors = [];
78			foreach ($response->data as $error) {
79			$formattedError = array_intersect_key($error, array_flip(static::ERROR_ALLOWED_MEMBERS));
80			foreach (static::ERROR_EXCEPTION_MAPPING as $member => $key) {
81			if (isset($error[$key])) {
82			$formattedError[$member] = (string) $error[$key];
83			}
84			}
85			if (!empty($formattedError)) {
86			$formattedErrors[] = $formattedError;
87			}
88			}
89			$apiDocument = ['errors' => $formattedErrors];
90			}
91			if ($apiDocument !== null) {
92			$response->content = Json::encode($apiDocument, $options);
93			}
94			}
95			}
			0 ignored issues – show Coding Style introduced 2016-04-11 12:58 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
96

tuyakhov / yii2-json-api

Push — master ( f763ca...75bce8 )

JsonApiResponseFormatter::format() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like