Standard::slice() - Code Metrics - Inspection of "Added update() method to order controller" - aimeos/ai-controller-frontend - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 40eed1...d6e4b0 )

by Aimeos

created 2023-12-07 09:29 UTC

Standard::slice() A

↳ Parent: Standard

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
c	0
b	0
f	0
dl	0
loc	5
rs	10
cc	1
nc	1
nop	2

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2014
 * @copyright Aimeos (aimeos.org), 2015-2023
 * @package Controller
 * @subpackage Frontend
 */


namespace Aimeos\Controller\Frontend\Order;


/**
 * Default implementation of the order frontend controller.
 *
 * @package Controller
 * @subpackage Frontend
 */
class Standard
	extends \Aimeos\Controller\Frontend\Base
	implements Iface, \Aimeos\Controller\Frontend\Common\Iface
{
	/** controller/frontend/order/name
	 * Class name of the used order frontend controller implementation
	 *
	 * Each default frontend controller can be replace by an alternative imlementation.
	 * To use this implementation, you have to set the last part of the class
	 * name as configuration value so the controller factory knows which class it
	 * has to instantiate.
	 *
	 * For example, if the name of the default class is
	 *
	 *  \Aimeos\Controller\Frontend\Order\Standard
	 *
	 * and you want to replace it with your own version named
	 *
	 *  \Aimeos\Controller\Frontend\Order\Myorder
	 *
	 * then you have to set the this configuration option:
	 *
	 *  controller/frontend/order/name = Myorder
	 *
	 * The value is the last part of your own class name and it's case sensitive,
	 * so take care that the configuration value is exactly named like the last
	 * part of the class name.
	 *
	 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
	 * characters are possible! You should always start the last part of the class
	 * name with an upper case character and continue only with lower case characters
	 * or numbers. Avoid chamel case names like "MyOrder"!
	 *
	 * @param string Last part of the class name
	 * @since 2014.03
	 * @category Developer
	 */

	/** controller/frontend/order/decorators/excludes
	 * Excludes decorators added by the "common" option from the order frontend controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to remove a decorator added via
	 * "controller/frontend/common/decorators/default" before they are wrapped
	 * around the frontend controller.
	 *
	 *  controller/frontend/order/decorators/excludes = array( 'decorator1' )
	 *
	 * This would remove the decorator named "decorator1" from the list of
	 * common decorators ("\Aimeos\Controller\Frontend\Common\Decorator\*") added via
	 * "controller/frontend/common/decorators/default" for the order frontend controller.
	 *
	 * @param array List of decorator names
	 * @since 2014.03
	 * @category Developer
	 * @see controller/frontend/common/decorators/default
	 * @see controller/frontend/order/decorators/global
	 * @see controller/frontend/order/decorators/local
	 */

	/** controller/frontend/order/decorators/global
	 * Adds a list of globally available decorators only to the order frontend controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap global decorators
	 * ("\Aimeos\Controller\Frontend\Common\Decorator\*") around the frontend controller.
	 *
	 *  controller/frontend/order/decorators/global = array( 'decorator1' )
	 *
	 * This would add the decorator named "decorator1" defined by
	 * "\Aimeos\Controller\Frontend\Common\Decorator\Decorator1" only to the frontend controller.
	 *
	 * @param array List of decorator names
	 * @since 2014.03
	 * @category Developer
	 * @see controller/frontend/common/decorators/default
	 * @see controller/frontend/order/decorators/excludes
	 * @see controller/frontend/order/decorators/local
	 */

	/** controller/frontend/order/decorators/local
	 * Adds a list of local decorators only to the order frontend controllers
	 *
	 * Decorators extend the functionality of a class by adding new aspects
	 * (e.g. log what is currently done), executing the methods of the underlying
	 * class only in certain conditions (e.g. only for logged in users) or
	 * modify what is returned to the caller.
	 *
	 * This option allows you to wrap local decorators
	 * ("\Aimeos\Controller\Frontend\Order\Decorator\*") around the frontend controller.
	 *
	 *  controller/frontend/order/decorators/local = array( 'decorator2' )
	 *
	 * This would add the decorator named "decorator2" defined by
	 * "\Aimeos\Controller\Frontend\Catalog\Decorator\Decorator2" only to the frontend
	 * controller.
	 *
	 * @param array List of decorator names
	 * @since 2014.03
	 * @category Developer
	 * @see controller/frontend/common/decorators/default
	 * @see controller/frontend/order/decorators/excludes
	 * @see controller/frontend/order/decorators/global
	 */


	private array $domains = [];
	private \Aimeos\Base\Criteria\Iface $filter;
	private \Aimeos\MShop\Common\Manager\Iface $manager;


	/**
	 * Initializes the controller
	 *
	 * @param \Aimeos\MShop\ContextIface $context Common MShop context object
	 */
	public function __construct( \Aimeos\MShop\ContextIface $context )
	{
		parent::__construct( $context );

		$this->manager = \Aimeos\MShop::create( $context, 'order' );
		$this->filter = $this->manager->filter( true );
		$this->addExpression( $this->filter->compare( '==', 'order.customerid', $context->user() ) );
	}


	/**
	 * Clones objects in controller
	 */
	public function __clone()
	{
		$this->filter = clone $this->filter;
		parent::__clone();
	}


	/**
	 * Adds generic condition for filtering orders
	 *
	 * @param string $operator Comparison operator, e.g. "==", "!=", "<", "<=", ">=", ">", "=~", "~="
	 * @param string $key Search key defined by the order manager, e.g. "order.type"
	 * @param array|string $value Value or list of values to compare to
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2019.04
	 */
	public function compare( string $operator, string $key, $value ) : Iface
	{
		$this->addExpression( $this->filter->compare( $operator, $key, $value ) );
		return $this;
	}


	/**
	 * Returns the order for the given order ID
	 *
	 * @param string $id Unique order ID
	 * @param bool $default Use default criteria to limit orders
	 * @return \Aimeos\MShop\Order\Item\Iface Order item object
	 * @since 2019.04
	 */
	public function get( string $id, bool $default = null ) : \Aimeos\MShop\Order\Item\Iface
	{
		return $this->manager->get( $id, $this->domains, $default );
	}


	/**
	 * Parses the given array and adds the conditions to the list of conditions
	 *
	 * @param array $conditions List of conditions, e.g. ['&&' => [['>' => ['order.statuspayment' => 0]], ['==' => ['order.type' => 'web']]]]
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2019.04
	 */
	public function parse( array $conditions ) : Iface
	{
		if( ( $cond = $this->filter->parse( $conditions ) ) !== null ) {
			$this->addExpression( $cond );
		}

		return $this;
	}


	/**
	 * Updates the given order item in the storage
	 *
	 * @param \Aimeos\MShop\Order\Item\Iface $orderItem Order item object
	 * @return \Aimeos\MShop\Order\Item\Iface $orderItem Saved order item object
	 * @since 2019.04
	 */
	public function save( \Aimeos\MShop\Order\Item\Iface $orderItem ) : \Aimeos\MShop\Order\Item\Iface
	{
		return $this->manager->save( $orderItem );
	}

	/**
	 * Returns the orders filtered by the previously assigned conditions
	 *
	 * @param int &$total Parameter where the total number of found attributes will be stored in
	 * @return \Aimeos\Map Ordered list of order items implementing \Aimeos\MShop\Order\Item\Iface
	 * @since 2019.04
	 */
	public function search( int &$total = null ) : \Aimeos\Map
	{
		$this->addExpression( $this->filter->getConditions() );

		$this->filter->setConditions( $this->filter->and( $this->getConditions() ) );
		$this->filter->setSortations( $this->getSortations() );

		return $this->manager->search( $this->filter, $this->domains, $total );
	}


	/**
	 * Sets the start value and the number of returned orders for slicing the list of found orders
	 *
	 * @param int $start Start value of the first order in the list
	 * @param int $limit Number of returned orders
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2019.04
	 */
	public function slice( int $start, int $limit ) : Iface
	{
		$maxsize = $this->context()->config()->get( 'controller/frontend/common/max-size', 500 );
		$this->filter->slice( $start, min( $limit, $maxsize ) );
		return $this;
	}


	/**
	 * Sets the sorting of the result list
	 *
	 * @param string|null $key Sorting of the result list like "-order.id", null for no sorting
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2019.04
	 */
	public function sort( string $key = null ) : Iface
	{
		$list = $this->splitKeys( $key );

		foreach( $list as $sortkey )
		{
			$direction = ( $sortkey[0] === '-' ? '-' : '+' );
			$this->addExpression( $this->filter->sort( $direction, ltrim( $sortkey, '+-' ) ) );
		}

		return $this;
	}


	/**
	 * Updates stock levels and coupons counts
	 *
	 * @param \Aimeos\MShop\Order\Item\Iface $orderItem Order item object
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2024.01
	 */
	public function update( \Aimeos\MShop\Order\Item\Iface $orderItem ) : Iface
	{
		$this->manager->update( $orderItem );
		return $this;
	}


	/**
	 * Sets the referenced domains that will be fetched too when retrieving items
	 *
	 * @param array $domains Domain names of the referenced items that should be fetched too
	 * @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
	 * @since 2019.04
	 */
	public function uses( array $domains ) : Iface
	{
		$this->domains = $domains;
		return $this;
	}


	/**
	 * Returns the manager used by the controller
	 *
	 * @return \Aimeos\MShop\Common\Manager\Iface Manager object
	 */
	protected function getManager() : \Aimeos\MShop\Common\Manager\Iface
	{
		return $this->manager;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Metaways Infosystems GmbH, 2014
6			* @copyright Aimeos (aimeos.org), 2015-2023
7			* @package Controller
8			* @subpackage Frontend
9			*/
10
11
12			namespace Aimeos\Controller\Frontend\Order;
13
14
15			/**
16			* Default implementation of the order frontend controller.
17			*
18			* @package Controller
19			* @subpackage Frontend
20			*/
21			class Standard
22			extends \Aimeos\Controller\Frontend\Base
23			implements Iface, \Aimeos\Controller\Frontend\Common\Iface
24			{
25			/** controller/frontend/order/name
26			* Class name of the used order frontend controller implementation
27			*
28			* Each default frontend controller can be replace by an alternative imlementation.
29			* To use this implementation, you have to set the last part of the class
30			* name as configuration value so the controller factory knows which class it
31			* has to instantiate.
32			*
33			* For example, if the name of the default class is
34			*
35			* \Aimeos\Controller\Frontend\Order\Standard
36			*
37			* and you want to replace it with your own version named
38			*
39			* \Aimeos\Controller\Frontend\Order\Myorder
40			*
41			* then you have to set the this configuration option:
42			*
43			* controller/frontend/order/name = Myorder
44			*
45			* The value is the last part of your own class name and it's case sensitive,
46			* so take care that the configuration value is exactly named like the last
47			* part of the class name.
48			*
49			* The allowed characters of the class name are A-Z, a-z and 0-9. No other
50			* characters are possible! You should always start the last part of the class
51			* name with an upper case character and continue only with lower case characters
52			* or numbers. Avoid chamel case names like "MyOrder"!
53			*
54			* @param string Last part of the class name
55			* @since 2014.03
56			* @category Developer
57			*/
58
59			/** controller/frontend/order/decorators/excludes
60			* Excludes decorators added by the "common" option from the order frontend controllers
61			*
62			* Decorators extend the functionality of a class by adding new aspects
63			* (e.g. log what is currently done), executing the methods of the underlying
64			* class only in certain conditions (e.g. only for logged in users) or
65			* modify what is returned to the caller.
66			*
67			* This option allows you to remove a decorator added via
68			* "controller/frontend/common/decorators/default" before they are wrapped
69			* around the frontend controller.
70			*
71			* controller/frontend/order/decorators/excludes = array( 'decorator1' )
72			*
73			* This would remove the decorator named "decorator1" from the list of
74			* common decorators ("\Aimeos\Controller\Frontend\Common\Decorator\*") added via
75			* "controller/frontend/common/decorators/default" for the order frontend controller.
76			*
77			* @param array List of decorator names
78			* @since 2014.03
79			* @category Developer
80			* @see controller/frontend/common/decorators/default
81			* @see controller/frontend/order/decorators/global
82			* @see controller/frontend/order/decorators/local
83			*/
84
85			/** controller/frontend/order/decorators/global
86			* Adds a list of globally available decorators only to the order frontend controllers
87			*
88			* Decorators extend the functionality of a class by adding new aspects
89			* (e.g. log what is currently done), executing the methods of the underlying
90			* class only in certain conditions (e.g. only for logged in users) or
91			* modify what is returned to the caller.
92			*
93			* This option allows you to wrap global decorators
94			* ("\Aimeos\Controller\Frontend\Common\Decorator\*") around the frontend controller.
95			*
96			* controller/frontend/order/decorators/global = array( 'decorator1' )
97			*
98			* This would add the decorator named "decorator1" defined by
99			* "\Aimeos\Controller\Frontend\Common\Decorator\Decorator1" only to the frontend controller.
100			*
101			* @param array List of decorator names
102			* @since 2014.03
103			* @category Developer
104			* @see controller/frontend/common/decorators/default
105			* @see controller/frontend/order/decorators/excludes
106			* @see controller/frontend/order/decorators/local
107			*/
108
109			/** controller/frontend/order/decorators/local
110			* Adds a list of local decorators only to the order frontend controllers
111			*
112			* Decorators extend the functionality of a class by adding new aspects
113			* (e.g. log what is currently done), executing the methods of the underlying
114			* class only in certain conditions (e.g. only for logged in users) or
115			* modify what is returned to the caller.
116			*
117			* This option allows you to wrap local decorators
118			* ("\Aimeos\Controller\Frontend\Order\Decorator\*") around the frontend controller.
119			*
120			* controller/frontend/order/decorators/local = array( 'decorator2' )
121			*
122			* This would add the decorator named "decorator2" defined by
123			* "\Aimeos\Controller\Frontend\Catalog\Decorator\Decorator2" only to the frontend
124			* controller.
125			*
126			* @param array List of decorator names
127			* @since 2014.03
128			* @category Developer
129			* @see controller/frontend/common/decorators/default
130			* @see controller/frontend/order/decorators/excludes
131			* @see controller/frontend/order/decorators/global
132			*/
133
134
135			private array $domains = [];
136			private \Aimeos\Base\Criteria\Iface $filter;
137			private \Aimeos\MShop\Common\Manager\Iface $manager;
138
139
140			/**
141			* Initializes the controller
142			*
143			* @param \Aimeos\MShop\ContextIface $context Common MShop context object
144			*/
145			public function __construct( \Aimeos\MShop\ContextIface $context )
146			{
147			parent::__construct( $context );
148
149			$this->manager = \Aimeos\MShop::create( $context, 'order' );
150			$this->filter = $this->manager->filter( true );
151			$this->addExpression( $this->filter->compare( '==', 'order.customerid', $context->user() ) );
152			}
153
154
155			/**
156			* Clones objects in controller
157			*/
158			public function __clone()
159			{
160			$this->filter = clone $this->filter;
161			parent::__clone();
162			}
163
164
165			/**
166			* Adds generic condition for filtering orders
167			*
168			* @param string $operator Comparison operator, e.g. "==", "!=", "<", "<=", ">=", ">", "=~", "~="
169			* @param string $key Search key defined by the order manager, e.g. "order.type"
170			* @param array\|string $value Value or list of values to compare to
171			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
172			* @since 2019.04
173			*/
174			public function compare( string $operator, string $key, $value ) : Iface
175			{
176			$this->addExpression( $this->filter->compare( $operator, $key, $value ) );
177			return $this;
178			}
179
180
181			/**
182			* Returns the order for the given order ID
183			*
184			* @param string $id Unique order ID
185			* @param bool $default Use default criteria to limit orders
186			* @return \Aimeos\MShop\Order\Item\Iface Order item object
187			* @since 2019.04
188			*/
189			public function get( string $id, bool $default = null ) : \Aimeos\MShop\Order\Item\Iface
190			{
191			return $this->manager->get( $id, $this->domains, $default );
192			}
193
194
195			/**
196			* Parses the given array and adds the conditions to the list of conditions
197			*
198			* @param array $conditions List of conditions, e.g. ['&&' => [['>' => ['order.statuspayment' => 0]], ['==' => ['order.type' => 'web']]]]
199			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
200			* @since 2019.04
201			*/
202			public function parse( array $conditions ) : Iface
203			{
204			if( ( $cond = $this->filter->parse( $conditions ) ) !== null ) {
205			$this->addExpression( $cond );
206			}
207
208			return $this;
209			}
210
211
212			/**
213			* Updates the given order item in the storage
214			*
215			* @param \Aimeos\MShop\Order\Item\Iface $orderItem Order item object
216			* @return \Aimeos\MShop\Order\Item\Iface $orderItem Saved order item object
217			* @since 2019.04
218			*/
219			public function save( \Aimeos\MShop\Order\Item\Iface $orderItem ) : \Aimeos\MShop\Order\Item\Iface
220			{
221			return $this->manager->save( $orderItem );
222			}
223
224			/**
225			* Returns the orders filtered by the previously assigned conditions
226			*
227			* @param int &$total Parameter where the total number of found attributes will be stored in
228			* @return \Aimeos\Map Ordered list of order items implementing \Aimeos\MShop\Order\Item\Iface
229			* @since 2019.04
230			*/
231			public function search( int &$total = null ) : \Aimeos\Map
232			{
233			$this->addExpression( $this->filter->getConditions() );
234
235			$this->filter->setConditions( $this->filter->and( $this->getConditions() ) );
236			$this->filter->setSortations( $this->getSortations() );
237
238			return $this->manager->search( $this->filter, $this->domains, $total );
239			}
240
241
242			/**
243			* Sets the start value and the number of returned orders for slicing the list of found orders
244			*
245			* @param int $start Start value of the first order in the list
246			* @param int $limit Number of returned orders
247			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
248			* @since 2019.04
249			*/
250			public function slice( int $start, int $limit ) : Iface
251			{
252			$maxsize = $this->context()->config()->get( 'controller/frontend/common/max-size', 500 );
253			$this->filter->slice( $start, min( $limit, $maxsize ) );
254			return $this;
255			}
256
257
258			/**
259			* Sets the sorting of the result list
260			*
261			* @param string\|null $key Sorting of the result list like "-order.id", null for no sorting
262			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
263			* @since 2019.04
264			*/
265			public function sort( string $key = null ) : Iface
266			{
267			$list = $this->splitKeys( $key );
268
269			foreach( $list as $sortkey )
270			{
271			$direction = ( $sortkey[0] === '-' ? '-' : '+' );
272			$this->addExpression( $this->filter->sort( $direction, ltrim( $sortkey, '+-' ) ) );
273			}
274
275			return $this;
276			}
277
278
279			/**
280			* Updates stock levels and coupons counts
281			*
282			* @param \Aimeos\MShop\Order\Item\Iface $orderItem Order item object
283			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
284			* @since 2024.01
285			*/
286			public function update( \Aimeos\MShop\Order\Item\Iface $orderItem ) : Iface
287			{
288			$this->manager->update( $orderItem );
289			return $this;
290			}
291
292
293			/**
294			* Sets the referenced domains that will be fetched too when retrieving items
295			*
296			* @param array $domains Domain names of the referenced items that should be fetched too
297			* @return \Aimeos\Controller\Frontend\Order\Iface Order controller for fluent interface
298			* @since 2019.04
299			*/
300			public function uses( array $domains ) : Iface
301			{
302			$this->domains = $domains;
303			return $this;
304			}
305
306
307			/**
308			* Returns the manager used by the controller
309			*
310			* @return \Aimeos\MShop\Common\Manager\Iface Manager object
311			*/
312			protected function getManager() : \Aimeos\MShop\Common\Manager\Iface
313			{
314			return $this->manager;
315			}
316			}
317

aimeos / ai-controller-frontend

Push — master ( 40eed1...d6e4b0 )

Standard::slice() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like