Transform::getField() - Code Metrics - Inspection of "Enabling data to be transformed from an array into..." - flipbox/transform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 500060...605dcd )

by Nate

created 2017-06-07 07:13 UTC

Transform::getField() A

↳ Parent: Transform

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	6
cp	0
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1
crap	6

<?php

/**
 * @author    Flipbox Factory
 * @copyright Copyright (c) 2017, Flipbox Digital
 * @link      https://github.com/flipbox/transform/releases/latest
 * @license   https://github.com/flipbox/transform/blob/master/LICENSE
 */

namespace Flipbox\Transform;

use Flipbox\Transform\Helpers\Object as ObjectHelper;

/**
 * @author Flipbox Factory <[email protected]>
 * @since 1.0.0
 */
class Transform
{
    /**
     * The character used to separate modifier parameters.
     *
     * @var string
     */
    public $paramDelimiter = '|';

    /**
     * Upper limit to how many levels of included data are allowed.
     *
     * @var int
     */
    public $recursionLimit = 10;

    /**
     * Scope identifiers that resources can optionally include.
     *
     * @var array
     */
    protected $includes = [];

    /**
     * Scope identifiers that resources must exclude.
     *
     * @var array
     */
    protected $excludes = [];

    /**
     * Scope identifiers that resources must return.
     *
     * @var array
     */
    protected $fields = [];

    /**
     * Array containing modifiers as keys and an array value of params.
     *
     * @var array
     */
    protected $params = [];

    /**
     * @param array $config
     */
    public function __construct(array $config = [])
    {
        ObjectHelper::configure($this, $config);
    }

    /**
     * @param string $include
     *
     * @return ParamBag
     */
    public function getParams($include): ParamBag
    {
        $params = isset($this->params[$include]) ? $this->params[$include] : [];
        return new ParamBag($params);
    }

    /*******************************************
     * INCLUDES
     *******************************************/

    /**
     * Get Requested Includes.
     *
     * @return array
     */
    public function getIncludes(): array
    {
        return $this->includes;
    }

    /**
     * Parse Include String.
     *
     * @param array|string $includes Array or csv string of resources to include
     *
     * @return $this
     */
    public function setIncludes($includes)
    {
        // Wipe these before we go again
        $this->includes = $this->params = [];

        if (is_string($includes)) {
            $includes = explode(',', $includes);
        }

        if (!is_array($includes)) {
            throw new \InvalidArgumentException(
                'The parseIncludes() method expects a string or an array. ' . gettype($includes) . ' given'
            );
        }

        foreach ($includes as $include) {
            list($includeName, $allModifiersStr) = array_pad(explode(':', $include, 2), 2, null);

            // Trim it down to a cool level of recursion
            $includeName = $this->trimToAcceptableRecursionLevel($includeName);

            if (in_array($includeName, $this->includes)) {
                continue;
            }
            $this->includes[] = $includeName;

            // No Params? Bored
            if ($allModifiersStr === null) {
                continue;
            }

            // Matches multiple instances of 'something(foo|bar|baz)' in the string
            // I guess it ignores : so you could use anything, but probably don't do that
            preg_match_all('/([\w]+)(\(([^\)]+)\))?/', $allModifiersStr, $allModifiersArr);

            // [0] is full matched strings...
            $modifierCount = count($allModifiersArr[0]);

            $modifierArr = [];

            for ($modifierIt = 0; $modifierIt < $modifierCount; $modifierIt++) {
                // [1] is the modifier
                $modifierName = $allModifiersArr[1][$modifierIt];

                // and [3] is delimited params
                $modifierParamStr = $allModifiersArr[3][$modifierIt];

                // Make modifier array key with an array of params as the value
                $modifierArr[$modifierName] = explode($this->paramDelimiter, $modifierParamStr);
            }

            $this->params[$includeName] = $modifierArr;
        }

        // This should be optional and public someday, but without it includes would never show up
        $this->autoIncludeParents();

        return $this;
    }

    /*******************************************
     * EXCLUDES
     *******************************************/

    /**
     * Get Requested Excludes.
     *
     * @return array
     */
    public function getExcludes(): array
    {
        return $this->excludes;
    }

    /**
     * Parse Exclude String.
     *
     * @param array|string $excludes Array or csv string of resources to exclude
     *
     * @return $this
     */
    public function setExcludes($excludes)
    {
        $this->excludes = [];

        if (is_string($excludes)) {
            $excludes = explode(',', $excludes);
        }

        if (!is_array($excludes)) {
            throw new \InvalidArgumentException(
                'The parseExcludes() method expects a string or an array. ' . gettype($excludes) . ' given'
            );
        }

        foreach ($excludes as $excludeName) {
            $excludeName = $this->trimToAcceptableRecursionLevel($excludeName);

            if (in_array($excludeName, $this->excludes)) {
                continue;
            }

            $this->excludes[] = $excludeName;
        }

        return $this;
    }

