Issues in AbstractCallableNode.php - All Issues - Inspection of "Merge pull request #865 from lukasbestle/feature/s..." - phpmd/phpmd - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 902a34...c826a7 )

by Kyle

created 2021-04-16 22:41 UTC

src/main/php/PHPMD/Node/AbstractCallableNode.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * This file is part of PHP Mess Detector.
 *
 * Copyright (c) Manuel Pichler <[email protected]>.
 * All rights reserved.
 *
 * Licensed under BSD License
 * For full copyright and license information, please see the LICENSE file.
 * Redistributions of files must retain the above copyright notice.
 *
 * @author Manuel Pichler <[email protected]>
 * @copyright Manuel Pichler. All rights reserved.
 * @license https://opensource.org/licenses/bsd-license.php BSD License
 * @link http://phpmd.org/
 */

namespace PHPMD\Node;

use PDepend\Source\AST\AbstractASTCallable;

/**
 * Abstract base class for PHP_Depend function and method wrappers.
 */
abstract class AbstractCallableNode extends AbstractNode
{
    /**
     * Constructs a new callable wrapper.
     *
     * @param \PDepend\Source\AST\AbstractASTCallable $node
     */
    public function __construct(AbstractASTCallable $node)
    {
        parent::__construct($node);
    }

    /**
     * Returns the number of parameters in the callable signature.
     *
     * @return integer
     */
    public function getParameterCount()
    {
        return count($this->getNode()->getParameters());
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.
    }
}
    }
}


Push — master ( 902a34...c826a7 )

src/main/php/PHPMD/Node/AbstractCallableNode.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1		<?php
2		/**
3		* This file is part of PHP Mess Detector.
4		*
5		* Copyright (c) Manuel Pichler <[email protected]>.
6		* All rights reserved.
7		*
8		* Licensed under BSD License
9		* For full copyright and license information, please see the LICENSE file.
10		* Redistributions of files must retain the above copyright notice.
11		*
12		* @author Manuel Pichler <[email protected]>
13		* @copyright Manuel Pichler. All rights reserved.
14		* @license https://opensource.org/licenses/bsd-license.php BSD License
15		* @link http://phpmd.org/
16		*/
17
18		namespace PHPMD\Node;
19
20		use PDepend\Source\AST\AbstractASTCallable;
21
22		/**
23		* Abstract base class for PHP_Depend function and method wrappers.
24		*/
25		abstract class AbstractCallableNode extends AbstractNode
26		{
27		/**
28		* Constructs a new callable wrapper.
29		*
30		* @param \PDepend\Source\AST\AbstractASTCallable $node
31		*/
32	77	public function __construct(AbstractASTCallable $node)
33		{
34	77	parent::__construct($node);
35	77	}
36
37		/**
38		* Returns the number of parameters in the callable signature.
39		*
40		* @return integer
41		*/
42	2	public function getParameterCount()
43		{
44	2	return count($this->getNode()->getParameters());
		0 ignored issues – show Bug introduced 2015-11-24 14:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `PDepend\Source\AST\ASTArtifact` as the method `getParameters()` does only exist in the following implementations of said interface: `PDepend\Source\AST\ASTFunction`, `PDepend\Source\AST\ASTMethod`, `PDepend\Source\AST\AbstractASTCallable`. 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...
45		}
46		}
47

phpmd / phpmd

Push — master ( 902a34...c826a7 )

src/main/php/PHPMD/Node/AbstractCallableNode.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like