Completed
Push — master ( ea324c...2e8bb7 )
by Andrey
01:33
created

BehaviorAlbum::loadModel()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
rs 10
nc 1
cc 1
nop 1
1
<?php
2
3
namespace Itstructure\MFUploader\behaviors;
4
5
use yii\db\ActiveRecordInterface;
6
use Itstructure\MFUploader\models\OwnerAlbum;
7
use Itstructure\MFUploader\models\album\Album;
8
9
/**
10
 * Class BehaviorAlbum
11
 * BehaviorAlbum class to add, update and remove owners of Album model.
12
 *
13
 * @package Itstructure\MFUploader\behaviors
14
 *
15
 * @author Andrey Girnik <[email protected]>
16
 */
17
class BehaviorAlbum extends Behavior
18
{
19
    /**
20
     * Load Album model by conditions.
21
     *
22
     * @param array $conditions
23
     *
24
     * @return Album|ActiveRecordInterface|null
25
     */
26
    protected function loadModel(array $conditions)
27
    {
28
        return Album::findOne($conditions);
0 ignored issues
show
Bug Best Practice introduced by
The return type of return \Itstructure\MFUp...::findOne($conditions); (array|boolean) is incompatible with the return type declared by the abstract method Itstructure\MFUploader\b...ors\Behavior::loadModel of type Itstructure\MFUploader\m...iveRecordInterface|null.

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...
29
    }
30
31
    /**
32
     * Remove owner of Album model.
33
     *
34
     * @param int    $ownerId
35
     * @param string $owner
36
     * @param string $ownerAttribute
37
     *
38
     * @return bool
39
     */
40
    protected function removeOwner(int $ownerId, string $owner, string $ownerAttribute): bool
41
    {
42
        return OwnerAlbum::removeOwner($ownerId, $owner, $ownerAttribute);
43
    }
44
}
45