Completed
Push — master ( ffb209...577704 )
by Andrii
05:01
created

AvailableForField::isApplicable()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 4
ccs 0
cts 1
cp 0
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
crap 2
1
<?php
2
3
namespace hiqdev\billing\hiapi\plan;
4
5
use hiapi\query\FieldInterface;
6
use yii\db\Expression;
7
8
class AvailableForField implements FieldInterface
9
{
10
    public $name = 'available_for';
11
12
    public function canBeSelected()
13
    {
14
        return false;
15
    }
16
17
    public function isApplicable($key)
18
    {
19
        return strcasecmp($this->name, $key) === 0;
20
    }
21
22
    /**
23
     * @return string
24
     */
25
    public function getName()
26
    {
27
        return $this->name;
28
    }
29
30
    public function buildCondition($value)
31
    {
32
        if ($value['client_id']) {
33
            $ids_sql = "
34
                SELECT      tariff_id
35
                FROM        client2tariff
36
                WHERE       client_id={$value['client_id']}
37
            ";
38
        } else {
39
            $ids_sql = "
40
                SELECT      dst_id
41
                FROM        tie
42
                WHERE       src_id=client_id('{$value['seller']}')
43
                        AND tag_id=type_id('tariff')
44
            ";
45
        }
46
47
        return new Expression("zt.obj_id IN ($ids_sql)");
0 ignored issues
show
Bug Best Practice introduced by
The return type of return new \yii\db\Expre...j_id IN ({$ids_sql})"); (yii\db\Expression) is incompatible with the return type declared by the interface hiapi\query\FieldInterface::buildCondition of type array.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
48
    }
49
}
50