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

Passed

Push — master ( 411768...2359f2 )

by Aimeos

created 2019-12-13 17:36 UTC

Base::__call() A

↳ Parent: Base

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?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( string $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( string $operator, string $key, $value ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$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( string $code ) : \Aimeos\MShop\Supplier\Item\Iface
	{
		return $this->controller->find( $code );
	}


	/**
	 * Creates a search function string for the given name and parameters
	 *
	 * @param string $name Name of the search function without parenthesis, e.g. "supplier:has"
	 * @param array $params List of parameters for the search function with numeric keys starting at 0
	 * @return string Search function string that can be used in compare()
	 */
	public function function( string $name, array $params ) : string
	{
		return $this->controller->function( $name, $params );
	}


	/**
	 * 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( string $id ) : \Aimeos\MShop\Supplier\Item\Iface
	{
		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( string $domain, string $type = null, string $refId = null ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$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 ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$this->controller->parse( $conditions );
		return $this;
	}


	/**
	 * Returns the suppliers filtered by the previously assigned conditions
	 *
	 * @param int &$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( int &$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 int $start Start value of the first supplier item in the list
	 * @param int $limit Number of returned supplier items
	 * @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
	 * @since 2019.04
	 */
	public function slice( int $start, int $limit ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$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( string $key = null ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$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 ) : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		$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 ) : \Aimeos\Controller\Frontend\Iface
	{
		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() : \Aimeos\Controller\Frontend\Supplier\Iface
	{
		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( string $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( string $operator, string $key, $value ) : \Aimeos\Controller\Frontend\Supplier\Iface
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( string $code ) : \Aimeos\MShop\Supplier\Item\Iface
89			{
90			return $this->controller->find( $code );
91			}
92
93
94			/**
95			* Creates a search function string for the given name and parameters
96			*
97			* @param string $name Name of the search function without parenthesis, e.g. "supplier:has"
98			* @param array $params List of parameters for the search function with numeric keys starting at 0
99			* @return string Search function string that can be used in compare()
100			*/
101			public function function( string $name, array $params ) : string
102			{
103			return $this->controller->function( $name, $params );
104			}
105
106
107			/**
108			* Returns the supplier for the given supplier ID
109			*
110			* @param string $id Unique supplier ID
111			* @return \Aimeos\MShop\Supplier\Item\Iface Supplier item including the referenced domains items
112			* @since 2019.04
113			*/
114			public function get( string $id ) : \Aimeos\MShop\Supplier\Item\Iface
115			{
116			return $this->controller->get( $id );
117			}
118
119
120			/**
121			* Adds a filter to return only items containing a reference to the given ID
122			*
123			* @param string $domain Domain name of the referenced item, e.g. "product"
124			* @param string\|null $type Type code of the reference, e.g. "default" or null for all types
125			* @param string\|null $refId ID of the referenced item of the given domain or null for all references
126			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
127			* @since 2019.10
128			*/
129			public function has( string $domain, string $type = null, string $refId = null ) : \Aimeos\Controller\Frontend\Supplier\Iface
130			{
131			$this->controller->has( $domain, $type, $refId );
132			return $this;
133			}
134
135
136			/**
137			* Parses the given array and adds the conditions to the list of conditions
138			*
139			* @param array $conditions List of conditions, e.g. ['>' => ['supplier.dateback' => '2000-01-01 00:00:00']]
140			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
141			* @since 2019.04
142			*/
143			public function parse( array $conditions ) : \Aimeos\Controller\Frontend\Supplier\Iface
144			{
145			$this->controller->parse( $conditions );
146			return $this;
147			}
148
149
150			/**
151			* Returns the suppliers filtered by the previously assigned conditions
152			*
153			* @param int &$total Parameter where the total number of found suppliers will be stored in
154			* @return \Aimeos\MShop\Supplier\Item\Iface[] Ordered list of supplier items
155			* @since 2019.04
156			*/
157			public function search( int &$total = null )
158			{
159			return $this->controller->search( $total );
160			}
161
162
163			/**
164			* Sets the start value and the number of returned supplier items for slicing the list of found supplier items
165			*
166			* @param int $start Start value of the first supplier item in the list
167			* @param int $limit Number of returned supplier items
168			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
169			* @since 2019.04
170			*/
171			public function slice( int $start, int $limit ) : \Aimeos\Controller\Frontend\Supplier\Iface
172			{
173			$this->controller->slice( $start, $limit );
174			return $this;
175			}
176
177
178			/**
179			* Sets the sorting of the result list
180			*
181			* @param string\|null $key Sorting key of the result list like "supplier.label", null for no sorting
182			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
183			* @since 2019.04
184			*/
185			public function sort( string $key = null ) : \Aimeos\Controller\Frontend\Supplier\Iface
186			{
187			$this->controller->sort( $key );
188			return $this;
189			}
190
191
192			/**
193			* Sets the referenced domains that will be fetched too when retrieving items
194			*
195			* @param array $domains Domain names of the referenced items that should be fetched too
196			* @return \Aimeos\Controller\Frontend\Supplier\Iface Supplier controller for fluent interface
197			* @since 2019.04
198			*/
199			public function uses( array $domains ) : \Aimeos\Controller\Frontend\Supplier\Iface
200			{
201			$this->controller->uses( $domains );
202			return $this;
203			}
204
205
206			/**
207			* Injects the reference of the outmost object
208			*
209			* @param \Aimeos\Controller\Frontend\Iface $object Reference to the outmost controller or decorator
210			* @return \Aimeos\Controller\Frontend\Iface Controller object for chaining method calls
211			*/
212			public function setObject( \Aimeos\Controller\Frontend\Iface $object ) : \Aimeos\Controller\Frontend\Iface
213			{
214			parent::setObject( $object );
215
216			$this->controller->setObject( $object );
217
218			return $this;
219			}
220
221
222			/**
223			* Returns the frontend controller
224			*
225			* @return \Aimeos\Controller\Frontend\Supplier\Iface Frontend controller object
226			*/
227			protected function getController() : \Aimeos\Controller\Frontend\Supplier\Iface
228			{
229			return $this->controller;
230			}
231			}
232

aimeos / ai-controller-frontend

Push — master ( 411768...2359f2 )

Base::__call() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like