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

BehaviorMediafile   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 28
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 3

Importance

Changes 0
Metric Value
wmc 2
lcom 0
cbo 3
dl 0
loc 28
c 0
b 0
f 0
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
A loadModel() 0 4 1
A removeOwner() 0 4 1
1
<?php
2
3
namespace Itstructure\MFUploader\behaviors;
4
5
use yii\db\ActiveRecordInterface;
6
use Itstructure\MFUploader\models\{Mediafile, OwnerMediafile};
7
8
/**
9
 * Class BehaviorMediafile
10
 * BehaviorMediafile class to add, update and remove owners of Mediafile model.
11
 *
12
 * @package Itstructure\MFUploader\behaviors
13
 *
14
 * @author Andrey Girnik <[email protected]>
15
 */
16
class BehaviorMediafile extends Behavior
17
{
18
    /**
19
     * Load Mediafile model by conditions.
20
     *
21
     * @param array $conditions
22
     *
23
     * @return Mediafile|ActiveRecordInterface|null
24
     */
25
    protected function loadModel(array $conditions)
26
    {
27
        return Mediafile::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...
28
    }
29
30
    /**
31
     * Remove owner of Mediafile model.
32
     *
33
     * @param int    $ownerId
34
     * @param string $owner
35
     * @param string $ownerAttribute
36
     *
37
     * @return bool
38
     */
39
    protected function removeOwner(int $ownerId, string $owner, string $ownerAttribute): bool
40
    {
41
        return OwnerMediafile::removeOwner($ownerId, $owner, $ownerAttribute);
42
    }
43
}
44