ItemList::__call() - Code Metrics - Inspection of "Merge pull request #66 from rvanlaak/item-interfac..." - jkphl/micrometa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 513b92...79c3ce )

by Richard van

created 2021-06-22 14:24 UTC

ItemList::__call() A

↳ Parent: Project

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	9
cts	9
cp	1
rs	9.6666
c	0
b	0
f	0
cc	4
nc	3
nop	2
crap	4

<?php

/**
 * micrometa
 *
 * @category   Jkphl
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports\Item
 * @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\Ports\Exceptions\OutOfBoundsException;
use Jkphl\Micrometa\Ports\Exceptions\RuntimeException;

/**
 * Item list
 *
 * @package    Jkphl\Micrometa
 * @subpackage Jkphl\Micrometa\Ports
 */
class ItemList extends Collection implements ItemListInterface
{
    /**
     * Items
     *
     * @var ItemInterface[]
     */
    protected $items;

    /**
     * Internal pointer
     *
     * @var int
     */
    protected $pointer;

    /**
     * ItemList constructor
     *
     * @param ItemInterface[] $items Items
     *
     * @api
     */
    public function __construct(array $items = [])
    {
        $this->items   = array_values($items);
        $this->pointer = 0;
    }

    /**
     * Return the current item
     *
     * @return ItemInterface Item
     * @api
     */
    public function current()
    {
        return $this->items[$this->pointer];
    }

    /**
     * Move forward to next element
     *
     * @return void
     * @api
     */
    public function next()
    {
        ++$this->pointer;
    }

    /**
     * Return the position of the current element
     *
     * @return int Position of the current element
     * @api
     */
    public function key()
    {
        return $this->pointer;
    }

    /**
     * Checks if current position is valid
     *
     * @return boolean The current position is valid
     * @api
     */
    public function valid()
    {
        return isset($this->items[$this->pointer]);
    }

    /**
     * Rewind the item list to the first element
     *
     * @return void
     * @api
     */
    public function rewind()
    {
        $this->pointer = 0;
    }

    /**
     * Test if an offset exists
     *
     * @param int $offset Offset
     *
     * @return boolean Offset exists
     * @api
     */
    public function offsetExists($offset)
    {
        return isset($this->items[$offset]);
    }

    /**
     * Return the item at a particular offset
     *
     * @param int $offset Offset
     *
     * @return ItemInterface Item
     * @api
     */
    public function offsetGet($offset)
    {
        return $this->items[$offset];
    }

    /**
     * Set an item at a particular offset
     *
     * @param int $offset          Offset
     * @param ItemInterface $value Item
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     *
     * @api
     */
    public function offsetSet($offset, $value)
    {
        throw new RuntimeException(RuntimeException::IMMUTABLE_ITEM_LIST_STR, RuntimeException::IMMUTABLE_ITEM_LIST);
    }

    /**
     * Delete an item at a particular offset
     *
     * @param int $offset Offset
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function offsetUnset($offset)
    {
        throw new RuntimeException(RuntimeException::IMMUTABLE_ITEM_LIST_STR, RuntimeException::IMMUTABLE_ITEM_LIST);
    }

    /**
     * Return an object representation of the item list
     *
     * @return \stdClass Micro information items
     */
    public function toObject()
    {
        return (object)[
            'items' => array_map(
                function (ItemInterface $item) {
                    return $item->toObject();
                },
                $this->items
            )
        ];
    }

    /**
     * Return the first item, optionally of particular types
     *
     * @param array ...$types Item types
     *
     * @return ItemInterface Item
     * @throws OutOfBoundsException If there are no matching items
     * @api
     */
    public function getFirstItem(...$types)
    {
        $items = $this->getItems(...$types);

        // If there are no matching items
        if (!count($items)) {
            throw new OutOfBoundsException(
                OutOfBoundsException::NO_MATCHING_ITEMS_STR,
                OutOfBoundsException::NO_MATCHING_ITEMS
            );
        }

        return $items[0];
    }

    /**
     * Return all items as an array, optionally filtered by item type(s)
     *
     * @param array ...$types Item types
     *
     * @return ItemInterface[] Items matching the requested types
     * @api
     */
    public function getItems(...$types)
    {
        // If particular item types should be filtered
        if (count($types)) {
            return array_filter(
                $this->items,
                function (ItemInterface $item) use ($types) {
                    return $item->isOfType(...$types);
                }
            );
        }

        return $this->items;
    }

    /**
     * Return the number of items in this list
     *
     * @return int Number of items
     * @api
     */
    public function count()
    {
        return count($this->items);
    }
}


