Standard::map() - Code Metrics - Inspection of "Include suppliers and product relationships if req..." - aimeos/ai-client-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ddab28...1b9cd9 )

by Aimeos

created 2021-09-03 10:23 UTC

Standard::map() D

↳ Parent: Standard

Complexity

Conditions	24
Paths	65

Size

Total Lines	108
Code Lines	55

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	55
c	1
b	0
f	0
dl	0
loc	108
rs	4.1666
cc	24
nc	65
nop	3

How to fix Long Method Complexity

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2019-2021
 * @package MW
 * @subpackage View
 */


namespace Aimeos\MW\View\Helper\Jincluded;


/**
 * View helper class for generating "included" data used by JSON:API
 *
 * @package MW
 * @subpackage View
 */
class Standard extends \Aimeos\MW\View\Helper\Base implements Iface
{
	private $map;


	/**
	 * Returns the included data for the JSON:API response
	 *
	 * @param \Aimeos\MShop\Common\Item\Iface|\Aimeos\MShop\Common\Item\Iface[] $item Object or objects to generate the included data for
	 * @param array $fields Associative list of resource types as keys and field names to output as values
	 * @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
	 * @return array List of entries to include in the JSON:API response
	 */
	public function transform( $item, array $fields, array $fcn = [] )
	{
		$this->map = [];

		if( is_map( $item ) || is_array( $item ) )
		{
			foreach( $item as $entry ) {
				$this->entry( $entry, $fields, $fcn );
			}
		}
		else
		{
			$this->entry( $item, $fields, $fcn );
		}

		return $this->map;
	}


	/**
	 * Processes a single item to create the included data for the JSON:API response
	 *
	 * @param \Aimeos\MShop\Common\Item\Iface $item Object to generate the included data for
	 * @param array $fields Associative list of resource types as keys and field names to output as values
	 * @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
	 */
	protected function entry( \Aimeos\MShop\Common\Item\Iface $item, array $fields, array $fcn = [] )
	{
		if( $item instanceof \Aimeos\MShop\Common\Item\Tree\Iface )
		{
			foreach( $item->getChildren() as $catItem )
			{
				if( $catItem->isAvailable() ) {
					$this->map( $catItem, $fields, $fcn );
				}
			}
		}

		if( $item instanceof \Aimeos\MShop\Common\Item\AddressRef\Iface )
		{
			foreach( $item->getAddressItems() as $addrItem ) {
				$this->map( $addrItem, $fields, $fcn );
			}
		}

		if( $item instanceof \Aimeos\MShop\Common\Item\ListsRef\Iface )
		{
			foreach( $item->getListItems() as $listItem )
			{
				if( $refItem = $listItem->getRefItem() ) {
					$this->map( $refItem, $fields, $fcn );
				}
			}
		}

		if( $item instanceof \Aimeos\MShop\Common\Item\PropertyRef\Iface )
		{
			foreach( $item->getPropertyItems() as $propItem ) {
				$this->map( $propItem, $fields, $fcn );
			}
		}

		if( $item instanceof \Aimeos\MShop\Product\Item\Iface )
		{
			foreach( $item->getCatalogItems() as $catItem ) {
				$this->map( $catItem, $fields, $fcn );
			}

			foreach( $item->getSupplierItems() as $supItem ) {
				$this->map( $supItem, $fields, $fcn );
			}

			foreach( $item->getStockItems() as $stockItem ) {
				$this->map( $stockItem, $fields, $fcn );
			}
		}
	}


