Json::encode() - Code Metrics - Inspection of "#152. Fix setParser with is_array check" - SoliDry/api-generator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 813b52...b69cbb )

by Arthur

created 2019-04-15 17:50 UTC

Json::encode() A

↳ Parent: Json

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace SoliDry\Helpers;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use League\Fractal\Manager;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Resource\ResourceInterface;
use League\Fractal\Serializer\JsonApiSerializer;
use SoliDry\Types\ModelsInterface;
use SoliDry\Types\PhpInterface;
use SoliDry\Types\ApiInterface;
use SoliDry\Extension\BaseFormRequest;
use SoliDry\Extension\JSONApiInterface;
use SoliDry\Transformers\DefaultTransformer;

/**
 * Class Json
 * @package SoliDry\Helpers
 */
class Json
{
    /**
     * @param array $jsonApiArr
     *
     * @return array
     */
    public static function getAttributes(array $jsonApiArr) : array
    {
        return empty($jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_ATTRS]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_ATTRS];
    }

    /**
     * Returns an array of bulk attributes for each element
     *
     * @param array $jsonApiArr
     * @return array
     */
    public static function getBulkAttributes(array $jsonApiArr) : array
    {
        return empty($jsonApiArr[ApiInterface::RAML_DATA]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA];
    }

    /**
     * @param array $jsonApiArr
     *
     * @return array
     */
    public static function getRelationships(array $jsonApiArr) : array
    {
        return empty($jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_RELATIONSHIPS]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_RELATIONSHIPS];
    }

    /**
     * @param array $jsonApiArr
     *
     * @return array
     */
    public static function getData(array $jsonApiArr) : array
    {
        return empty($jsonApiArr[ApiInterface::RAML_DATA]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA];
    }

    /**
     * @param $relations      \Illuminate\Database\Eloquent\Collection
     * @param string $entity
     * @return array JSON API rels compatible array
     */
    public static function getRelations($relations, string $entity) : array
    {
        $jsonArr = [];
        if ($relations instanceof \Illuminate\Database\Eloquent\Collection) {
            $cnt = count($relations);
            if ($cnt > 1) {
                foreach ($relations as $v) {
                    $attrs     = $v->getAttributes();
                    $jsonArr[] = [ApiInterface::RAML_TYPE => $entity,
                                  ApiInterface::RAML_ID   => $attrs[ApiInterface::RAML_ID]];
                }
            } else {
                foreach ($relations as $v) {
                    $attrs   = $v->getAttributes();
                    $jsonArr = [ApiInterface::RAML_TYPE => $entity,
                                ApiInterface::RAML_ID   => $attrs[ApiInterface::RAML_ID]];
                }
            }
        } elseif ($relations instanceof Model) {
            $attrs   = $relations->getAttributes();
            $jsonArr = [ApiInterface::RAML_TYPE => $entity,
                        ApiInterface::RAML_ID   => $attrs[ApiInterface::RAML_ID]];
        }

        return $jsonArr;
    }

    /**
     * Output errors in JSON API compatible format
     * @param array $errors
     * @param bool $return
     * @return string
     */
    public static function outputErrors(array $errors, bool $return = false)
    {
        $arr[JSONApiInterface::CONTENT_ERRORS] = [];

        if (empty($errors) === false) {
            $arr[JSONApiInterface::CONTENT_ERRORS] = $errors;
        }
        // errors and codes must be clear with readable json
        $encoded = self::encode($arr, JSON_NUMERIC_CHECK | JSON_PRETTY_PRINT);
        if (false === $return && env('APP_ENV') !== 'dev') {
            echo $encoded;
            exit(JSONApiInterface::EXIT_STATUS_ERROR);

        }
        return $encoded;
    }

    /**
     *
     * @param array $errors
     * @return string
     */
    public function getErrors(array $errors) : string
    {
        $arr[JSONApiInterface::CONTENT_ERRORS] = [];

        if (empty($errors) === false) {
            $arr[JSONApiInterface::CONTENT_ERRORS] = $errors;
        }

        return self::encode($arr, JSON_NUMERIC_CHECK | JSON_PRETTY_PRINT);
    }

    /**
     * Returns composition of relations
     *
     * @param Request $request
     * @param array $data
     * @return string
     */
    public static function prepareSerializedRelations(Request $request, array $data) : string
    {
        $arr[JSONApiInterface::CONTENT_LINKS] = [

            JSONApiInterface::CONTENT_SELF => $request->getUri(),
        ];

        $arr[JSONApiInterface::CONTENT_DATA] = $data;

        return self::encode($arr);
    }

    /**
     * @param BaseFormRequest $formRequest
     * @param                 $model
     * @param string $entity
     * @param bool $isCollection
     *
     * @param array $meta
     * @return Collection|Item
     */
    public static function getResource(BaseFormRequest $formRequest, $model, string $entity, bool $isCollection = false, array $meta = [])
    {
        $transformer = new DefaultTransformer($formRequest);
        if ($isCollection === true) {
            $collection = new Collection($model, $transformer, strtolower($entity));
            if (empty($meta) === false) {
                $collection->setMeta($meta);
            }

            return $collection;
        }

        $item = new Item($model, $transformer, strtolower($entity));
        $item->setMeta($meta);

        return $item;
    }

    /**
     * @param ResourceInterface $resource
     * @param array $data
     * @return string
     */
    public static function prepareSerializedData(ResourceInterface $resource, $data = ModelsInterface::DEFAULT_DATA) : string
    {
        if (empty($resource->getData())) { // preventing 3d party libs (League etc) from crash on empty data
            return self::encode([
                ModelsInterface::PARAM_DATA => []
            ]);
        }

        $host    = $_SERVER['HTTP_HOST'];
        $manager = new Manager();

        if (isset($_GET['include'])) {
            $manager->parseIncludes($_GET['include']);
        }

        $manager->setSerializer(new JsonApiSerializer($host));
        return self::getSelectedData($manager->createData($resource)->toJson(), $data);
    }

    /**
     * @param array $array
     * @param int $opts
     * @return string
     */
    public static function encode(array $array, int $opts = 0)
    {
        return json_encode($array, $opts);
    }

    /**
     * @param mixed $json
     * @return mixed
     */
    public static function decode(string $json): array
    {
        return json_decode($json, true);
    }

    /**
     * @param string $json
     * @return array
     */
    public static function parse(string $json): array
    {
        return self::decode($json);
    }

    /**
     * @param string $json
     * @param array $data
     * @return string
     */
    private static function getSelectedData(string $json, array $data) : string
    {
        if (current($data) === PhpInterface::ASTERISK) {// do nothing - grab all fields
            return $json;
        }

        $jsonArr = self::decode($json);
        $current = current($jsonArr[ApiInterface::RAML_DATA]);

        if (empty($current[JSONApiInterface::CONTENT_ATTRIBUTES]) === false) {// this is an array of values
            self::unsetArray($jsonArr, $data);
        } else {// this is just one element
            self::unsetObject($jsonArr, $data);
        }

        return self::encode($jsonArr);
    }

    /**
     *
     * @param array &$json
     * @param array $data
     */
    private static function unsetArray(array &$json, array $data) : void
    {
        foreach ($json as &$jsonObject) {
            foreach ($jsonObject as &$v) {
                foreach ($v[JSONApiInterface::CONTENT_ATTRIBUTES] as $key => $attr) {
                    if (in_array($key, $data) === false) {
                        unset($v[JSONApiInterface::CONTENT_ATTRIBUTES][$key]);
                    }
                }
            }
        }
    }

    /**
     * @param array $json
     * @param array $data
     */
    private static function unsetObject(array &$json, array $data) : void
    {
        foreach ($json[JSONApiInterface::CONTENT_DATA][JSONApiInterface::CONTENT_ATTRIBUTES] as $k => $v) {
            if (in_array($k, $data) === false) {
                unset($json[JSONApiInterface::CONTENT_DATA][JSONApiInterface::CONTENT_ATTRIBUTES][$k]);
            }
        }
    }
}

