ItemSetupTrait::valPropStructure() - Code Metrics - Inspection of "Improved code climate" - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 754f5c...d85481 )

by Joschi

created 2017-05-30 07:43 UTC

ItemSetupTrait::valPropStructure() A

↳ Parent: ItemSetupTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

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

<?php

/**
 * micrometa
 *
 * @category Jkphl
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Domain
 * @author Joschi Kuphal <[email protected]> / @jkphl
 * @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 * @license http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Micrometa\Domain\Item;

use Jkphl\Micrometa\Domain\Exceptions\InvalidArgumentException;
use Jkphl\Micrometa\Domain\Factory\IriFactory;
use Jkphl\Micrometa\Domain\Factory\PropertyListFactoryInterface;
use Jkphl\Micrometa\Domain\Value\ValueInterface;

/**
 * Item setup methods
 *
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Domain
 */
trait ItemSetupTrait
{
    /**
     * Property list factory
     *
     * @var PropertyListFactoryInterface
     */
    protected $propertyListFactory;

    /**
     * Item type(s)
     *
     * @var \stdClass[]
     */
    protected $type;

    /**
     * Item properties
     *
     * @var PropertyListInterface
     */
    protected $properties;

    /**
     * Item ID
     *
     * @var string
     */
    protected $itemId;

    /**
     * Item language
     *
     * @var string
     */
    protected $itemLanguage;

    /**
     * Setup the item
     *
     * @param PropertyListFactoryInterface $propertyListFactory Property list factory
     * @param string[]|\stdClass[] $type Item type(s)
     * @param \stdClass[] $properties Item properties
     * @param string $itemId Item ID
     * @param string $itemLanguage Item language
     */
    protected function setup(
        PropertyListFactoryInterface $propertyListFactory,
        array $type,
        array $properties,
        $itemId,
        $itemLanguage
    ) {
        $this->propertyListFactory = $propertyListFactory;
        $this->type = $this->valTypes($type);
        $this->properties = $this->valProperties($properties);
        $this->itemId = $itemId ?: null;
        $this->itemLanguage = $itemLanguage ?: null;
    }

    /**
     * Validate and sanitize the item types
     *
     * @param string[]|\stdClass[] $types Item types
     * @return array Validated item types
     * @throws InvalidArgumentException If there are no valid types
     */
    protected function valTypes(array $types)
    {
        $nonEmptyTypes = array_filter(array_map([$this, 'valType'], $types));

        // If there are no valid types
        if (!count($nonEmptyTypes)) {
            throw new InvalidArgumentException(
                InvalidArgumentException::EMPTY_TYPES_STR,
                InvalidArgumentException::EMPTY_TYPES
            );
        }

        return array_values($nonEmptyTypes);
    }

    /**
     * Validate the item properties
     *
     * @param array $properties Item properties
     * @return PropertyListInterface Validated item properties
     * @throws InvalidArgumentException If the property name is empty
     */
    protected function valProperties(array $properties)
    {
        $validatedProperties = $this->propertyListFactory->create();

        // Run through all validated properties
        foreach (array_filter(array_map([$this, 'valProp'], $properties)) as $property) {
            $validatedProperties->add($property);
        }

        return $validatedProperties;
    }

    /**
     * Validate a single property
     *
     * @param \stdClass $property Property
     * @return \stdClass Validated property
     */
    protected function valProp($property)
    {
        // Validate the property structure
        $this->valPropStructure($property);

        // If the property has values
        if (count($property->values)) {
            // Validate the property name
            $property->name = $this->valPropName($property);

            // Validate the property values
            $property->values = $this->valPropValues($property->values);

            // If the property has significant values
            if (count($property->values)) {
                return $property;
            }
        }

        return null;
    }

    /**
     * Validate the structure of a property object
     *
     * @param \stdClass $property Property object
     * @throws InvalidArgumentException If the property object is invalid
     */
    protected function valPropStructure($property)
    {
        // If the property object is invalid
        if (!is_object($property) || !$this->valPropProperties($property)) {
            throw new InvalidArgumentException(
                InvalidArgumentException::INVALID_PROPERTY_STR,
                InvalidArgumentException::INVALID_PROPERTY
            );
        }
    }

    /**
     * Validate the properties of a property
     *
     * @param \stdClass $property Property
     * @return bool Property properties are valid
     */
    protected function valPropProperties($property)
    {
        return isset($property->profile)
            && isset($property->name)
            && isset($property->values)
            && is_array($property->values);
    }

    /**
     * Validate a property name
     *
     * @param \stdClass $property Property
     * @return string Property name
     */
    protected function valPropName($property)
    {
        $propertyName = trim($property->name);

        // If the property name is empty
        if (!strlen($propertyName)) {
            throw new InvalidArgumentException(
                InvalidArgumentException::EMPTY_PROPERTY_NAME_STR,
                InvalidArgumentException::EMPTY_PROPERTY_NAME
            );
        }

        return $propertyName;
    }