    /*******************************************
     * FIELDS
     *******************************************/

    /**
     * Parse field parameter.
     *
     * @param array $fields Array of fields to include. It must be an array
     *                         whose keys are resource types and values a string
     *                         of the fields to return, separated by a comma
     *
     * @return $this
     */
    public function setFields(array $fields)
    {
        $this->fields = [];

        foreach ($fields as $type => $field) {
            //Remove empty and repeated fields
            $this->fields[$type] = array_unique(array_filter(explode(',', $field)));
        }

        return $this;
    }

    /**
     * Get requested fields.
     *
     * @return array
     */
    public function getFields(): array
    {
        return $this->fields;
    }

    /**
     * Get field params for the specified type.
     *
     * @param string $type
     *
     * @return ParamBag|null
     */
    public function getField($type)
    {
        return !isset($this->fields[$type]) ?
            null :
            new ParamBag($this->fields[$type]);
    }

    /**
     * Auto-include Parents
     *
     * Look at the requested includes and automatically include the parents if they
     * are not explicitly requested. E.g: [foo, bar.baz] becomes [foo, bar, bar.baz]
     *
     * @internal
     *
     * @return void
     */
    protected function autoIncludeParents()
    {
        $parsed = [];

        foreach ($this->includes as $include) {
            $nested = explode('.', $include);

            $part = array_shift($nested);
            $parsed[] = $part;

            while (count($nested) > 0) {
                $part .= '.' . array_shift($nested);
                $parsed[] = $part;
            }
        }

        $this->includes = array_values(array_unique($parsed));
    }

    /**
     * Trim to Acceptable Recursion Level
     *
     * @internal
     *
     * @param string $includeName
     *
     * @return string
     */
    protected function trimToAcceptableRecursionLevel($includeName)
    {
        return implode('.', array_slice(explode('.', $includeName), 0, $this->recursionLimit));
    }
}


