Entity - Code Metrics - frqnck/apix - Measure and Improve Code Quality continuously with Scrutinizer

Entity B
last analyzed 2017-05-17 20:31 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	329
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	2

Test Coverage

Coverage

Importance

Changes

Metric	Value
wmc	41
lcom	3
cbo	2
dl	0
loc	329
ccs	0
cts	138
cp	0
rs	8.2769
c	0
b	0
f	0

18 Methods

Rating	Name	Size	Complexity
A	__construct()	4	2
A	_append()	6	2
A	call()	18	4
A	convertToArray()	15	3
A	hasMethod()	4	1
A	getAllActions()	10	3
A	getDefaultAction()	6	2
A	toArray()	4	1
B	getDocs()	18	6
C	getValidatedParams()	36	7
A	setResults()	4	1
A	getResults()	4	1
A	setRoute()	4	1
A	getRoute()	4	1
A	hasRedirect()	4	1
A	getRedirect()	4	1
A	getActions()	8	2
A	getAnnotationValue()	7	2

How to fix Complexity

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix;

use Apix\Listener,
    Apix\Config,
    Apix\Router,
    Apix\Entity\EntityInterface;

/**
 * Represents a resource entity.
 */
class Entity extends Listener
{
    /**
     * Holds this entity (parsed) documentaions.
     * @var array|null
     */
    protected $docs = null;

    /**
     * @var Route
     */
    protected $route;

    /**
     * Holds the entity redirect location.
     * @var  string|null
     */
    protected $redirect;

    /**
     * Holds all the entity available actions.
     * @var  array|null
     */
    protected $actions = null;

    /**
     * Holds all default actions.
     * @var  array
     */
    protected $defaultActions = array(
        'OPTIONS' => 'help',
        'HEAD'    => 'test'
    );

    /**
     * Holds the array of results of an entity.
     * @var  array|null
     */
    protected $results = null;

    /**
     * @var Config
     */
    protected $config;

    /**
     * Constructor.
     *
     * @param Config|null $config A config object
     */
    public function __construct(Config $config = null)
    {
        $this->config = $config ?: \Apix\Config::getInstance();
    }

    /**
     * Appends the given array definition and apply generic mappings.
     *
     * @param  array $def An entity array definition.
     * @return void
     * @see    EntityInterface::_append
     */
    final public function _append(array $def)
    {
        if (isset($def['redirect'])) {
            $this->redirect = $def['redirect'];
        }
    }

    /**
     * Call the resource entity and return its results as an array.
     *
     * @return array
     * @see     EntityInterface::underlineCall
     */
    public function call($direct=false)
    {
        // early listeners @ pre-entity
        if (!$direct) {
            $this->hook('entity', 'early');
        }

        if (null === $this->results) {
            $this->results = $this->underlineCall($this->route);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        }

        // late listeners @ post-entity
        if (!$direct) {
            $this->hook('entity', 'late');
        }

        return self::convertToArray($this->results);
    }

    /**
     * Converts the provided variable to an array.
     *
     * @param  mixed $mix
     * @return array
     */
    public static function convertToArray($mix)
    {
        switch(true):
            case is_object($mix):
                // TODO: convert nested objects recursively...
                return get_object_vars($mix);

            case is_string($mix):
                return array($mix);

            default: // so it must be an array!
switch ($expr) {
    default:
        doSomething(); //right
        break;
}


switch ($expr) {
    default:

        doSomething(); //wrong
        break;
}

                return $mix;
        endswitch;
    }

    /**
     * Checks wether the current entity holds the specified method.
     *
     * @param  string  $method
     * @param  array   $actions=null Use to override local actions.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return boolean
     */
    public function hasMethod($method)
    {
        return array_key_exists($method, $this->getActions());
    }

    /**
     * Returns all the available actions.
     *
     * @return array
     */
    public function getAllActions()
    {
        $current = null === $this->getActions() ? array() : $this->getActions();
        $default = $this->defaultActions;
        if (false == array_key_exists('GET', $current) ) {

            unset($default['HEAD']);
        }

        return $current+$default;
    }

    /**
     * Gets the specified default action.
     *
     * @return string|null
     */
    public function getDefaultAction($method)
    {
        if (isset($this->defaultActions[$method])) {
            return $this->defaultActions[$method];
        }
    }