    /**
     * Validate a list of property values
     *
     * @param array $values Property values
     * @return array Validated property values
     * @throws InvalidArgumentException If the value is not a nested item
     */
    protected function valPropValues(array $values)
    {
        $validPropertyValues = [];

        // Run through all property values
        /** @var ValueInterface $value */
        foreach ($values as $value) {
            $this->procPropValue($value, $validPropertyValues);
        }

        return $validPropertyValues;
    }

    /**
     * Process a (non-empty) property value
     *
     * @param ValueInterface $value Property value
     * @param array $validPropertyValues Non-empty property values
     */
    protected function procPropValue($value, array &$validPropertyValues)
    {
        // If the value is not a nested item
        if (!($value instanceof ValueInterface)) {
            throw new InvalidArgumentException(
                sprintf(InvalidArgumentException::INVALID_PROPERTY_VALUE_STR, gettype($value)),
                InvalidArgumentException::INVALID_PROPERTY_VALUE
            );
        }

        // If the value isn't empty
        if (!$value->isEmpty()) {
            $validPropertyValues[] = $value;
        }
    }

    /**
     * Validate a single item type
     *
     * @param \stdClass|Iri|string $type Item type
     * @return Iri|null Validated item type
     * @throws InvalidArgumentException If the item type object is invalid
     */
    protected function valType($type)
    {
        $type = IriFactory::create($type);
        return strlen($type->name) ? $type : null;
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Domain
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
11		* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12		*/
13
14		/***********************************************************************************
15		* The MIT License (MIT)
16		*
17		* Copyright © 2017 Joschi Kuphal <[email protected]> / @jkphl
18		*
19		* Permission is hereby granted, free of charge, to any person obtaining a copy of
20		* this software and associated documentation files (the "Software"), to deal in
21		* the Software without restriction, including without limitation the rights to
22		* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23		* the Software, and to permit persons to whom the Software is furnished to do so,
24		* subject to the following conditions:
25		*
26		* The above copyright notice and this permission notice shall be included in all
27		* copies or substantial portions of the Software.
28		*
29		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31		* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32		* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33		* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34		* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35		***********************************************************************************/
36
37		namespace Jkphl\Micrometa\Domain\Item;
38
39		use Jkphl\Micrometa\Domain\Exceptions\InvalidArgumentException;
40		use Jkphl\Micrometa\Domain\Factory\IriFactory;
41		use Jkphl\Micrometa\Domain\Factory\PropertyListFactoryInterface;
42		use Jkphl\Micrometa\Domain\Value\ValueInterface;
43
44		/**
45		* Item setup methods
46		*
47		* @package Jkphl\Micrometa
48		* @subpackage Jkphl\Micrometa\Domain
49		*/
50		trait ItemSetupTrait
51		{
52		/**
53		* Property list factory
54		*
55		* @var PropertyListFactoryInterface
56		*/
57		protected $propertyListFactory;
58
59		/**
60		* Item type(s)
61		*
62		* @var \stdClass[]
63		*/
64		protected $type;
65
66		/**
67		* Item properties
68		*
69		* @var PropertyListInterface
70		*/
71		protected $properties;
72
73		/**
74		* Item ID
75		*
76		* @var string
77		*/
78		protected $itemId;
79
80		/**
81		* Item language
82		*
83		* @var string
84		*/
85		protected $itemLanguage;
86
87		/**
88		* Setup the item
89		*
90		* @param PropertyListFactoryInterface $propertyListFactory Property list factory
91		* @param string[]\|\stdClass[] $type Item type(s)
92		* @param \stdClass[] $properties Item properties
93		* @param string $itemId Item ID
94		* @param string $itemLanguage Item language
95		*/
96	54	protected function setup(
97		PropertyListFactoryInterface $propertyListFactory,
98		array $type,
99		array $properties,
100		$itemId,
101		$itemLanguage
102		) {
103	54	$this->propertyListFactory = $propertyListFactory;
104	54	$this->type = $this->valTypes($type);
105	52	$this->properties = $this->valProperties($properties);
106	49	$this->itemId = $itemId ?: null;
107	49	$this->itemLanguage = $itemLanguage ?: null;
108	49	}
109
110		/**
111		* Validate and sanitize the item types
112		*
113		* @param string[]\|\stdClass[] $types Item types
114		* @return array Validated item types
115		* @throws InvalidArgumentException If there are no valid types
116		*/
117	54	protected function valTypes(array $types)
118		{
119	54	$nonEmptyTypes = array_filter(array_map([$this, 'valType'], $types));
120
121		// If there are no valid types
122	53	if (!count($nonEmptyTypes)) {
123	1	throw new InvalidArgumentException(
124	1	InvalidArgumentException::EMPTY_TYPES_STR,
125	1	InvalidArgumentException::EMPTY_TYPES
126		);
127		}
128
129	52	return array_values($nonEmptyTypes);
130		}
131
132		/**
133		* Validate the item properties
134		*
135		* @param array $properties Item properties
136		* @return PropertyListInterface Validated item properties
137		* @throws InvalidArgumentException If the property name is empty
138		*/
139	52	protected function valProperties(array $properties)
140		{
141	52	$validatedProperties = $this->propertyListFactory->create();
142
143		// Run through all validated properties
144	52	foreach (array_filter(array_map([$this, 'valProp'], $properties)) as $property) {
145	36	$validatedProperties->add($property);
146		}
147
148	49	return $validatedProperties;
149		}
150
151		/**
152		* Validate a single property
153		*
154		* @param \stdClass $property Property
155		* @return \stdClass Validated property
156		*/
157	41	protected function valProp($property)
158		{
159		// Validate the property structure
160	41	$this->valPropStructure($property);
161
162		// If the property has values
163	40	if (count($property->values)) {
164		// Validate the property name
165	39	$property->name = $this->valPropName($property);
166
167		// Validate the property values
168	38	$property->values = $this->valPropValues($property->values);
169
170		// If the property has significant values
171	37	if (count($property->values)) {
172	36	return $property;
173		}
174		}
175
176	2	return null;
177		}
178
179		/**
180		* Validate the structure of a property object
181		*
182		* @param \stdClass $property Property object
183		* @throws InvalidArgumentException If the property object is invalid
184		*/
185	41	protected function valPropStructure($property)
186		{
187		// If the property object is invalid
188	41	if (!is_object($property) \|\| !$this->valPropProperties($property)) {
189	1	throw new InvalidArgumentException(
190	1	InvalidArgumentException::INVALID_PROPERTY_STR,
191	1	InvalidArgumentException::INVALID_PROPERTY
192		);
193		}
194	40	}
195
196		/**
197		* Validate the properties of a property
198		*
199		* @param \stdClass $property Property
200		* @return bool Property properties are valid
201		*/
202	41	protected function valPropProperties($property)
203		{
204	41	return isset($property->profile)
205	41	&& isset($property->name)
206	41	&& isset($property->values)
207	41	&& is_array($property->values);
208		}
209
210		/**
211		* Validate a property name
212		*
213		* @param \stdClass $property Property
214		* @return string Property name
215		*/
216	39	protected function valPropName($property)
217		{
218	39	$propertyName = trim($property->name);
219
220		// If the property name is empty
221	39	if (!strlen($propertyName)) {
222	1	throw new InvalidArgumentException(
223	1	InvalidArgumentException::EMPTY_PROPERTY_NAME_STR,
224	1	InvalidArgumentException::EMPTY_PROPERTY_NAME
225		);
226		}
227
228	38	return $propertyName;
229		}
230
231		/**
232		* Validate a list of property values
233		*
234		* @param array $values Property values
235		* @return array Validated property values
236		* @throws InvalidArgumentException If the value is not a nested item
237		*/
238	38	protected function valPropValues(array $values)
239		{
240	38	$validPropertyValues = [];
241
242		// Run through all property values
243		/** @var ValueInterface $value */
244	38	foreach ($values as $value) {
245	38	$this->procPropValue($value, $validPropertyValues);
246		}
247
248	37	return $validPropertyValues;
249		}
250
251		/**
252		* Process a (non-empty) property value
253		*
254		* @param ValueInterface $value Property value
255		* @param array $validPropertyValues Non-empty property values
256		*/
257	38	protected function procPropValue($value, array &$validPropertyValues)
258		{
259		// If the value is not a nested item
260	38	if (!($value instanceof ValueInterface)) {
261	1	throw new InvalidArgumentException(
262	1	sprintf(InvalidArgumentException::INVALID_PROPERTY_VALUE_STR, gettype($value)),
263	1	InvalidArgumentException::INVALID_PROPERTY_VALUE
264		);
265		}
266
267		// If the value isn't empty
268	37	if (!$value->isEmpty()) {
269	36	$validPropertyValues[] = $value;
270		}
271	37	}
272
273		/**
274		* Validate a single item type
275		*
276		* @param \stdClass\|Iri\|string $type Item type
277		* @return Iri\|null Validated item type
278		* @throws InvalidArgumentException If the item type object is invalid
279		*/
280	54	protected function valType($type)
281		{
282	54	$type = IriFactory::create($type);
283	53	return strlen($type->name) ? $type : null;
284		}
285		}
286

jkphl / micrometa

Push — master ( 754f5c...d85481 )

ItemSetupTrait::valPropStructure() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like