Base::__construct() - Code Metrics - Inspection of "Implemented stock frontend controller" - aimeos/ai-controller-frontend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f97bb5...a4e8a9 )

by Aimeos

created 2017-02-25 13:24 UTC

Base::__construct() A

↳ Parent: Base

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	7
nc	2
nop	2

<?php

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


namespace Aimeos\Controller\Frontend\Stock\Decorator;


/**
 * Base for stock frontend controller decorators
 *
 * @package Controller
 * @subpackage Frontend
 */
abstract class Base
	implements \Aimeos\Controller\Frontend\Common\Decorator\Iface

{
	private $context;
	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 )
	{
		$iface = '\Aimeos\Controller\Frontend\Stock\Iface';
		if( !( $controller instanceof $iface ) )
		{
			$msg = sprintf( 'Class "%1$s" does not implement interface "%2$s"', get_class( $controller ), $iface );
			throw new \Aimeos\Controller\Frontend\Exception( $msg );
		}

		$this->context = $context;
		$this->controller = $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 );
	}


	/**
	 * Returns the given search filter with the conditions attached for filtering by product code
	 *
	 * @param \Aimeos\MW\Criteria\Iface $filter Criteria object used for stock search
	 * @param array $codes List of product codes
	 * @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
	 * @since 2017.03
	 */
	public function addFilterCodes( \Aimeos\MW\Criteria\Iface $filter, array $codes )
	{
		return $this->controller->addFilterCodes( $filter, $codes );
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}


	/**
	 * Returns the given search filter with the conditions attached for filtering by type code
	 *
	 * @param \Aimeos\MW\Criteria\Iface $filter Criteria object used for stock search
	 * @param array $codes List of stock type codes
	 * @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
	 * @since 2017.03
	 */
	public function addFilterTypes( \Aimeos\MW\Criteria\Iface $filter, array $codes )
	{
		return $this->controller->addFilterTypes( $filter, $codes );
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}


	/**
	 * Returns the default stock filter
	 *
	 * @param boolean True to add default criteria
	 * @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
	 * @since 2017.03
	 */
	public function createFilter()
	{
		return $this->controller->createFilter();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}


	/**
	 * Returns the stock item for the given stock ID
	 *
	 * @param string $id Unique stock ID
	 * @param string[] $domains Domain names of items that are associated with the stocks and that should be fetched too
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return \Aimeos\MShop\Stock\Item\Iface Stock item including the referenced domains items
	 * @since 2017.03
	 */
	public function getItem( $id )
	{
		return $this->controller->getItem( $id );
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}


	/**
	 * Returns the stocks filtered by the given criteria object
	 *
	 * @param \Aimeos\MW\Criteria\Iface $filter Critera object which contains the filter conditions
	 * @param integer &$total Parameter where the total number of found stocks will be stored in
	 * @return array Ordered list of stock items implementing \Aimeos\MShop\Stock\Item\Iface
	 * @since 2017.03
	 */
	public function searchItems( \Aimeos\MW\Criteria\Iface $filter, &$total = null )
	{
		return $this->controller->searchItems( $filter, $total );
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}


	/**
	 * Returns the context item
	 *
	 * @return \Aimeos\MShop\Context\Item\Iface Context item object
	 */
	protected function getContext()
	{
		return $this->context;
	}


	/**
	 * Returns the frontend controller
	 *
	 * @return \Aimeos\Controller\Frontend\Stock\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), 2017
6			* @package Controller
7			* @subpackage Frontend
8			*/
9
10
11			namespace Aimeos\Controller\Frontend\Stock\Decorator;
12
13
14			/**
15			* Base for stock frontend controller decorators
16			*
17			* @package Controller
18			* @subpackage Frontend
19			*/
20			abstract class Base
21			implements \Aimeos\Controller\Frontend\Common\Decorator\Iface
			1 ignored issue – show Coding Style introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report The implements keyword must be on the same line as the class name Loading history...