1			<?php
2
3			/**
4			* @author Flipbox Factory
5			* @copyright Copyright (c) 2017, Flipbox Digital
6			* @link https://github.com/flipbox/transform/releases/latest
7			* @license https://github.com/flipbox/transform/blob/master/LICENSE
8			*/
9
10			namespace Flipbox\Transform;
11
12			use Flipbox\Transform\Helpers\Object as ObjectHelper;
13
14			/**
15			* @author Flipbox Factory <[email protected]>
16			* @since 1.0.0
17			*/
18			class Transform
19			{
20			/**
21			* The character used to separate modifier parameters.
22			*
23			* @var string
24			*/
25			public $paramDelimiter = '\|';
26
27			/**
28			* Upper limit to how many levels of included data are allowed.
29			*
30			* @var int
31			*/
32			public $recursionLimit = 10;
33
34			/**
35			* Scope identifiers that resources can optionally include.
36			*
37			* @var array
38			*/
39			protected $includes = [];
40
41			/**
42			* Scope identifiers that resources must exclude.
43			*
44			* @var array
45			*/
46			protected $excludes = [];
47
48			/**
49			* Scope identifiers that resources must return.
50			*
51			* @var array
52			*/
53			protected $fields = [];
54
55			/**
56			* Array containing modifiers as keys and an array value of params.
57			*
58			* @var array
59			*/
60			protected $params = [];
61
62			/**
63			* @param array $config
64			*/
65			public function __construct(array $config = [])
66			{
67			ObjectHelper::configure($this, $config);
68			}
69
70			/**
71			* @param string $include
72			*
73			* @return ParamBag
74			*/
75			public function getParams($include): ParamBag
76			{
77			$params = isset($this->params[$include]) ? $this->params[$include] : [];
78			return new ParamBag($params);
79			}
80
81			/*******************************************
82			* INCLUDES
83			*******************************************/
84
85			/**
86			* Get Requested Includes.
87			*
88			* @return array
89			*/
90			public function getIncludes(): array
91			{
92			return $this->includes;
93			}
94
95			/**
96			* Parse Include String.
97			*
98			* @param array\|string $includes Array or csv string of resources to include
99			*
100			* @return $this
101			*/
102			public function setIncludes($includes)
103			{
104			// Wipe these before we go again
105			$this->includes = $this->params = [];
106
107			if (is_string($includes)) {
108			$includes = explode(',', $includes);
109			}
110
111			if (!is_array($includes)) {
112			throw new \InvalidArgumentException(
113			'The parseIncludes() method expects a string or an array. ' . gettype($includes) . ' given'
114			);
115			}
116
117			foreach ($includes as $include) {
118			list($includeName, $allModifiersStr) = array_pad(explode(':', $include, 2), 2, null);
119
120			// Trim it down to a cool level of recursion
121			$includeName = $this->trimToAcceptableRecursionLevel($includeName);
122
123			if (in_array($includeName, $this->includes)) {
124			continue;
125			}
126			$this->includes[] = $includeName;
127
128			// No Params? Bored
129			if ($allModifiersStr === null) {
130			continue;
131			}
132
133			// Matches multiple instances of 'something(foo\|bar\|baz)' in the string
134			// I guess it ignores : so you could use anything, but probably don't do that
135			preg_match_all('/([\w]+)(\(([^\)]+)\))?/', $allModifiersStr, $allModifiersArr);
136
137			// [0] is full matched strings...
138			$modifierCount = count($allModifiersArr[0]);
139
140			$modifierArr = [];
141
142			for ($modifierIt = 0; $modifierIt < $modifierCount; $modifierIt++) {
143			// [1] is the modifier
144			$modifierName = $allModifiersArr[1][$modifierIt];
145
146			// and [3] is delimited params
147			$modifierParamStr = $allModifiersArr[3][$modifierIt];
148
149			// Make modifier array key with an array of params as the value
150			$modifierArr[$modifierName] = explode($this->paramDelimiter, $modifierParamStr);
151			}
152
153			$this->params[$includeName] = $modifierArr;
154			}
155
156			// This should be optional and public someday, but without it includes would never show up
157			$this->autoIncludeParents();
158
159			return $this;
160			}
161
162			/*******************************************
163			* EXCLUDES
164			*******************************************/
165
166			/**
167			* Get Requested Excludes.
168			*
169			* @return array
170			*/
171			public function getExcludes(): array
172			{
173			return $this->excludes;
174			}
175
176			/**
177			* Parse Exclude String.
178			*
179			* @param array\|string $excludes Array or csv string of resources to exclude
180			*
181			* @return $this
182			*/
183			public function setExcludes($excludes)
184			{
185			$this->excludes = [];
186
187			if (is_string($excludes)) {
188			$excludes = explode(',', $excludes);
189			}
190
191			if (!is_array($excludes)) {
192			throw new \InvalidArgumentException(
193			'The parseExcludes() method expects a string or an array. ' . gettype($excludes) . ' given'
194			);
195			}
196
197			foreach ($excludes as $excludeName) {
198			$excludeName = $this->trimToAcceptableRecursionLevel($excludeName);
199
200			if (in_array($excludeName, $this->excludes)) {
201			continue;
202			}
203
204			$this->excludes[] = $excludeName;
205			}
206
207			return $this;
208			}
209
210			/*******************************************
211			* FIELDS
212			*******************************************/
213
214			/**
215			* Parse field parameter.
216			*
217			* @param array $fields Array of fields to include. It must be an array
218			* whose keys are resource types and values a string
219			* of the fields to return, separated by a comma
220			*
221			* @return $this
222			*/
223			public function setFields(array $fields)
224			{
225			$this->fields = [];
226
227			foreach ($fields as $type => $field) {
228			//Remove empty and repeated fields
229			$this->fields[$type] = array_unique(array_filter(explode(',', $field)));
230			}
231
232			return $this;
233			}
234
235			/**
236			* Get requested fields.
237			*
238			* @return array
239			*/
240			public function getFields(): array
241			{
242			return $this->fields;
243			}
244
245			/**
246			* Get field params for the specified type.
247			*
248			* @param string $type
249			*
250			* @return ParamBag\|null
251			*/
252			public function getField($type)
253			{
254			return !isset($this->fields[$type]) ?
255			null :
256			new ParamBag($this->fields[$type]);
257			}
258
259			/**
260			* Auto-include Parents
261			*
262			* Look at the requested includes and automatically include the parents if they
263			* are not explicitly requested. E.g: [foo, bar.baz] becomes [foo, bar, bar.baz]
264			*
265			* @internal
266			*
267			* @return void
268			*/
269			protected function autoIncludeParents()
270			{
271			$parsed = [];
272
273			foreach ($this->includes as $include) {
274			$nested = explode('.', $include);
275
276			$part = array_shift($nested);
277			$parsed[] = $part;
278
279			while (count($nested) > 0) {
280			$part .= '.' . array_shift($nested);
281			$parsed[] = $part;
282			}
283			}
284
285			$this->includes = array_values(array_unique($parsed));
286			}
287
288			/**
289			* Trim to Acceptable Recursion Level
290			*
291			* @internal
292			*
293			* @param string $includeName
294			*
295			* @return string
296			*/
297			protected function trimToAcceptableRecursionLevel($includeName)
298			{
299			return implode('.', array_slice(explode('.', $includeName), 0, $this->recursionLimit));
300			}
301			}
302

flipbox / transform

Push — master ( 500060...605dcd )

Transform::getField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like