    /**
     * Returns this entity as an associative array.
     *
     * @return array
     */
    public function toArray()
    {
      return get_object_vars($this);
    }

    /**
     * Returns the full class/group or specified method documentation.
     *
     * @param  string $method
     * @return array
     */
    public function getDocs($method=null)
    {
        if (null == $this->docs) {
            $name = 'apix_docs';
            if (!$this->config->get('cache_annotation')) {
                $this->docs = $this->parseDocs();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            } elseif (false === $this->docs = apc_fetch($name)) {
                apc_store($name, $this->docs = $this->parseDocs());
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            }
        }

        if (null !== $method) {
            return isset($this->docs['methods'][$method])
                    ? $this->docs['methods'][$method] : null;
        }

        return $this->docs;
    }

    /**
     * Returns the validated and required parameters.
     *
     * @param  \ReflectionFunctionAbstract $refMethod   A reflected method/function to introspect.
     * @param  string                      $httpMethod  A public method name e.g. GET, POST.
     * @param  array                       $routeParams An array of route parameters to check upon.
     * @return array                       The array of validated and required parameters
     * @throws \BadMethodCallException     400
     */
    public function getValidatedParams(
        \ReflectionFunctionAbstract $refMethod, $httpMethod, array $routeParams
    ) {
        $params = array();
        foreach ($refMethod->getParameters() as $param) {
            $name = $param->getName();
            if (
                !$param->isOptional()
                && !array_key_exists($name, $routeParams)
            ) {

                // auto inject local objects
                if ($class = $param->getClass()) {
                    $obj = strtolower(str_replace(__NAMESPACE__
                           . '\\', '', $class->getName()));
                    $params[$name] = $obj == 'server'
                                     ? $this->route->server
                                     : $this->route->server->$obj;
                } else {
                    throw new \BadMethodCallException(
                        "Required {$httpMethod} parameter \"{$name}\" missing in action.",
                        400
                    );
                }

            } elseif (isset($routeParams[$name])) {
                $params[$name] = $routeParams[$name];
            }
        }

        // TODO: maybe we need to check the order of params to match the method?

        // TODO: eventually add some kind of type casting using namespacing
        // e.g. method(integer $myInteger) => Apix\Casting\Integer, etc...
        return $params;
    }

    /**
     * Sets the entity results.
     *
     * @param  array $results
     * @return void
     */
    public function setResults(array $results=null)
    {
        $this->results = $results;
    }

    /**
     * Sets the entity results.
     *
     * @return array
     */
    public function getResults()
    {
        return $this->results;
    }

    /**
     * Sets the route object.
     *
     * @param  Router $route
     * @return void
     */
    public function setRoute(Router $route)
    {
        $this->route = $route;

    }

    /**
    * Returns the route object.
    *
    * @return Router
    */
    public function getRoute()
    {
        return $this->route;
    }

    /**
     * Returns the redirect location.
     *
     * @return string
     */
    public function hasRedirect()
    {
        return isset($this->redirect);
    }

    /**
     * Returns the redirect location.
     *
     * @return string
     */
    public function getRedirect()
    {
        return $this->redirect;
    }

    /**
     * Returns an array of method keys and action values.
     *
     * @param  array $array
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     */
    public function getActions()
    {
        if (null === $this->actions) {
            $this->setActions();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        }

        return $this->actions;
    }

    /**
     * Returns the value of an anotation.
     *
     * @param  string   $name
     * @return mix|null
     */
    public function getAnnotationValue($name)
    {
        $method = $this->route->getMethod();
        $doc = $this->getDocs($method);

        return isset($doc[$name]) ? $doc[$name] : null;
    }

}


