Item::toObject() - Code Metrics - Inspection of "Encapsulation over inheritance: hide ItemList insi..." - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#66)

by Richard van

created 2021-06-15 10:22 UTC

Item::toObject() A

↳ Parent: Item

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

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

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 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\Ports\Item;

use Jkphl\Micrometa\Application\Contract\ValueInterface;
use Jkphl\Micrometa\Application\Factory\AliasFactory;
use Jkphl\Micrometa\Application\Factory\PropertyListFactory;
use Jkphl\Micrometa\Application\Item\ItemInterface as ApplicationItemInterface;
use Jkphl\Micrometa\Application\Item\PropertyListInterface;
use Jkphl\Micrometa\Domain\Exceptions\OutOfBoundsException as DomainOutOfBoundsException;
use Jkphl\Micrometa\Domain\Item\Iri;
use Jkphl\Micrometa\Infrastructure\Factory\ItemFactory;
use Jkphl\Micrometa\Infrastructure\Factory\ProfiledNamesFactory;
use Jkphl\Micrometa\Infrastructure\Parser\ProfiledNamesList;
use Jkphl\Micrometa\Ports\Exceptions\InvalidArgumentException;
use Jkphl\Micrometa\Ports\Exceptions\OutOfBoundsException;

/**
 * Micro information item
 *
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 */
class Item implements ItemInterface, ItemListFacade
{
    /**
     * Application item
     *
     * @var ApplicationItemInterface
     */
    protected $item;

    /**
     * @var ItemList
     */
    private $itemList;

    /**
     * Item constructor
     *
     * @param ApplicationItemInterface $item Application item
     */
    public function __construct(ApplicationItemInterface $item)
    {
        $this->item = $item;
        $this->itemList = new ItemList(ItemFactory::createFromApplicationItems($this->item->getChildren()));
    }

    /**
     * Get the first value of an item property
     *
     * @param string $name Item property name
     *
     * @return ValueInterface|ValueInterface[]|array|ItemInterface First value of an item property
     * @api
     */
    public function __get($name)
    {
        return $this->getProperty($name, null, 0);
    }

    /**
     * Get a single property (value)
     *
     * @param string|\stdClass|Iri $name Property name
     * @param string $profile            Property profile
     * @param int|null $index            Property value index
     *
     * @return ValueInterface|ValueInterface[]|array|ItemInterface Property value(s)
     * @throws OutOfBoundsException If the property name is unknown
     * @throws OutOfBoundsException If the property value index is out of bounds
     * @api
     */
    public function getProperty($name, $profile = null, $index = null)
    {
        try {
            $propertyValues = $this->item->getProperty($name, $profile);
        } catch (DomainOutOfBoundsException $exception) {
            throw new OutOfBoundsException($exception->getMessage(), $exception->getCode());
        }

        // Return the value(s)
        return ($index === null) ?
            array_map([$this, 'getPropertyValue'], $propertyValues) : $this->getPropertyIndex($propertyValues, $index);
    }

    /**
     * Return a particular property index
     *
     * @param ValueInterface[] $propertyValues Property values
     * @param int $index                       Property value index
     *
     * @return ValueInterface|ItemInterface
     */
    protected function getPropertyIndex(array $propertyValues, $index)
    {
        // If the property value index is out of bounds
        if (!isset($propertyValues[$index])) {
            throw new OutOfBoundsException(
                sprintf(OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX_STR, $index),
                OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX
            );
        }

        return $this->getPropertyValue($propertyValues[$index]);
    }

    /**
     * Prepare a property value for returning it
     *
     * @param ValueInterface $value Property value
     *
     * @return ValueInterface|ItemInterface Returnable property value
     */
    protected function getPropertyValue(ValueInterface $value)
    {
        return ($value instanceof ApplicationItemInterface) ?
            ItemFactory::createFromApplicationItem($value) : $value;
    }

