Test Failed
Push — master ( 475bfc...ca0e1d )
by Oss
05:46
created

Expression::getKeyName()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 2
cts 2
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 1
1
<?php
2
/**
3
 * @category    Brownie/BpmOnline
4
 * @author      Brownie <[email protected]>
5
 * @license     https://opensource.org/licenses/MIT
6
 */
7
8
namespace Brownie\BpmOnline\DataService\Column;
9
10
use Brownie\Util\StorageArray;
11
12
class Expression extends StorageArray
13
{
14
15
    protected $keyName = null;
16
17
    /**
18
     * List of supported fields.
19
     *
20
     * @var array
21
     */
22
    protected $fields = [
23
        'value' => null,
24
    ];
25
26 4
    public function getKeyName()
27
    {
28 4
        return $this->keyName;
29
    }
30
31 6
    public function getValue()
32
    {
33 6
        return parent::getValue();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class Brownie\Util\StorageArray as the method getValue() does only exist in the following sub-classes of Brownie\Util\StorageArray: Brownie\BpmOnline\DataService\Column\Expression, Brownie\BpmOnline\DataSe...n\Expression\ColumnPath, Brownie\BpmOnline\DataSe...pression\ExpressionType, Brownie\BpmOnline\DataSe...mn\Expression\Parameter, Brownie\HttpClient\Cookie\Cookie, Brownie\HttpClient\Header\Header. 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
34
    }
35
}
36