Entity B
last analyzed 2017-05-17 20:31 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/**
4			*
5			* This file is part of the Apix Project.
6			*
7			* (c) Franck Cassedanne <franck at ouarz.net>
8			*
9			* @license http://opensource.org/licenses/BSD-3-Clause New BSD License
10			*
11			*/
12
13			namespace Apix;
14
15			use Apix\Listener,
16			Apix\Config,
17			Apix\Router,
18			Apix\Entity\EntityInterface;
19
20			/**
21			* Represents a resource entity.
22			*/
23			class Entity extends Listener
24			{
25			/**
26			* Holds this entity (parsed) documentaions.
27			* @var array\|null
28			*/
29			protected $docs = null;
30
31			/**
32			* @var Route
33			*/
34			protected $route;
35
36			/**
37			* Holds the entity redirect location.
38			* @var string\|null
39			*/
40			protected $redirect;
41
42			/**
43			* Holds all the entity available actions.
44			* @var array\|null
45			*/
46			protected $actions = null;
47
48			/**
49			* Holds all default actions.
50			* @var array
51			*/
52			protected $defaultActions = array(
53			'OPTIONS' => 'help',
54			'HEAD' => 'test'
55			);
56
57			/**
58			* Holds the array of results of an entity.
59			* @var array\|null
60			*/
61			protected $results = null;
62
63			/**
64			* @var Config
65			*/
66			protected $config;
67
68			/**
69			* Constructor.
70			*
71			* @param Config\|null $config A config object
72			*/
73			public function __construct(Config $config = null)
74			{
75			$this->config = $config ?: \Apix\Config::getInstance();
76			}
77
78			/**
79			* Appends the given array definition and apply generic mappings.
80			*
81			* @param array $def An entity array definition.
82			* @return void
83			* @see EntityInterface::_append
84			*/
85			final public function _append(array $def)
86			{
87			if (isset($def['redirect'])) {
88			$this->redirect = $def['redirect'];
89			}
90			}
91
92			/**
93			* Call the resource entity and return its results as an array.
94			*
95			* @return array
96			* @see EntityInterface::underlineCall
97			*/
98			public function call($direct=false)
99			{
100			// early listeners @ pre-entity
101			if (!$direct) {
102			$this->hook('entity', 'early');
103			}
104
105			if (null === $this->results) {
106			$this->results = $this->underlineCall($this->route);
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Apix\Entity` as the method `underlineCall()` does only exist in the following sub-classes of `Apix\Entity`: `Apix\Entity\EntityClass`, `Apix\Entity\EntityClosure`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
107			}
108
109			// late listeners @ post-entity
110			if (!$direct) {
111			$this->hook('entity', 'late');
112			}
113
114			return self::convertToArray($this->results);
115			}
116
117			/**
118			* Converts the provided variable to an array.
119			*
120			* @param mixed $mix
121			* @return array
122			*/
123			public static function convertToArray($mix)
124			{
125			switch(true):
126			case is_object($mix):
127			// TODO: convert nested objects recursively...
128			return get_object_vars($mix);
129
130			case is_string($mix):
131			return array($mix);
132
133			default: // so it must be an array!
			0 ignored issues – show Coding Style introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report The default body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a default statement must start on the line immediately following the statement. switch ($expr) { default: doSomething(); //right break; } switch ($expr) { default: doSomething(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
134
135			return $mix;
136			endswitch;
137			}
138
139			/**
140			* Checks wether the current entity holds the specified method.
141			*
142			* @param string $method
143			* @param array $actions=null Use to override local actions.
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report There is no parameter named `$actions=null`. 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...
144			* @return boolean
145			*/
146			public function hasMethod($method)
147			{
148			return array_key_exists($method, $this->getActions());
149			}
150
151			/**
152			* Returns all the available actions.
153			*
154			* @return array
155			*/
156			public function getAllActions()
157			{
158			$current = null === $this->getActions() ? array() : $this->getActions();
159			$default = $this->defaultActions;
160			if (false == array_key_exists('GET', $current) ) {
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
161			unset($default['HEAD']);
162			}
163
164			return $current+$default;
165			}
166
167			/**
168			* Gets the specified default action.
169			*
170			* @return string\|null
171			*/
172			public function getDefaultAction($method)
173			{
174			if (isset($this->defaultActions[$method])) {
175			return $this->defaultActions[$method];
176			}
177			}
178
179			/**
180			* Returns this entity as an associative array.
181			*
182			* @return array
183			*/
184			public function toArray()
185			{
186			return get_object_vars($this);
187			}
188
189			/**
190			* Returns the full class/group or specified method documentation.
191			*
192			* @param string $method
193			* @return array
194			*/
195			public function getDocs($method=null)
196			{
197			if (null == $this->docs) {
198			$name = 'apix_docs';
199			if (!$this->config->get('cache_annotation')) {
200			$this->docs = $this->parseDocs();
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Apix\Entity` as the method `parseDocs()` does only exist in the following sub-classes of `Apix\Entity`: `Apix\Entity\EntityClass`, `Apix\Entity\EntityClosure`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
201			} elseif (false === $this->docs = apc_fetch($name)) {
202			apc_store($name, $this->docs = $this->parseDocs());
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Apix\Entity` as the method `parseDocs()` does only exist in the following sub-classes of `Apix\Entity`: `Apix\Entity\EntityClass`, `Apix\Entity\EntityClosure`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
203			}
204			}
205
206			if (null !== $method) {
207			return isset($this->docs['methods'][$method])
208			? $this->docs['methods'][$method] : null;
209			}
210
211			return $this->docs;
212			}
213
214			/**
215			* Returns the validated and required parameters.
216			*
217			* @param \ReflectionFunctionAbstract $refMethod A reflected method/function to introspect.
218			* @param string $httpMethod A public method name e.g. GET, POST.
219			* @param array $routeParams An array of route parameters to check upon.
220			* @return array The array of validated and required parameters
221			* @throws \BadMethodCallException 400
222			*/
223			public function getValidatedParams(
224			\ReflectionFunctionAbstract $refMethod, $httpMethod, array $routeParams
225			) {
226			$params = array();
227			foreach ($refMethod->getParameters() as $param) {
228			$name = $param->getName();
229			if (
230			!$param->isOptional()
231			&& !array_key_exists($name, $routeParams)
232			) {
233
234			// auto inject local objects
235			if ($class = $param->getClass()) {
236			$obj = strtolower(str_replace(__NAMESPACE__
237			. '\\', '', $class->getName()));
238			$params[$name] = $obj == 'server'
239			? $this->route->server
240			: $this->route->server->$obj;
241			} else {
242			throw new \BadMethodCallException(
243			"Required {$httpMethod} parameter \"{$name}\" missing in action.",
244			400
245			);
246			}
247
248			} elseif (isset($routeParams[$name])) {
249			$params[$name] = $routeParams[$name];
250			}
251			}
252
253			// TODO: maybe we need to check the order of params to match the method?
254
255			// TODO: eventually add some kind of type casting using namespacing
256			// e.g. method(integer $myInteger) => Apix\Casting\Integer, etc...
257			return $params;
258			}
259
260			/**
261			* Sets the entity results.
262			*
263			* @param array $results
264			* @return void
265			*/
266			public function setResults(array $results=null)
267			{
268			$this->results = $results;
269			}
270
271			/**
272			* Sets the entity results.
273			*
274			* @return array
275			*/
276			public function getResults()
277			{
278			return $this->results;
279			}
280
281			/**
282			* Sets the route object.
283			*
284			* @param Router $route
285			* @return void
286			*/
287			public function setRoute(Router $route)
288			{
289			$this->route = $route;
			0 ignored issues – show Documentation Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like `$route` of type `object<Apix\Router>` is incompatible with the declared type `object<Apix\Route>` of property `$route`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
290			}
291
292			/**
293			* Returns the route object.
294			*
295			* @return Router
296			*/
297			public function getRoute()
298			{
299			return $this->route;
300			}
301
302			/**
303			* Returns the redirect location.
304			*
305			* @return string
306			*/
307			public function hasRedirect()
308			{
309			return isset($this->redirect);
310			}
311
312			/**
313			* Returns the redirect location.
314			*
315			* @return string
316			*/
317			public function getRedirect()
318			{
319			return $this->redirect;
320			}
321
322			/**
323			* Returns an array of method keys and action values.
324			*
325			* @param array $array
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report There is no parameter named `$array`. 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...
326			* @return array
327			*/
328			public function getActions()
329			{
330			if (null === $this->actions) {
331			$this->setActions();
			0 ignored issues – show Bug introduced 2016-04-08 09:59 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Apix\Entity` as the method `setActions()` does only exist in the following sub-classes of `Apix\Entity`: `Apix\Entity\EntityClass`, `Apix\Entity\EntityClosure`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
332			}
333
334			return $this->actions;
335			}
336
337			/**
338			* Returns the value of an anotation.
339			*
340			* @param string $name
341			* @return mix\|null
342			*/
343			public function getAnnotationValue($name)
344			{
345			$method = $this->route->getMethod();
346			$doc = $this->getDocs($method);
347
348			return isset($doc[$name]) ? $doc[$name] : null;
349			}
350
351			}
352

frqnck / apix

Entity B last analyzed 2017-05-17 20:31 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Complexity

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Entity B
last analyzed 2017-05-17 20:31 UTC