	/**
	 * Populates the map class property with the included data for the JSON:API response
	 *
	 * @param \Aimeos\MShop\Common\Item\Iface $item Object to generate the included data for
	 * @param array $fields Associative list of resource types as keys and field names to output as values
	 * @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
	 */
	protected function map( \Aimeos\MShop\Common\Item\Iface $item, array $fields, array $fcn = [] )
	{
		$id = $item->getId();
		$type = $item->getResourceType();

		if( isset( $this->map[$type][$id] ) || !$item->isAvailable() ) {
			return;
		}

		$attributes = $item->toArray();

		if( isset( $fields[$type] ) ) {
			$attributes = array_intersect_key( $attributes, $fields[$type] );
		}

		$entry = ['id' => $id, 'type' => $type, 'attributes' => $attributes];

		if( isset( $fcn[$type] ) && $fcn[$type] instanceof \Closure ) {
			$entry = $fcn[$type]( $item, $entry );
		}

		$this->map[$type][$id] = $entry; // first content, avoid infinite loops

		if( $item instanceof \Aimeos\MShop\Common\Item\Tree\Iface )
		{
			foreach( $item->getChildren() as $childItem )
			{
				if( $childItem->isAvailable() )
				{
					$rtype = $childItem->getResourceType();
					$entry['relationships'][$rtype]['data'][] = ['id' => $childItem->getId(), 'type' => $rtype];
					$this->map( $childItem, $fields, $fcn );
				}
			}
		}

		if( $item instanceof \Aimeos\MShop\Common\Item\ListsRef\Iface )
		{
			foreach( $item->getListItems() as $listItem )
			{
				if( ( $refItem = $listItem->getRefItem() ) !== null && $refItem->isAvailable() )
				{
					$ltype = $listItem->getResourceType();
					$rtype = $refItem->getResourceType();
					$attributes = $listItem->toArray();

					if( isset( $fields[$ltype] ) ) {
						$attributes = array_intersect_key( $attributes, $fields[$ltype] );
					}

					$data = ['id' => $refItem->getId(), 'type' => $rtype, 'attributes' => $attributes];
					$entry['relationships'][$rtype]['data'][] = $data;
					$this->map( $refItem, $fields, $fcn );
				}
			}
		}

		if( $item instanceof \Aimeos\MShop\Common\Item\PropertyRef\Iface )
		{
			foreach( $item->getPropertyItems() as $propItem )
			{
				if( $propItem->isAvailable() )
				{
					$propId = $propItem->getId();
					$rtype = $propItem->getResourceType();
					$entry['relationships'][$rtype]['data'][] = ['id' => $propId, 'type' => $rtype];
					$this->map( $propItem, $fields, $fcn );
				}
			}
		}

		if( $item instanceof \Aimeos\MShop\Product\Item\Iface )
		{
			foreach( $item->getCatalogItems() as $catItem )
			{
				if( $catItem->isAvailable() )
				{
					$catId = $catItem->getId();
					$rtype = $catItem->getResourceType();
					$entry['relationships'][$rtype]['data'][] = ['id' => $catId, 'type' => $rtype];
					$this->map( $catItem, $fields, $fcn );
				}
			}

			foreach( $item->getSupplierItems() as $supItem )
			{
				if( $supItem->isAvailable() )
				{
					$supId = $supItem->getId();
					$rtype = $supItem->getResourceType();
					$entry['relationships'][$rtype]['data'][] = ['id' => $supId, 'type' => $rtype];
					$this->map( $supItem, $fields, $fcn );
				}
			}

			foreach( $item->getStockItems() as $stockItem )
			{
				if( $stockItem->isAvailable() )
				{
					$stockId = $stockItem->getId();
					$rtype = $stockItem->getResourceType();
					$entry['relationships'][$rtype]['data'][] = ['id' => $stockId, 'type' => $rtype];
					$this->map( $stockItem, $fields, $fcn );
				}
			}
		}

		$this->map[$type][$id] = $entry; // full content
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2019-2021
6			* @package MW
7			* @subpackage View
8			*/
9
10
11			namespace Aimeos\MW\View\Helper\Jincluded;
12
13
14			/**
15			* View helper class for generating "included" data used by JSON:API
16			*
17			* @package MW
18			* @subpackage View
19			*/
20			class Standard extends \Aimeos\MW\View\Helper\Base implements Iface
21			{
22			private $map;
23
24
25			/**
26			* Returns the included data for the JSON:API response
27			*
28			* @param \Aimeos\MShop\Common\Item\Iface\|\Aimeos\MShop\Common\Item\Iface[] $item Object or objects to generate the included data for
29			* @param array $fields Associative list of resource types as keys and field names to output as values
30			* @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
31			* @return array List of entries to include in the JSON:API response
32			*/
33			public function transform( $item, array $fields, array $fcn = [] )
34			{
35			$this->map = [];
36
37			if( is_map( $item ) \|\| is_array( $item ) )
38			{
39			foreach( $item as $entry ) {
40			$this->entry( $entry, $fields, $fcn );
41			}
42			}
43			else
44			{
45			$this->entry( $item, $fields, $fcn );
46			}
47
48			return $this->map;
49			}
50
51
52			/**
53			* Processes a single item to create the included data for the JSON:API response
54			*
55			* @param \Aimeos\MShop\Common\Item\Iface $item Object to generate the included data for
56			* @param array $fields Associative list of resource types as keys and field names to output as values
57			* @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
58			*/
59			protected function entry( \Aimeos\MShop\Common\Item\Iface $item, array $fields, array $fcn = [] )
60			{
61			if( $item instanceof \Aimeos\MShop\Common\Item\Tree\Iface )
62			{
63			foreach( $item->getChildren() as $catItem )
64			{
65			if( $catItem->isAvailable() ) {
66			$this->map( $catItem, $fields, $fcn );
67			}
68			}
69			}
70
71			if( $item instanceof \Aimeos\MShop\Common\Item\AddressRef\Iface )
72			{
73			foreach( $item->getAddressItems() as $addrItem ) {
74			$this->map( $addrItem, $fields, $fcn );
75			}
76			}
77
78			if( $item instanceof \Aimeos\MShop\Common\Item\ListsRef\Iface )
79			{
80			foreach( $item->getListItems() as $listItem )
81			{
82			if( $refItem = $listItem->getRefItem() ) {
83			$this->map( $refItem, $fields, $fcn );
84			}
85			}
86			}
87
88			if( $item instanceof \Aimeos\MShop\Common\Item\PropertyRef\Iface )
89			{
90			foreach( $item->getPropertyItems() as $propItem ) {
91			$this->map( $propItem, $fields, $fcn );
92			}
93			}
94
95			if( $item instanceof \Aimeos\MShop\Product\Item\Iface )
96			{
97			foreach( $item->getCatalogItems() as $catItem ) {
98			$this->map( $catItem, $fields, $fcn );
99			}
100
101			foreach( $item->getSupplierItems() as $supItem ) {
102			$this->map( $supItem, $fields, $fcn );
103			}
104
105			foreach( $item->getStockItems() as $stockItem ) {
106			$this->map( $stockItem, $fields, $fcn );
107			}
108			}
109			}
110
111
112			/**
113			* Populates the map class property with the included data for the JSON:API response
114			*
115			* @param \Aimeos\MShop\Common\Item\Iface $item Object to generate the included data for
116			* @param array $fields Associative list of resource types as keys and field names to output as values
117			* @param array $fcn Associative list of resource types as keys and anonymous functions for generating the array entries as values
118			*/
119			protected function map( \Aimeos\MShop\Common\Item\Iface $item, array $fields, array $fcn = [] )
120			{
121			$id = $item->getId();
122			$type = $item->getResourceType();
123
124			if( isset( $this->map[$type][$id] ) \|\| !$item->isAvailable() ) {
125			return;
126			}
127
128			$attributes = $item->toArray();
129
130			if( isset( $fields[$type] ) ) {
131			$attributes = array_intersect_key( $attributes, $fields[$type] );
132			}
133
134			$entry = ['id' => $id, 'type' => $type, 'attributes' => $attributes];
135
136			if( isset( $fcn[$type] ) && $fcn[$type] instanceof \Closure ) {
137			$entry = $fcn[$type]( $item, $entry );
138			}
139
140			$this->map[$type][$id] = $entry; // first content, avoid infinite loops
141
142			if( $item instanceof \Aimeos\MShop\Common\Item\Tree\Iface )
143			{
144			foreach( $item->getChildren() as $childItem )
145			{
146			if( $childItem->isAvailable() )
147			{
148			$rtype = $childItem->getResourceType();
149			$entry['relationships'][$rtype]['data'][] = ['id' => $childItem->getId(), 'type' => $rtype];
150			$this->map( $childItem, $fields, $fcn );
151			}
152			}
153			}
154
155			if( $item instanceof \Aimeos\MShop\Common\Item\ListsRef\Iface )
156			{
157			foreach( $item->getListItems() as $listItem )
158			{
159			if( ( $refItem = $listItem->getRefItem() ) !== null && $refItem->isAvailable() )
160			{
161			$ltype = $listItem->getResourceType();
162			$rtype = $refItem->getResourceType();
163			$attributes = $listItem->toArray();
164
165			if( isset( $fields[$ltype] ) ) {
166			$attributes = array_intersect_key( $attributes, $fields[$ltype] );
167			}
168
169			$data = ['id' => $refItem->getId(), 'type' => $rtype, 'attributes' => $attributes];
170			$entry['relationships'][$rtype]['data'][] = $data;
171			$this->map( $refItem, $fields, $fcn );
172			}
173			}
174			}
175
176			if( $item instanceof \Aimeos\MShop\Common\Item\PropertyRef\Iface )
177			{
178			foreach( $item->getPropertyItems() as $propItem )
179			{
180			if( $propItem->isAvailable() )
181			{
182			$propId = $propItem->getId();
183			$rtype = $propItem->getResourceType();
184			$entry['relationships'][$rtype]['data'][] = ['id' => $propId, 'type' => $rtype];
185			$this->map( $propItem, $fields, $fcn );
186			}
187			}
188			}
189
190			if( $item instanceof \Aimeos\MShop\Product\Item\Iface )
191			{
192			foreach( $item->getCatalogItems() as $catItem )
193			{
194			if( $catItem->isAvailable() )
195			{
196			$catId = $catItem->getId();
197			$rtype = $catItem->getResourceType();
198			$entry['relationships'][$rtype]['data'][] = ['id' => $catId, 'type' => $rtype];
199			$this->map( $catItem, $fields, $fcn );
200			}
201			}
202
203			foreach( $item->getSupplierItems() as $supItem )
204			{
205			if( $supItem->isAvailable() )
206			{
207			$supId = $supItem->getId();
208			$rtype = $supItem->getResourceType();
209			$entry['relationships'][$rtype]['data'][] = ['id' => $supId, 'type' => $rtype];
210			$this->map( $supItem, $fields, $fcn );
211			}
212			}
213
214			foreach( $item->getStockItems() as $stockItem )
215			{
216			if( $stockItem->isAvailable() )
217			{
218			$stockId = $stockItem->getId();
219			$rtype = $stockItem->getResourceType();
220			$entry['relationships'][$rtype]['data'][] = ['id' => $stockId, 'type' => $rtype];
221			$this->map( $stockItem, $fields, $fcn );
222			}
223			}
224			}
225
226			$this->map[$type][$id] = $entry; // full content
227			}
228			}
229

aimeos / ai-client-jsonapi

Push — master ( ddab28...1b9cd9 )

Standard::map() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like