Base::search() - Code Metrics - Inspection of "Added has() method to supplier frontend controller" - aimeos/ai-controller-frontend - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 216152...7bdf82 )

by Aimeos

created 2019-08-24 16:01 UTC

Base::search() A

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

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


namespace Aimeos\Controller\Frontend\Supplier\Decorator;


/**
 * Base for supplier frontend controller decorators
 *
 * @package Controller
 * @subpackage Frontend
 */
abstract class Base
	extends \Aimeos\Controller\Frontend\Base
	implements \Aimeos\Controller\Frontend\Common\Decorator\Iface, \Aimeos\Controller\Frontend\Supplier\Iface
{
	private $controller;


	/**
	 * Initializes the controller decorator.
	 *
	 * @param \Aimeos\Controller\Frontend\Iface $controller Controller object
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
	 */
	public function __construct( \Aimeos\Controller\Frontend\Iface $controller, \Aimeos\MShop\Context\Item\Iface $context )
	{
		parent::__construct( $context );

		$iface = \Aimeos\Controller\Frontend\Supplier\Iface::class;
		$this->controller = \Aimeos\MW\Common\Base::checkClass( $iface, $controller );
	}


	/**
	 * Passes unknown methods to wrapped objects.
	 *
	 * @param string $name Name of the method
	 * @param array $param List of method parameter
	 * @return mixed Returns the value of the called method
	 * @throws \Aimeos\Controller\Frontend\Exception If method call failed
	 */
	public function __call( $name, array $param )
	{
		return @call_user_func_array( array( $this->controller, $name ), $param );
	}


	/**
	 * Clones objects in controller and resets values
	 */
	public function __clone()
	{
		$this->controller = clone $this->controller;
	}


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


	/**
	 * Returns the supplier for the given supplier code
	 *
	 * @param string $code Unique supplier code
	 * @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
	 * @since 2019.04
	 */
	public function find( $code )
	{
		return $this->controller->find( $code );
	}


	/**
	 * Returns the supplier for the given supplier ID
	 *
	 * @param string $id Unique supplier ID
	 * @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
	 * @since 2019.04
	 */
	public function get( $id )
	{
		return $this->controller->get( $id );
	}


	/**
	 * Adds a filter to return only items containing a reference to the given ID
	 *
	 * @param string $domain Domain name of the referenced item, e.g. "product"
	 * @param string|null $type Type code of the reference, e.g. "default" or null for all types
	 * @param string|null $refId ID of the referenced item of the given domain or null for all references
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.10
	 */
	public function has( $domain, $type = null, $refId = null )
	{
		$this->controller->has( $domain, $type, $refId );
		return $this;
	}


	/**
	 * Parses the given array and adds the conditions to the list of conditions
	 *
	 * @param array $conditions List of conditions, e.g. ['>' => ['supplier.dateback' => '2000-01-01 00:00:00']]
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.04
	 */
	public function parse( array $conditions )
	{
		$this->controller->parse( $conditions );
		return $this;
	}


	/**
	 * Returns the suppliers filtered by the previously assigned conditions
	 *
	 * @param integer &$total Parameter where the total number of found suppliers will be stored in
	 * @return \Aimeos\MShop\Supplier\Item\Iface[] Ordered list of supplier items
	 * @since 2019.04
	 */
	public function search( &$total = null )
	{
		return $this->controller->search( $total );
	}


	/**
	 * Sets the start value and the number of returned supplier items for slicing the list of found supplier items
	 *
	 * @param integer $start Start value of the first supplier item in the list
	 * @param integer $limit Number of returned supplier items
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.04
	 */
	public function slice( $start, $limit )
	{
		$this->controller->slice( $start, $limit );
		return $this;
	}


	/**
	 * Sets the sorting of the result list
	 *
	 * @param string|null $key Sorting key of the result list like "supplier.label", null for no sorting
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.04
	 */
	public function sort( $key = null )
	{
		$this->controller->sort( $key );
		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\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.04
	 */
	public function uses( array $domains )
	{
		$this->controller->uses( $domains );
		return $this;
	}


	/**
	 * Injects the reference of the outmost object
	 *
	 * @param \Aimeos\Controller\Frontend\Iface $object Reference to the outmost controller or decorator
	 * @return \Aimeos\Controller\Frontend\Iface Controller object for chaining method calls
	 */
	public function setObject( \Aimeos\Controller\Frontend\Iface $object )
	{
		parent::setObject( $object );

		$this->controller->setObject( $object );

		return $this;
	}


	/**
	 * Returns the frontend controller
	 *
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Frontend controller object
	 */
	protected function getController()
	{
		return $this->controller;
	}
}


1			<?php
2
3			/**
4			* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
5			* @copyright Aimeos (aimeos.org), 2018
6			* @package Controller
7			* @subpackage Frontend
8			*/
9
10
11			namespace Aimeos\Controller\Frontend\Supplier\Decorator;
12
13
14			/**
15			* Base for supplier frontend controller decorators
16			*
17			* @package Controller
18			* @subpackage Frontend
19			*/
20			abstract class Base
21			extends \Aimeos\Controller\Frontend\Base
22			implements \Aimeos\Controller\Frontend\Common\Decorator\Iface, \Aimeos\Controller\Frontend\Supplier\Iface
23			{
24			private $controller;
25
26
27			/**
28			* Initializes the controller decorator.
29			*
30			* @param \Aimeos\Controller\Frontend\Iface $controller Controller object
31			* @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
32			*/
33			public function __construct( \Aimeos\Controller\Frontend\Iface $controller, \Aimeos\MShop\Context\Item\Iface $context )
34			{
35			parent::__construct( $context );
36
37			$iface = \Aimeos\Controller\Frontend\Supplier\Iface::class;
38			$this->controller = \Aimeos\MW\Common\Base::checkClass( $iface, $controller );
39			}
40
41
42			/**
43			* Passes unknown methods to wrapped objects.
44			*
45			* @param string $name Name of the method
46			* @param array $param List of method parameter
47			* @return mixed Returns the value of the called method
48			* @throws \Aimeos\Controller\Frontend\Exception If method call failed
49			*/
50			public function __call( $name, array $param )
51			{
52			return @call_user_func_array( array( $this->controller, $name ), $param );
53			}
54
55
56			/**
57			* Clones objects in controller and resets values
58			*/
59			public function __clone()
60			{
61			$this->controller = clone $this->controller;
62			}
63
64
65			/**
66			* Adds generic condition for filtering
67			*
68			* @param string $operator Comparison operator, e.g. "==", "!=", "<", "<=", ">=", ">", "=~", "~="
69			* @param string $key Search key defined by the supplier manager, e.g. "supplier.status"
70			* @param array\|string $value Value or list of values to compare to
71			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
72			* @since 2019.04
73			*/
74			public function compare( $operator, $key, $value )
75			{
76			$this->controller->compare( $operator, $key, $value );
77			return $this;
78			}
79
80
81			/**
82			* Returns the supplier for the given supplier code
83			*
84			* @param string $code Unique supplier code
85			* @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
86			* @since 2019.04
87			*/
88			public function find( $code )
89			{
90			return $this->controller->find( $code );
91			}
92
93
94			/**
95			* Returns the supplier for the given supplier ID
96			*
97			* @param string $id Unique supplier ID
98			* @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
99			* @since 2019.04
100			*/
101			public function get( $id )
102			{
103			return $this->controller->get( $id );
104			}
105
106
107			/**
108			* Adds a filter to return only items containing a reference to the given ID
109			*
110			* @param string $domain Domain name of the referenced item, e.g. "product"
111			* @param string\|null $type Type code of the reference, e.g. "default" or null for all types
112			* @param string\|null $refId ID of the referenced item of the given domain or null for all references
113			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
114			* @since 2019.10
115			*/
116			public function has( $domain, $type = null, $refId = null )
117			{
118			$this->controller->has( $domain, $type, $refId );
119			return $this;
120			}
121
122
123			/**
124			* Parses the given array and adds the conditions to the list of conditions
125			*
126			* @param array $conditions List of conditions, e.g. ['>' => ['supplier.dateback' => '2000-01-01 00:00:00']]
127			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
128			* @since 2019.04
129			*/
130			public function parse( array $conditions )
131			{
132			$this->controller->parse( $conditions );
133			return $this;
134			}
135
136
137			/**
138			* Returns the suppliers filtered by the previously assigned conditions
139			*
140			* @param integer &$total Parameter where the total number of found suppliers will be stored in
141			* @return \Aimeos\MShop\Supplier\Item\Iface[] Ordered list of supplier items
142			* @since 2019.04
143			*/
144			public function search( &$total = null )
145			{
146			return $this->controller->search( $total );
147			}
148
149
150			/**
151			* Sets the start value and the number of returned supplier items for slicing the list of found supplier items
152			*
153			* @param integer $start Start value of the first supplier item in the list
154			* @param integer $limit Number of returned supplier items
155			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
156			* @since 2019.04
157			*/
158			public function slice( $start, $limit )
159			{
160			$this->controller->slice( $start, $limit );
161			return $this;
162			}
163
164
165			/**
166			* Sets the sorting of the result list
167			*
168			* @param string\|null $key Sorting key of the result list like "supplier.label", null for no sorting
169			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
170			* @since 2019.04
171			*/
172			public function sort( $key = null )
173			{
174			$this->controller->sort( $key );
175			return $this;
176			}
177
178
179			/**
180			* Sets the referenced domains that will be fetched too when retrieving items
181			*
182			* @param array $domains Domain names of the referenced items that should be fetched too
183			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
184			* @since 2019.04
185			*/
186			public function uses( array $domains )
187			{
188			$this->controller->uses( $domains );
189			return $this;
190			}
191
192
193			/**
194			* Injects the reference of the outmost object
195			*
196			* @param \Aimeos\Controller\Frontend\Iface $object Reference to the outmost controller or decorator
197			* @return \Aimeos\Controller\Frontend\Iface Controller object for chaining method calls
198			*/
199			public function setObject( \Aimeos\Controller\Frontend\Iface $object )
200			{
201			parent::setObject( $object );
202
203			$this->controller->setObject( $object );
204
205			return $this;
206			}
207
208
209			/**
210			* Returns the frontend controller
211			*
212			* @return \Aimeos\Controller\Frontend\Supplier\Iface Frontend controller object
213			*/
214			protected function getController()
215			{
216			return $this->controller;
217			}
218			}
219

aimeos / ai-controller-frontend

Push — master ( 216152...7bdf82 )

Base::search() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like