22			{
23			private $context;
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			$iface = '\Aimeos\Controller\Frontend\Stock\Iface';
36			if( !( $controller instanceof $iface ) )
37			{
38			$msg = sprintf( 'Class "%1$s" does not implement interface "%2$s"', get_class( $controller ), $iface );
39			throw new \Aimeos\Controller\Frontend\Exception( $msg );
40			}
41
42			$this->context = $context;
43			$this->controller = $controller;
44			}
45
46
47			/**
48			* Passes unknown methods to wrapped objects.
49			*
50			* @param string $name Name of the method
51			* @param array $param List of method parameter
52			* @return mixed Returns the value of the called method
53			* @throws \Aimeos\Controller\Frontend\Exception If method call failed
54			*/
55			public function __call( $name, array $param )
56			{
57			return @call_user_func_array( array( $this->controller, $name ), $param );
58			}
59
60
61			/**
62			* Returns the given search filter with the conditions attached for filtering by product code
63			*
64			* @param \Aimeos\MW\Criteria\Iface $filter Criteria object used for stock search
65			* @param array $codes List of product codes
66			* @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
67			* @since 2017.03
68			*/
69			public function addFilterCodes( \Aimeos\MW\Criteria\Iface $filter, array $codes )
70			{
71			return $this->controller->addFilterCodes( $filter, $codes );
			1 ignored issue – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aimeos\Controller\Frontend\Iface` as the method `addFilterCodes()` does only exist in the following implementations of said interface: `Aimeos\Controller\Frontend\Stock\Decorator\Base`, `Aimeos\Controller\Frontend\Stock\Standard`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
72			}
73
74
75			/**
76			* Returns the given search filter with the conditions attached for filtering by type code
77			*
78			* @param \Aimeos\MW\Criteria\Iface $filter Criteria object used for stock search
79			* @param array $codes List of stock type codes
80			* @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
81			* @since 2017.03
82			*/
83			public function addFilterTypes( \Aimeos\MW\Criteria\Iface $filter, array $codes )
84			{
85			return $this->controller->addFilterTypes( $filter, $codes );
			1 ignored issue – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aimeos\Controller\Frontend\Iface` as the method `addFilterTypes()` does only exist in the following implementations of said interface: `Aimeos\Controller\Frontend\Stock\Decorator\Base`, `Aimeos\Controller\Frontend\Stock\Standard`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
86			}
87
88
89			/**
90			* Returns the default stock filter
91			*
92			* @param boolean True to add default criteria
93			* @return \Aimeos\MW\Criteria\Iface Criteria object containing the conditions for searching
94			* @since 2017.03
95			*/
96			public function createFilter()
97			{
98			return $this->controller->createFilter();
			1 ignored issue – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aimeos\Controller\Frontend\Iface` as the method `createFilter()` does only exist in the following implementations of said interface: `Aimeos\Controller\Frontend\Catalog\Decorator\Base`, `Aimeos\Controller\Frontend\Catalog\Standard`, `Aimeos\Controller\Frontend\Product\Decorator\Base`, `Aimeos\Controller\Frontend\Product\Standard`, `Aimeos\Controller\Frontend\Stock\Decorator\Base`, `Aimeos\Controller\Frontend\Stock\Standard`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
99			}
100
101
102			/**
103			* Returns the stock item for the given stock ID
104			*
105			* @param string $id Unique stock ID
106			* @param string[] $domains Domain names of items that are associated with the stocks and that should be fetched too
			0 ignored issues – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report There is no parameter named `$domains`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
107			* @return \Aimeos\MShop\Stock\Item\Iface Stock item including the referenced domains items
108			* @since 2017.03
109			*/
110			public function getItem( $id )
111			{
112			return $this->controller->getItem( $id );
			1 ignored issue – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aimeos\Controller\Frontend\Iface` as the method `getItem()` does only exist in the following implementations of said interface: `Aimeos\Controller\Frontend\Product\Decorator\Base`, `Aimeos\Controller\Frontend\Product\Standard`, `Aimeos\Controller\Frontend\Stock\Decorator\Base`, `Aimeos\Controller\Frontend\Stock\Standard`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
113			}
114
115
116			/**
117			* Returns the stocks filtered by the given criteria object
118			*
119			* @param \Aimeos\MW\Criteria\Iface $filter Critera object which contains the filter conditions
120			* @param integer &$total Parameter where the total number of found stocks will be stored in
121			* @return array Ordered list of stock items implementing \Aimeos\MShop\Stock\Item\Iface
122			* @since 2017.03
123			*/
124			public function searchItems( \Aimeos\MW\Criteria\Iface $filter, &$total = null )
125			{
126			return $this->controller->searchItems( $filter, $total );
			1 ignored issue – show Bug introduced 2017-02-25 13:26 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Aimeos\Controller\Frontend\Iface` as the method `searchItems()` does only exist in the following implementations of said interface: `Aimeos\Controller\Frontend\Product\Decorator\Base`, `Aimeos\Controller\Frontend\Product\Standard`, `Aimeos\Controller\Frontend\Stock\Decorator\Base`, `Aimeos\Controller\Frontend\Stock\Standard`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
127			}
128
129
130			/**
131			* Returns the context item
132			*
133			* @return \Aimeos\MShop\Context\Item\Iface Context item object
134			*/
135			protected function getContext()
136			{
137			return $this->context;
138			}
139
140
141			/**
142			* Returns the frontend controller
143			*
144			* @return \Aimeos\Controller\Frontend\Stock\Iface Frontend controller object
145			*/
146			protected function getController()
147			{
148			return $this->controller;
149			}
150			}
151

aimeos / ai-controller-frontend

Push — master ( f97bb5...a4e8a9 )

Base::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like