    /**
     * Return whether the item is of a particular type (or contained in a list of types)
     *
     * The item type(s) can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
     *
     * @param array ...$types Item types
     *
     * @return boolean Item type is contained in the list of types
     * @api
     */
    public function isOfType(...$types)
    {
        /** @var ProfiledNamesList $profiledTypes */
        $profiledTypes = ProfiledNamesFactory::createFromArguments($types);
        $aliasFactory  = new AliasFactory();

        // Run through all item types
        /** @var \stdClass $itemType */
        foreach ($this->item->getType() as $itemType) {
            $itemTypeNames = $aliasFactory->createAliases($itemType->name);
            if ($this->isOfProfiledTypes($itemType->profile, $itemTypeNames, $profiledTypes)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Return whether an aliased item type is contained in a set of query types
     *
     * @param string $profile          Type profile
     * @param array $names             Aliased type names
     * @param ProfiledNamesList $types Query types
     *
     * @return bool Item type is contained in the set of query types
     */
    protected function isOfProfiledTypes($profile, array $names, ProfiledNamesList $types)
    {
        // Run through all query types
        /** @var \stdClass $queryType */
        foreach ($types as $queryType) {
            if ($this->isTypeInNames($queryType, $profile, $names)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Test whether a type is contained in a list of names
     *
     * @param \stdClass $type Type
     * @param string $profile Type profile
     * @param array $names    Aliased type names
     *
     * @return bool Type is contained in names list
     */
    protected function isTypeInNames($type, $profile, array $names)
    {
        return in_array($type->name, $names) &&
               (($type->profile === null) ? true : ($type->profile == $profile));
    }

    /**
     * Get all values of the first available property in a stack
     *
     * The property stack can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
     *
     * @param array $properties Properties
     *
     * @return ValueInterface[]|array Property values
     * @throws InvalidArgumentException If no property name was given
     * @throws OutOfBoundsException If none of the requested properties is known
     * @api
     */
    public function getFirstProperty(...$properties)
    {
        /** @var ProfiledNamesList $properties */
        $properties = ProfiledNamesFactory::createFromArguments(func_get_args());

        // Prepare a default exception
        $exception = new OutOfBoundsException(
            OutOfBoundsException::NO_MATCHING_PROPERTIES_STR,
            OutOfBoundsException::NO_MATCHING_PROPERTIES
        );

        // Run through all properties
        foreach ($properties as $property) {
            try {
                return (array)$this->getProperty($property->name, $property->profile);
            } catch (OutOfBoundsException $exception) {
                continue;
            }
        }

        throw $exception;
    }

    /**
     * Return all properties
     *
     * @return PropertyListInterface Properties
     * @api
     */
    public function getProperties()
    {
        $propertyList = (new PropertyListFactory())->create();
        foreach ($this->item->getProperties() as $propertyName => $propertyValues) {
            $propertyList[$propertyName] = array_map([$this, 'getPropertyValue'], $propertyValues);
        }

        return $propertyList;
    }

    /**
     * Return an object representation of the item
     *
     * @return \stdClass Micro information item
     * @api
     */
    public function toObject()
    {
        return $this->item->export();
    }

    /**
     * Get the item type
     *
     * @return \stdClass[] Item type
     * @api
     */
    public function getType()
    {
        return $this->item->getType();
    }

    /**
     * Get the item format
     *
     * @return int Item format
     * @api
     */
    public function getFormat()
    {
        return $this->item->getFormat();
    }

    /**
     * Get the item ID
     *
     * @return string Item ID
     * @api
     */
    public function getId()
    {
        return $this->item->getId();
    }

    /**
     * Get the item language
     *
     * @return string Item language
     * @api
     */
    public function getLanguage()
    {
        return $this->item->getLanguage();
    }

    /**
     * Return the item value
     *
     * @return string Item value
     * @api
     */
    public function getValue()
    {
        return $this->item->getValue();
    }

    /**
     * Filter the items by item type(s).
     *
     * @param array ...$types Item types
     *
     * @return ItemInterface[] Items matching the requested types
     */
    public function getItems(...$types)
    {
        return $this->itemList->getItems(...$types);
    }

    /**
     * Return the first item, optionally of particular types.
     *
     * @param array ...$types Item types
     *
     * @return ItemInterface Item
     */
    public function getFirstItem(...$types)
    {
        return $this->itemList->getFirstItem(...$types);
    }

    /**
     * Count the elements in the item list.
     *
     * @return int
     */
    public function count()
    {
        return $this->itemList->count();
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Ports
9		* @author Joschi Kuphal <[email protected]> / @jkphl
10		* @copyright Copyright © 2018 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 © 2018 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\Ports\Item;
38
39		use Jkphl\Micrometa\Application\Contract\ValueInterface;
40		use Jkphl\Micrometa\Application\Factory\AliasFactory;
41		use Jkphl\Micrometa\Application\Factory\PropertyListFactory;
42		use Jkphl\Micrometa\Application\Item\ItemInterface as ApplicationItemInterface;
43		use Jkphl\Micrometa\Application\Item\PropertyListInterface;
44		use Jkphl\Micrometa\Domain\Exceptions\OutOfBoundsException as DomainOutOfBoundsException;
45		use Jkphl\Micrometa\Domain\Item\Iri;
46		use Jkphl\Micrometa\Infrastructure\Factory\ItemFactory;
47		use Jkphl\Micrometa\Infrastructure\Factory\ProfiledNamesFactory;
48		use Jkphl\Micrometa\Infrastructure\Parser\ProfiledNamesList;
49		use Jkphl\Micrometa\Ports\Exceptions\InvalidArgumentException;
50		use Jkphl\Micrometa\Ports\Exceptions\OutOfBoundsException;
51
52		/**
53		* Micro information item
54		*
55		* @package Jkphl\Micrometa
56		* @subpackage Jkphl\Micrometa\Ports
57		*/
58		class Item implements ItemInterface, ItemListFacade
59		{
60		/**
61		* Application item
62		*
63		* @var ApplicationItemInterface
64		*/
65		protected $item;
66
67		/**
68		* @var ItemList
69		*/
70		private $itemList;
71
72	16	/**
73		* Item constructor
74	16	*
75	16	* @param ApplicationItemInterface $item Application item
76	16	*/
77		public function __construct(ApplicationItemInterface $item)
78		{
79		$this->item = $item;
80		$this->itemList = new ItemList(ItemFactory::createFromApplicationItems($this->item->getChildren()));
81		}
82
83		/**
84		* Get the first value of an item property
85		*
86	2	* @param string $name Item property name
87		*
88	2	* @return ValueInterface\|ValueInterface[]\|array\|ItemInterface First value of an item property
89		* @api
90		*/
91		public function __get($name)
92		{
93		return $this->getProperty($name, null, 0);
94		}
95
96		/**
97		* Get a single property (value)
98		*
99		* @param string\|\stdClass\|Iri $name Property name
100		* @param string $profile Property profile
101		* @param int\|null $index Property value index
102		*
103	7	* @return ValueInterface\|ValueInterface[]\|array\|ItemInterface Property value(s)
104		* @throws OutOfBoundsException If the property name is unknown
105		* @throws OutOfBoundsException If the property value index is out of bounds
106	7	* @api
107	4	*/
108	4	public function getProperty($name, $profile = null, $index = null)
109		{
110		try {
111		$propertyValues = $this->item->getProperty($name, $profile);
112	7	} catch (DomainOutOfBoundsException $exception) {
113	7	throw new OutOfBoundsException($exception->getMessage(), $exception->getCode());
114		}
115
116		// Return the value(s)
117		return ($index === null) ?
118		array_map([$this, 'getPropertyValue'], $propertyValues) : $this->getPropertyIndex($propertyValues, $index);
119		}
120
121		/**
122		* Return a particular property index
123		*
124	6	* @param ValueInterface[] $propertyValues Property values
125		* @param int $index Property value index
126		*
127	6	* @return ValueInterface\|ItemInterface
128	1	*/
129	1	protected function getPropertyIndex(array $propertyValues, $index)
130	1	{
131		// If the property value index is out of bounds
132		if (!isset($propertyValues[$index])) {
133		throw new OutOfBoundsException(
134	5	sprintf(OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX_STR, $index),
135		OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX
136		);
137		}
138
139		return $this->getPropertyValue($propertyValues[$index]);
140		}
141
142		/**
143		* Prepare a property value for returning it
144	7	*
145		* @param ValueInterface $value Property value
146	7	*
147	7	* @return ValueInterface\|ItemInterface Returnable property value
148		*/
149		protected function getPropertyValue(ValueInterface $value)
150		{
151		return ($value instanceof ApplicationItemInterface) ?
152		ItemFactory::createFromApplicationItem($value) : $value;
153		}
154
155		/**
156		* Return whether the item is of a particular type (or contained in a list of types)
157		*
158		* The item type(s) can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
159		*
160	5	* @param array ...$types Item types
161		*
162		* @return boolean Item type is contained in the list of types
163	5	* @api
164	5	*/
165		public function isOfType(...$types)
166		{
167		/** @var ProfiledNamesList $profiledTypes */
168	5	$profiledTypes = ProfiledNamesFactory::createFromArguments($types);
169	5	$aliasFactory = new AliasFactory();
170	5
171	4	// Run through all item types
172		/** @var \stdClass $itemType */
173		foreach ($this->item->getType() as $itemType) {
174		$itemTypeNames = $aliasFactory->createAliases($itemType->name);
175	3	if ($this->isOfProfiledTypes($itemType->profile, $itemTypeNames, $profiledTypes)) {
176		return true;
177		}
178		}
179
180		return false;
181		}
182
183		/**
184		* Return whether an aliased item type is contained in a set of query types
185		*
186		* @param string $profile Type profile
187	5	* @param array $names Aliased type names
188		* @param ProfiledNamesList $types Query types
189		*
190		* @return bool Item type is contained in the set of query types
191	5	*/
192	5	protected function isOfProfiledTypes($profile, array $names, ProfiledNamesList $types)
193	4	{
194		// Run through all query types
195		/** @var \stdClass $queryType */
196		foreach ($types as $queryType) {
197	3	if ($this->isTypeInNames($queryType, $profile, $names)) {
198		return true;
199		}
200		}
201
202		return false;
203		}
204
205		/**
206		* Test whether a type is contained in a list of names
207		*
208		* @param \stdClass $type Type
209	5	* @param string $profile Type profile
210		* @param array $names Aliased type names
211	5	*
212	5	* @return bool Type is contained in names list
213		*/
214		protected function isTypeInNames($type, $profile, array $names)
215		{
216		return in_array($type->name, $names) &&
217		(($type->profile === null) ? true : ($type->profile == $profile));
218		}
219
220		/**
221		* Get all values of the first available property in a stack
222		*
223		* The property stack can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
224		*
225		* @param array $properties Properties
226		*
227	2	* @return ValueInterface[]\|array Property values
228		* @throws InvalidArgumentException If no property name was given
229		* @throws OutOfBoundsException If none of the requested properties is known
230	2	* @api
231		*/
232		public function getFirstProperty(...$properties)
233	2	{
234	2	/** @var ProfiledNamesList $properties */
235	2	$properties = ProfiledNamesFactory::createFromArguments(func_get_args());
236
237		// Prepare a default exception
238		$exception = new OutOfBoundsException(
239	2	OutOfBoundsException::NO_MATCHING_PROPERTIES_STR,
240		OutOfBoundsException::NO_MATCHING_PROPERTIES
241	2	);
242	1
243	1	// Run through all properties
244		foreach ($properties as $property) {
245		try {
246		return (array)$this->getProperty($property->name, $property->profile);
247	1	} catch (OutOfBoundsException $exception) {
248		continue;
249		}
250		}
251
252		throw $exception;
253		}
254
255		/**
256	1	* Return all properties
257		*
258	1	* @return PropertyListInterface Properties
259	1	* @api
260	1	*/
261		public function getProperties()
262		{
263	1	$propertyList = (new PropertyListFactory())->create();
264		foreach ($this->item->getProperties() as $propertyName => $propertyValues) {
265		$propertyList[$propertyName] = array_map([$this, 'getPropertyValue'], $propertyValues);
266		}
267
268		return $propertyList;
269		}
270
271		/**
272	2	* Return an object representation of the item
273		*
274	2	* @return \stdClass Micro information item
275		* @api
276		*/
277		public function toObject()
278		{
279		return $this->item->export();
280		}
281
282		/**
283	1	* Get the item type
284		*
285	1	* @return \stdClass[] Item type
286		* @api
287		*/
288		public function getType()
289		{
290		return $this->item->getType();
291		}
292
293		/**
294	1	* Get the item format
295		*
296	1	* @return int Item format
297		* @api
298		*/
299		public function getFormat()
300		{
301		return $this->item->getFormat();
302		}
303
304		/**
305	1	* Get the item ID
306		*
307	1	* @return string Item ID
308		* @api
309		*/
310		public function getId()
311		{
312		return $this->item->getId();
313		}
314
315		/**
316	1	* Get the item language
317		*
318	1	* @return string Item language
319		* @api
320		*/
321		public function getLanguage()
322		{
323		return $this->item->getLanguage();
324		}
325
326		/**
327	1	* Return the item value
328		*
329	1	* @return string Item value
330		* @api
331		*/
332		public function getValue()
333		{
334		return $this->item->getValue();
335		}
336
337		/**
338		* Filter the items by item type(s).
339		*
340		* @param array ...$types Item types
341		*
342		* @return ItemInterface[] Items matching the requested types
343		*/
344		public function getItems(...$types)
345		{
346		return $this->itemList->getItems(...$types);
347		}
348
349		/**
350		* Return the first item, optionally of particular types.
351		*
352		* @param array ...$types Item types
353		*
354		* @return ItemInterface Item
355		*/
356		public function getFirstItem(...$types)
357		{
358		return $this->itemList->getFirstItem(...$types);
359		}
360
361		/**
362		* Count the elements in the item list.
363		*
364		* @return int
365		*/
366		public function count()
367		{
368		return $this->itemList->count();
369		}
370		}
371

jkphl / micrometa

Pull Request — master (#66)

Item::toObject() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like