1			<?php
2
3			namespace SoliDry\Helpers;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Illuminate\Http\Request;
			0 ignored issues – show Bug introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `SoliDry\Helpers\Request`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7			use League\Fractal\Manager;
8			use League\Fractal\Resource\Collection;
9			use League\Fractal\Resource\Item;
10			use League\Fractal\Resource\ResourceInterface;
11			use League\Fractal\Serializer\JsonApiSerializer;
12			use SoliDry\Types\ModelsInterface;
13			use SoliDry\Types\PhpInterface;
14			use SoliDry\Types\ApiInterface;
15			use SoliDry\Extension\BaseFormRequest;
16			use SoliDry\Extension\JSONApiInterface;
17			use SoliDry\Transformers\DefaultTransformer;
18
19			/**
20			* Class Json
21			* @package SoliDry\Helpers
22			*/
23			class Json
24			{
25			/**
26			* @param array $jsonApiArr
27			*
28			* @return array
29			*/
30			public static function getAttributes(array $jsonApiArr) : array
31			{
32			return empty($jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_ATTRS]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_ATTRS];
33			}
34
35			/**
36			* Returns an array of bulk attributes for each element
37			*
38			* @param array $jsonApiArr
39			* @return array
40			*/
41			public static function getBulkAttributes(array $jsonApiArr) : array
42			{
43			return empty($jsonApiArr[ApiInterface::RAML_DATA]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA];
44			}
45
46			/**
47			* @param array $jsonApiArr
48			*
49			* @return array
50			*/
51			public static function getRelationships(array $jsonApiArr) : array
52			{
53			return empty($jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_RELATIONSHIPS]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA][ApiInterface::RAML_RELATIONSHIPS];
54			}
55
56			/**
57			* @param array $jsonApiArr
58			*
59			* @return array
60			*/
61			public static function getData(array $jsonApiArr) : array
62			{
63			return empty($jsonApiArr[ApiInterface::RAML_DATA]) ? [] : $jsonApiArr[ApiInterface::RAML_DATA];
64			}
65
66			/**
67			* @param $relations \Illuminate\Database\Eloquent\Collection
68			* @param string $entity
69			* @return array JSON API rels compatible array
70			*/
71			public static function getRelations($relations, string $entity) : array
72			{
73			$jsonArr = [];
74			if ($relations instanceof \Illuminate\Database\Eloquent\Collection) {
75			$cnt = count($relations);
76			if ($cnt > 1) {
77			foreach ($relations as $v) {
78			$attrs = $v->getAttributes();
79			$jsonArr[] = [ApiInterface::RAML_TYPE => $entity,
80			ApiInterface::RAML_ID => $attrs[ApiInterface::RAML_ID]];
81			}
82			} else {
83			foreach ($relations as $v) {
84			$attrs = $v->getAttributes();
85			$jsonArr = [ApiInterface::RAML_TYPE => $entity,
86			ApiInterface::RAML_ID => $attrs[ApiInterface::RAML_ID]];
87			}
88			}
89			} elseif ($relations instanceof Model) {
90			$attrs = $relations->getAttributes();
91			$jsonArr = [ApiInterface::RAML_TYPE => $entity,
92			ApiInterface::RAML_ID => $attrs[ApiInterface::RAML_ID]];
93			}
94
95			return $jsonArr;
96			}
97
98			/**
99			* Output errors in JSON API compatible format
100			* @param array $errors
101			* @param bool $return
102			* @return string
103			*/
104			public static function outputErrors(array $errors, bool $return = false)
105			{
106			$arr[JSONApiInterface::CONTENT_ERRORS] = [];
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report `$arr` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$arr = array();` before regardless. Loading history...
107			if (empty($errors) === false) {
108			$arr[JSONApiInterface::CONTENT_ERRORS] = $errors;
109			}
110			// errors and codes must be clear with readable json
111			$encoded = self::encode($arr, JSON_NUMERIC_CHECK \| JSON_PRETTY_PRINT);
112			if (false === $return && env('APP_ENV') !== 'dev') {
113			echo $encoded;
114			exit(JSONApiInterface::EXIT_STATUS_ERROR);
			0 ignored issues – show Best Practice introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
115			}
116			return $encoded;
117			}
118
119			/**
120			*
121			* @param array $errors
122			* @return string
123			*/
124			public function getErrors(array $errors) : string
125			{
126			$arr[JSONApiInterface::CONTENT_ERRORS] = [];
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-02-10 18:56 UTC by Report Bug Copy Issue Report `$arr` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$arr = array();` before regardless. Loading history...
127			if (empty($errors) === false) {
128			$arr[JSONApiInterface::CONTENT_ERRORS] = $errors;
129			}
130
131			return self::encode($arr, JSON_NUMERIC_CHECK \| JSON_PRETTY_PRINT);
132			}
133
134			/**
135			* Returns composition of relations
136			*
137			* @param Request $request
138			* @param array $data
139			* @return string
140			*/
141			public static function prepareSerializedRelations(Request $request, array $data) : string
142			{
143			$arr[JSONApiInterface::CONTENT_LINKS] = [
			0 ignored issues – show Comprehensibility Best Practice introduced 2019-02-09 12:55 UTC by Report Bug Copy Issue Report `$arr` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$arr = array();` before regardless. Loading history...
144			JSONApiInterface::CONTENT_SELF => $request->getUri(),
145			];
146
147			$arr[JSONApiInterface::CONTENT_DATA] = $data;
148
149			return self::encode($arr);
150			}
151
152			/**
153			* @param BaseFormRequest $formRequest
154			* @param $model
155			* @param string $entity
156			* @param bool $isCollection
157			*
158			* @param array $meta
159			* @return Collection\|Item
160			*/
161			public static function getResource(BaseFormRequest $formRequest, $model, string $entity, bool $isCollection = false, array $meta = [])
162			{
163			$transformer = new DefaultTransformer($formRequest);
164			if ($isCollection === true) {
165			$collection = new Collection($model, $transformer, strtolower($entity));
166			if (empty($meta) === false) {
167			$collection->setMeta($meta);
168			}
169
170			return $collection;
171			}
172
173			$item = new Item($model, $transformer, strtolower($entity));
174			$item->setMeta($meta);
175
176			return $item;
177			}
178
179			/**
180			* @param ResourceInterface $resource
181			* @param array $data
182			* @return string
183			*/
184			public static function prepareSerializedData(ResourceInterface $resource, $data = ModelsInterface::DEFAULT_DATA) : string
185			{
186			if (empty($resource->getData())) { // preventing 3d party libs (League etc) from crash on empty data
187			return self::encode([
188			ModelsInterface::PARAM_DATA => []
189			]);
190			}
191
192			$host = $_SERVER['HTTP_HOST'];
193			$manager = new Manager();
194
195			if (isset($_GET['include'])) {
196			$manager->parseIncludes($_GET['include']);
197			}
198
199			$manager->setSerializer(new JsonApiSerializer($host));
200			return self::getSelectedData($manager->createData($resource)->toJson(), $data);
201			}
202
203			/**
204			* @param array $array
205			* @param int $opts
206			* @return string
207			*/
208			public static function encode(array $array, int $opts = 0)
209			{
210			return json_encode($array, $opts);
211			}
212
213			/**
214			* @param mixed $json
215			* @return mixed
216			*/
217			public static function decode(string $json): array
218			{
219			return json_decode($json, true);
220			}
221
222			/**
223			* @param string $json
224			* @return array
225			*/
226			public static function parse(string $json): array
227			{
228			return self::decode($json);
229			}
230
231			/**
232			* @param string $json
233			* @param array $data
234			* @return string
235			*/
236			private static function getSelectedData(string $json, array $data) : string
237			{
238			if (current($data) === PhpInterface::ASTERISK) {// do nothing - grab all fields
239			return $json;
240			}
241
242			$jsonArr = self::decode($json);
243			$current = current($jsonArr[ApiInterface::RAML_DATA]);
244
245			if (empty($current[JSONApiInterface::CONTENT_ATTRIBUTES]) === false) {// this is an array of values
246			self::unsetArray($jsonArr, $data);
247			} else {// this is just one element
248			self::unsetObject($jsonArr, $data);
249			}
250
251			return self::encode($jsonArr);
252			}
253
254			/**
255			*
256			* @param array &$json
257			* @param array $data
258			*/
259			private static function unsetArray(array &$json, array $data) : void
260			{
261			foreach ($json as &$jsonObject) {
262			foreach ($jsonObject as &$v) {
263			foreach ($v[JSONApiInterface::CONTENT_ATTRIBUTES] as $key => $attr) {
264			if (in_array($key, $data) === false) {
265			unset($v[JSONApiInterface::CONTENT_ATTRIBUTES][$key]);
266			}
267			}
268			}
269			}
270			}
271
272			/**
273			* @param array $json
274			* @param array $data
275			*/
276			private static function unsetObject(array &$json, array $data) : void
277			{
278			foreach ($json[JSONApiInterface::CONTENT_DATA][JSONApiInterface::CONTENT_ATTRIBUTES] as $k => $v) {
279			if (in_array($k, $data) === false) {
280			unset($json[JSONApiInterface::CONTENT_DATA][JSONApiInterface::CONTENT_ATTRIBUTES][$k]);
281			}
282			}
283			}
284			}

SoliDry / api-generator

Push — master ( 813b52...b69cbb )

Json::encode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like