1		<?php
2
3		/**
4		* micrometa
5		*
6		* @category Jkphl
7		* @package Jkphl\Micrometa
8		* @subpackage Jkphl\Micrometa\Ports\Item
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\Ports\Exceptions\OutOfBoundsException;
40		use Jkphl\Micrometa\Ports\Exceptions\RuntimeException;
41
42		/**
43		* Item list
44		*
45		* @package Jkphl\Micrometa
46		* @subpackage Jkphl\Micrometa\Ports
47		*/
48		class ItemList extends Collection implements ItemListInterface
49		{
50		/**
51		* Items
52		*
53		* @var ItemInterface[]
54		*/
55		protected $items;
56
57		/**
58		* Internal pointer
59		*
60		* @var int
61		*/
62		protected $pointer;
63
64		/**
65		* ItemList constructor
66		*
67		* @param ItemInterface[] $items Items
68		*
69		* @api
70		*/
71	22	public function __construct(array $items = [])
72		{
73	22	$this->items = array_values($items);
74	22	$this->pointer = 0;
75	22	}
76
77		/**
78		* Return the current item
79		*
80		* @return ItemInterface Item
81		* @api
82		*/
83	1	public function current()
84		{
85	1	return $this->items[$this->pointer];
86		}
87
88		/**
89		* Move forward to next element
90		*
91		* @return void
92		* @api
93		*/
94	1	public function next()
95		{
96	1	++$this->pointer;
97	1	}
98
99		/**
100		* Return the position of the current element
101		*
102		* @return int Position of the current element
103		* @api
104		*/
105		public function key()
106		{
107		return $this->pointer;
108		}
109
110		/**
111		* Checks if current position is valid
112		*
113		* @return boolean The current position is valid
114		* @api
115		*/
116	1	public function valid()
117		{
118	1	return isset($this->items[$this->pointer]);
119		}
120
121		/**
122		* Rewind the item list to the first element
123		*
124		* @return void
125		* @api
126		*/
127	1	public function rewind()
128		{
129	1	$this->pointer = 0;
130	1	}
131
132		/**
133		* Test if an offset exists
134		*
135		* @param int $offset Offset
136		*
137		* @return boolean Offset exists
138		* @api
139		*/
140		public function offsetExists($offset)
141		{
142		return isset($this->items[$offset]);
143		}
144
145		/**
146		* Return the item at a particular offset
147		*
148		* @param int $offset Offset
149		*
150		* @return ItemInterface Item
151		* @api
152		*/
153	5	public function offsetGet($offset)
154		{
155	5	return $this->items[$offset];
156		}
157
158		/**
159		* Set an item at a particular offset
160		*
161		* @param int $offset Offset
162		* @param ItemInterface $value Item
163		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
164		*
165		* @api
166		*/
167	1	public function offsetSet($offset, $value)
168		{
169	1	throw new RuntimeException(RuntimeException::IMMUTABLE_ITEM_LIST_STR, RuntimeException::IMMUTABLE_ITEM_LIST);
170		}
171
172		/**
173		* Delete an item at a particular offset
174		*
175		* @param int $offset Offset
176		* @SuppressWarnings(PHPMD.UnusedFormalParameter)
177		*/
178	1	public function offsetUnset($offset)
179		{
180	1	throw new RuntimeException(RuntimeException::IMMUTABLE_ITEM_LIST_STR, RuntimeException::IMMUTABLE_ITEM_LIST);
181		}
182
183		/**
184		* Return an object representation of the item list
185		*
186		* @return \stdClass Micro information items
187		*/
188	1	public function toObject()
189		{
190		return (object)[
191	1	'items' => array_map(
192		function (ItemInterface $item) {
193	1	return $item->toObject();
194	1	},
195	1	$this->items
196		)
197		];
198		}
199
200		/**
201		* Return the first item, optionally of particular types
202		*
203		* @param array ...$types Item types
204		*
205		* @return ItemInterface Item
206		* @throws OutOfBoundsException If there are no matching items
207		* @api
208		*/
209	5	public function getFirstItem(...$types)
210		{
211	5	$items = $this->getItems(...$types);
212
213		// If there are no matching items
214	5	if (!count($items)) {
215	1	throw new OutOfBoundsException(
216	1	OutOfBoundsException::NO_MATCHING_ITEMS_STR,
217	1	OutOfBoundsException::NO_MATCHING_ITEMS
218		);
219		}
220
221	4	return $items[0];
222		}
223
224		/**
225		* Return all items as an array, optionally filtered by item type(s)
226		*
227		* @param array ...$types Item types
228		*
229		* @return ItemInterface[] Items matching the requested types
230		* @api
231		*/
232	12	public function getItems(...$types)
233		{
234		// If particular item types should be filtered
235	12	if (count($types)) {
236	8	return array_filter(
237	8	$this->items,
238		function (ItemInterface $item) use ($types) {
239	8	return $item->isOfType(...$types);
240	8	}
241		);
242		}
243
244	8	return $this->items;
245		}
246
247		/**
248		* Return the number of items in this list
249		*
250		* @return int Number of items
251		* @api
252		*/
253	3	public function count()
254		{
255	3	return count($this->items);
256		}
257		}
258

jkphl / micrometa

Push — master ( 513b92...79c3ce )

ItemList::__call() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like