Standard::process() - Code Metrics - Inspection of "Add Supplier Processor to CSV Import" - aimeos/ai-controller-jobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#25)

unknown

created 2020-06-27 02:55 UTC

Standard::process() B

↳ Parent: Standard

Complexity

Conditions	6
Paths	12

Size

Total Lines	50
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
cc	6
eloc	27
c	1
b	1
f	0
nc	12
nop	2
dl	0
loc	50
rs	8.8657

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2015-2020
 * @package Controller
 * @subpackage Common
 */


namespace Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Text;


/**
 * Text processor for CSV imports
 *
 * @package Controller
 * @subpackage Common
 */
class Standard
	extends \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Base
	implements \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface
{
	/** controller/common/supplier/import/csv/processor/text/name
	 * Name of the text processor implementation
	 *
	 * Use "Myname" if your class is named "\Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Text\Myname".
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
	 *
	 * @param string Last part of the processor class name
	 * @since 2020.07
	 * @category Developer
	 */

	private $listTypes;
	private $types;


	/**
	 * Initializes the object
	 *
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
	 * @param array $mapping Associative list of field position in CSV as key and domain item key as value
	 * @param \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface $object Decorated processor
	 */
	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $mapping,
		\Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface $object = null )
	{
		parent::__construct( $context, $mapping, $object );

		/** controller/common/supplier/import/csv/processor/text/listtypes
		 * Names of the supplier list types for texts that are updated or removed
		 *
		 * If you want to associate text items manually via the administration
		 * interface to suppliers and don't want these to be touched during the
		 * import, you can specify the supplier list types for these texts
		 * that shouldn't be updated or removed.
		 *
		 * @param array|null List of supplier list type names or null for all
		 * @since 2020.07
		 * @category Developer
		 * @category User
		 * @see controller/common/supplier/import/csv/domains
		 * @see controller/common/supplier/import/csv/processor/attribute/listtypes
		 * @see controller/common/supplier/import/csv/processor/supplier/listtypes
		 * @see controller/common/supplier/import/csv/processor/media/listtypes
		 * @see controller/common/supplier/import/csv/processor/price/listtypes
		 * @see controller/common/supplier/import/csv/processor/supplier/listtypes
		 */
		$key = 'controller/common/supplier/import/csv/processor/text/listtypes';
		$this->listTypes = $context->getConfig()->get( $key );

		if( $this->listTypes === null )
		{
			$this->listTypes = [];
			$manager = \Aimeos\MShop::create( $context, 'supplier/lists/type' );

			$search = $manager->createSearch()->setSlice( 0, 0x7fffffff );
			$search->setConditions( $search->compare( '==', 'supplier.lists.type.domain', 'text' ) );

			foreach( $manager->searchItems( $search ) as $item )
			{
				$this->listTypes[$item->getCode()] = $item->getCode();
			}
		} else
		{
			$this->listTypes = array_flip( $this->listTypes );
		}


		$manager = \Aimeos\MShop::create( $context, 'text/type' );

		$search = $manager->createSearch()->setSlice( 0, 0x7fffffff );
		$search->setConditions( $search->compare( '==', 'text.type.domain', 'supplier' ) );

		foreach( $manager->searchItems( $search ) as $item )
		{
			$this->types[$item->getCode()] = $item->getCode();
		}
	}


	/**
	 * Saves the supplier related data to the storage
	 *
	 * @param \Aimeos\MShop\Supplier\Item\Iface $supplier Supplier item with associated items
	 * @param array $data List of CSV fields with position as key and data as value
	 * @return array List of data which hasn't been imported
	 */
	public function process( \Aimeos\MShop\Supplier\Item\Iface $supplier, array $data ) : array
	{
		$listManager = \Aimeos\MShop::create( $this->getContext(), 'supplier/lists' );
		$manager = \Aimeos\MShop::create( $this->getContext(), 'text' );

		$listMap = [];
		$map = $this->getMappedChunk( $data, $this->getMapping() );
		$listItems = $supplier->getListItems( 'text', $this->listTypes );

		foreach( $listItems as $listItem )
		{
			if( ($refItem = $listItem->getRefItem()) !== null )
			{
				$listMap[$refItem->getContent()][$refItem->getType()][$listItem->getType()] = $listItem;
			}
		}

		foreach( $map as $pos => $list )
		{
			if( $this->checkEntry( $list ) === false )
			{
				continue;
			}

			$type = $this->getValue( $list, 'text.type', 'name' );
			$listtype = $this->getValue( $list, 'supplier.lists.type', 'default' );
			$content = $this->getValue( $list, 'text.content', '' );

			if( isset( $listMap[$content][$type][$listtype] ) )
			{
				$listItem = $listMap[$content][$type][$listtype];
				$refItem = $listItem->getRefItem();
				unset( $listItems[$listItem->getId()] );
			} else
			{
				$listItem = $listManager->createItem()->setType( $listtype );
				$refItem = $manager->createItem()->setType( $type );
			}

			$listItem = $listItem->setPosition( $pos )->fromArray( $list );

			$label = mb_strcut( $this->getValue( $list, 'text.content', '' ), 0, 255 );
			$refItem = $refItem->setLabel( $label )->fromArray( $list );

			$supplier->addListItem( 'text', $listItem, $refItem );
		}

		$supplier->deleteListItems( $listItems->toArray(), true );

		return $this->getObject()->process( $supplier, $data );
	}


	/**
	 * Checks if an entry can be used for updating a media item
	 *
	 * @param array $list Associative list of key/value pairs from the mapping
	 * @return bool True if valid, false if not
	 */
	protected function checkEntry( array $list ) : bool
	{
		if( $this->getValue( $list, 'text.content' ) === null )
		{
			return false;
		}

		if( ($type = $this->getValue( $list, 'supplier.lists.type' )) && !isset( $this->listTypes[$type] ) )
		{
			$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'supplier list' );
			throw new \Aimeos\Controller\Common\Exception( $msg );
		}

		if( ($type = $this->getValue( $list, 'text.type' )) && !isset( $this->types[$type] ) )
		{
			$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'text' );
			throw new \Aimeos\Controller\Common\Exception( $msg );
		}

		return true;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2015-2020
