Completed
Push — master ( 6a0311...b415f5 )
by Andrii
07:58
created

BillRepository::split()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 12
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 12

Importance

Changes 0
Metric Value
dl 0
loc 12
ccs 0
cts 10
cp 0
rs 9.4285
c 0
b 0
f 0
cc 3
eloc 7
nc 3
nop 1
crap 12
1
<?php
2
3
namespace hiqdev\billing\hiapi\repositories;
4
5
use DateTime;
6
use hiapi\components\ConnectionInterface;
7
use hiqdev\php\billing\type\Type;
8
use hiqdev\php\billing\customer\Customer;
9
use hiqdev\php\billing\target\Target;
10
use hiqdev\php\billing\bill\BillFactoryInterface;
11
use hiqdev\php\units\Quantity;
12
use Money\Money;
13
14
class BillRepository extends \hiapi\repositories\BaseRepository
15
{
16
    /**
17
     * @var BillFactoryInterface
18
     */
19
    protected $factory;
20
21
    public function __construct(
22
        ConnectionInterface $db,
23
        BillFactoryInterface $factory,
24
        array $config = []
25
    ) {
26
        parent::__construct($config);
27
28
        $this->db = $db;
0 ignored issues
show
Documentation introduced by
The property db does not exist on object<hiqdev\billing\hi...itories\BillRepository>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

Since the property has write access only, you can use the @property-write annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
29
        $this->factory = $factory;
30
    }
31
32
    public function create(array $row)
33
    {
34
        $row = $this->splitDbRawData($row);
0 ignored issues
show
Documentation Bug introduced by
The method splitDbRawData does not exist on object<hiqdev\billing\hi...itories\BillRepository>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
35
        $row['type'] = $this->createEntity(Type::class, $row['type']);
0 ignored issues
show
Documentation Bug introduced by
The method createEntity does not exist on object<hiqdev\billing\hi...itories\BillRepository>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
36
        $row['time'] = new DateTime($row['time']);
37
        $row['quantity'] = Quantity::create('megabyte', $row['quantity']['quantity']);
38
        $row['sum'] = Money::USD($row['sum.amount']);
39
        $row['customer'] = $this->createEntity(Customer::class, $row['customer']);
0 ignored issues
show
Documentation Bug introduced by
The method createEntity does not exist on object<hiqdev\billing\hi...itories\BillRepository>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
40
        $row['target'] = $this->createEntity(Target::class, $row['target']);
0 ignored issues
show
Documentation Bug introduced by
The method createEntity does not exist on object<hiqdev\billing\hi...itories\BillRepository>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
41
42
        return parent::create($row);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class hiapi\repositories\BaseRepository as the method create() does only exist in the following sub-classes of hiapi\repositories\BaseRepository: hiqdev\billing\hiapi\repositories\BillRepository, hiqdev\billing\hiapi\rep...ries\CustomerRepository. 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...
43
    }
44
}
45