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

Completed

Push — v2 ( b41681...2062ad )

by Joschi

created 2017-05-28 11:50 UTC

Item::getProperty() A

↳ Parent: Item

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

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

<?php

/**
 * micrometa
 *
 * @category Jkphl
 * @package Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 * @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\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 extends ItemList implements ItemInterface
{
    /**
     * Application item
     *
     * @var ApplicationItemInterface
     */
    protected $item;

    /**
     * Item constructor
     *
     * @param ApplicationItemInterface $item Application item
     */
    public function __construct(ApplicationItemInterface $item)
    {
        $this->item = $item;
        parent::__construct(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 $e) {
            throw new OutOfBoundsException($e->getMessage(), $e->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 string $name Name
     * @param string $profile Profile
     * @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($name, $profile = null)
    {
        /** @var ProfiledNamesList $properties */
        $properties = ProfiledNamesFactory::createFromArguments(func_get_args());

        // Prepare a default exception
        $e = 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 $e) {
                continue;
            }
        }

        throw $e;
    }

    /**
     * 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
     */
    public function getType()
    {
        return $this->item->getType();
    }

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

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

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

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


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 © 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\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 extends ItemList implements ItemInterface
59		{
60		/**
61		* Application item
62		*
63		* @var ApplicationItemInterface
64		*/
65		protected $item;
66
67		/**
68		* Item constructor
69		*
70		* @param ApplicationItemInterface $item Application item
71		*/
72	14	public function __construct(ApplicationItemInterface $item)
73		{
74	14	$this->item = $item;
75	14	parent::__construct(ItemFactory::createFromApplicationItems($this->item->getChildren()));
76	14	}
77
78		/**
79		* Get the first value of an item property
80		*
81		* @param string $name Item property name
82		* @return ValueInterface\|ValueInterface[]\|array\|ItemInterface First value of an item property
83		* @api
84		*/
85	2	public function __get($name)
86		{
87	2	return $this->getProperty($name, null, 0);
88		}
89
90		/**
91		* Get a single property (value)
92		*
93		* @param string\|\stdClass\|Iri $name Property name
94		* @param string $profile Property profile
95		* @param int\|null $index Property value index
96		* @return ValueInterface\|ValueInterface[]\|array\|ItemInterface Property value(s)
97		* @throws OutOfBoundsException If the property name is unknown
98		* @throws OutOfBoundsException If the property value index is out of bounds
99		* @api
100		*/
101	7	public function getProperty($name, $profile = null, $index = null)
102		{
103		try {
104	7	$propertyValues = $this->item->getProperty($name, $profile);
105	4	} catch (DomainOutOfBoundsException $e) {
106	4	throw new OutOfBoundsException($e->getMessage(), $e->getCode());
107		}
108
109		// Return the value(s)
110	7	return ($index === null) ?
111	7	array_map([$this, 'getPropertyValue'], $propertyValues) : $this->getPropertyIndex($propertyValues, $index);
112		}
113
114		/**
115		* Return a particular property index
116		*
117		* @param ValueInterface[] $propertyValues Property values
118		* @param int $index Property value index
119		* @return ValueInterface\|ItemInterface
120		*/
121	6	protected function getPropertyIndex(array $propertyValues, $index)
122		{
123		// If the property value index is out of bounds
124	6	if (!isset($propertyValues[$index])) {
125	1	throw new OutOfBoundsException(
126	1	sprintf(OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX_STR, $index),
127	1	OutOfBoundsException::INVALID_PROPERTY_VALUE_INDEX
128		);
129		}
130
131	5	return $this->getPropertyValue($propertyValues[$index]);
132		}
133
134		/**
135		* Prepare a property value for returning it
136		*
137		* @param ValueInterface $value Property value
138		* @return ValueInterface\|ItemInterface Returnable property value
139		*/
140	7	protected function getPropertyValue(ValueInterface $value)
141		{
142	7	return ($value instanceof ApplicationItemInterface) ?
143	7	ItemFactory::createFromApplicationItem($value) : $value;
144		}
145
146		/**
147		* Return whether the item is of a particular type (or contained in a list of types)
148		*
149		* The item type(s) can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
150		*
151		* @param array ...$types Item types
152		* @return boolean Item type is contained in the list of types
153		* @api
154		*/
155	5	public function isOfType(...$types)
156		{
157		/** @var ProfiledNamesList $profiledTypes */
158	5	$profiledTypes = ProfiledNamesFactory::createFromArguments($types);
159	5	$aliasFactory = new AliasFactory();
160
161		// Run through all item types
162		/** @var \stdClass $itemType */
163	5	foreach ($this->item->getType() as $itemType) {
164	5	$itemTypeNames = $aliasFactory->createAliases($itemType->name);
165	5	if ($this->isOfProfiledTypes($itemType->profile, $itemTypeNames, $profiledTypes)) {
166	5	return true;
167		}
168		}
169
170	3	return false;
171		}
172
173		/**
174		* Return whether an aliased item type is contained in a set of query types
175		*
176		* @param string $profile Type profile
177		* @param array $names Aliased type names
178		* @param ProfiledNamesList $types Query types
179		* @return bool Item type is contained in the set of query types
180		*/
181	5	protected function isOfProfiledTypes($profile, array $names, ProfiledNamesList $types)
182		{
183		// Run through all query types
184		/** @var \stdClass $queryType */
185	5	foreach ($types as $queryType) {
186	5	if ($this->isTypeInNames($queryType, $profile, $names)) {
187	5	return true;
188		}
189		}
190	3	return false;
191		}
192
193		/**
194		* Test whether a type is contained in a list of names
195		*
196		* @param \stdClass $type Type
197		* @param string $profile Type profile
198		* @param array $names Aliased type names
199		* @return bool Type is contained in names list
200		*/
201	5	protected function isTypeInNames($type, $profile, array $names)
202		{
203	5	return in_array($type->name, $names) &&
204	5	(($type->profile === null) ? true : ($type->profile == $profile));
205		}
206
207		/**
208		* Get all values of the first available property in a stack
209		*
210		* The property stack can be specified in a variety of ways, @see ProfiledNamesFactory::createFromArguments()
211		*
212		* @param string $name Name
213		* @param string $profile Profile
214		* @return ValueInterface[]\|array Property values
215		* @throws InvalidArgumentException If no property name was given
216		* @throws OutOfBoundsException If none of the requested properties is known
217		* @api
218		*/
219	2	public function getFirstProperty($name, $profile = null)
220		{
221		/** @var ProfiledNamesList $properties */
222	2	$properties = ProfiledNamesFactory::createFromArguments(func_get_args());
223
224		// Prepare a default exception
225	2	$e = new OutOfBoundsException(
226	2	OutOfBoundsException::NO_MATCHING_PROPERTIES_STR,
227	2	OutOfBoundsException::NO_MATCHING_PROPERTIES
228		);
229
230		// Run through all properties
231	2	foreach ($properties as $property) {
232		try {
233	2	return (array)$this->getProperty($property->name, $property->profile);
234	1	} catch (OutOfBoundsException $e) {
235	1	continue;
236		}
237		}
238
239	1	throw $e;
240		}
241
242		/**
243		* Return all properties
244		*
245		* @return PropertyListInterface Properties
246		* @api
247		*/
248	1	public function getProperties()
249		{
250	1	$propertyList = (new PropertyListFactory())->create();
251	1	foreach ($this->item->getProperties() as $propertyName => $propertyValues) {
252	1	$propertyList[$propertyName] = array_map([$this, 'getPropertyValue'], $propertyValues);
253		}
254	1	return $propertyList;
255		}
256
257		/**
258		* Return an object representation of the item
259		*
260		* @return \stdClass Micro information item
261		* @api
262		*/
263	2	public function toObject()
264		{
265	2	return $this->item->export();
266		}
267
268		/**
269		* Get the item type
270		*
271		* @return \stdClass[] Item type
272		*/
273	1	public function getType()
274		{
275	1	return $this->item->getType();
276		}
277
278		/**
279		* Get the item format
280		*
281		* @return int Item format
282		*/
283	1	public function getFormat()
284		{
285	1	return $this->item->getFormat();
286		}
287
288		/**
289		* Get the item ID
290		*
291		* @return string Item ID
292		*/
293	1	public function getId()
294		{
295	1	return $this->item->getId();
296		}
297
298		/**
299		* Get the item language
300		*
301		* @return string Item language
302		*/
303	1	public function getLanguage()
304		{
305	1	return $this->item->getLanguage();
306		}
307
308		/**
309		* Return the item value
310		*
311		* @return string Item value
312		*/
313	1	public function getValue()
314		{
315	1	return $this->item->getValue();
316		}
317		}
318

jkphl / micrometa

Push — v2 ( b41681...2062ad )

Item::getProperty() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like