6			* @package Controller
7			* @subpackage Common
8			*/
9
10
11			namespace Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Text;
12
13
14			/**
15			* Text processor for CSV imports
16			*
17			* @package Controller
18			* @subpackage Common
19			*/
20			class Standard
21			extends \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Base
22			implements \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface
23			{
24			/** controller/common/supplier/import/csv/processor/text/name
25			* Name of the text processor implementation
26			*
27			* Use "Myname" if your class is named "\Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Text\Myname".
28			* The name is case-sensitive and you should avoid camel case names like "MyName".
29			*
30			* @param string Last part of the processor class name
31			* @since 2020.07
32			* @category Developer
33			*/
34
35			private $listTypes;
36			private $types;
37
38
39			/**
40			* Initializes the object
41			*
42			* @param \Aimeos\MShop\Context\Item\Iface $context Context object
43			* @param array $mapping Associative list of field position in CSV as key and domain item key as value
44			* @param \Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface $object Decorated processor
45			*/
46			public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $mapping,
47			\Aimeos\Controller\Common\Supplier\Import\Csv\Processor\Iface $object = null )
48			{
49			parent::__construct( $context, $mapping, $object );
50
51			/** controller/common/supplier/import/csv/processor/text/listtypes
52			* Names of the supplier list types for texts that are updated or removed
53			*
54			* If you want to associate text items manually via the administration
55			* interface to suppliers and don't want these to be touched during the
56			* import, you can specify the supplier list types for these texts
57			* that shouldn't be updated or removed.
58			*
59			* @param array\|null List of supplier list type names or null for all
60			* @since 2020.07
61			* @category Developer
62			* @category User
63			* @see controller/common/supplier/import/csv/domains
64			* @see controller/common/supplier/import/csv/processor/attribute/listtypes
65			* @see controller/common/supplier/import/csv/processor/supplier/listtypes
66			* @see controller/common/supplier/import/csv/processor/media/listtypes
67			* @see controller/common/supplier/import/csv/processor/price/listtypes
68			* @see controller/common/supplier/import/csv/processor/supplier/listtypes
69			*/
70			$key = 'controller/common/supplier/import/csv/processor/text/listtypes';
71			$this->listTypes = $context->getConfig()->get( $key );
72
73			if( $this->listTypes === null )
74			{
75			$this->listTypes = [];
76			$manager = \Aimeos\MShop::create( $context, 'supplier/lists/type' );
77
78			$search = $manager->createSearch()->setSlice( 0, 0x7fffffff );
79			$search->setConditions( $search->compare( '==', 'supplier.lists.type.domain', 'text' ) );
80
81			foreach( $manager->searchItems( $search ) as $item )
82			{
83			$this->listTypes[$item->getCode()] = $item->getCode();
84			}
85			} else
86			{
87			$this->listTypes = array_flip( $this->listTypes );
88			}
89
90
91			$manager = \Aimeos\MShop::create( $context, 'text/type' );
92
93			$search = $manager->createSearch()->setSlice( 0, 0x7fffffff );
94			$search->setConditions( $search->compare( '==', 'text.type.domain', 'supplier' ) );
95
96			foreach( $manager->searchItems( $search ) as $item )
97			{
98			$this->types[$item->getCode()] = $item->getCode();
99			}
100			}
101
102
103			/**
104			* Saves the supplier related data to the storage
105			*
106			* @param \Aimeos\MShop\Supplier\Item\Iface $supplier Supplier item with associated items
107			* @param array $data List of CSV fields with position as key and data as value
108			* @return array List of data which hasn't been imported
109			*/
110			public function process( \Aimeos\MShop\Supplier\Item\Iface $supplier, array $data ) : array
111			{
112			$listManager = \Aimeos\MShop::create( $this->getContext(), 'supplier/lists' );
113			$manager = \Aimeos\MShop::create( $this->getContext(), 'text' );
114
115			$listMap = [];
116			$map = $this->getMappedChunk( $data, $this->getMapping() );
117			$listItems = $supplier->getListItems( 'text', $this->listTypes );
118
119			foreach( $listItems as $listItem )
120			{
121			if( ($refItem = $listItem->getRefItem()) !== null )
122			{
123			$listMap[$refItem->getContent()][$refItem->getType()][$listItem->getType()] = $listItem;
124			}
125			}
126
127			foreach( $map as $pos => $list )
128			{
129			if( $this->checkEntry( $list ) === false )
130			{
131			continue;
132			}
133
134			$type = $this->getValue( $list, 'text.type', 'name' );
135			$listtype = $this->getValue( $list, 'supplier.lists.type', 'default' );
136			$content = $this->getValue( $list, 'text.content', '' );
137
138			if( isset( $listMap[$content][$type][$listtype] ) )
139			{
140			$listItem = $listMap[$content][$type][$listtype];
141			$refItem = $listItem->getRefItem();
142			unset( $listItems[$listItem->getId()] );
143			} else
144			{
145			$listItem = $listManager->createItem()->setType( $listtype );
146			$refItem = $manager->createItem()->setType( $type );
147			}
148
149			$listItem = $listItem->setPosition( $pos )->fromArray( $list );
150
151			$label = mb_strcut( $this->getValue( $list, 'text.content', '' ), 0, 255 );
152			$refItem = $refItem->setLabel( $label )->fromArray( $list );
153
154			$supplier->addListItem( 'text', $listItem, $refItem );
155			}
156
157			$supplier->deleteListItems( $listItems->toArray(), true );
158
159			return $this->getObject()->process( $supplier, $data );
160			}
161
162
163			/**
164			* Checks if an entry can be used for updating a media item
165			*
166			* @param array $list Associative list of key/value pairs from the mapping
167			* @return bool True if valid, false if not
168			*/
169			protected function checkEntry( array $list ) : bool
170			{
171			if( $this->getValue( $list, 'text.content' ) === null )
172			{
173			return false;
174			}
175
176			if( ($type = $this->getValue( $list, 'supplier.lists.type' )) && !isset( $this->listTypes[$type] ) )
177			{
178			$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'supplier list' );
179			throw new \Aimeos\Controller\Common\Exception( $msg );
180			}
181
182			if( ($type = $this->getValue( $list, 'text.type' )) && !isset( $this->types[$type] ) )
183			{
184			$msg = sprintf( 'Invalid type "%1$s" (%2$s)', $type, 'text' );
185			throw new \Aimeos\Controller\Common\Exception( $msg );
186			}
187
188			return true;
189			}
190			}
191

aimeos / ai-controller-jobs

Pull Request — master (#25)

Standard::process() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like