ChargeController   A
last analyzed

Complexity

Total Complexity 4

Size/Duplication

Total Lines 59
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
wmc 4
lcom 1
cbo 3
dl 0
loc 59
ccs 0
cts 34
cp 0
rs 10
c 0
b 0
f 0

4 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 6 1
A behaviors() 0 11 1
A actions() 0 18 1
A getTypesAndGroups() 0 4 1
1
<?php
2
3
/**
4
 * Finance module for HiPanel
5
 *
6
 * @link      https://github.com/hiqdev/hipanel-module-finance
7
 * @package   hipanel-module-finance
8
 * @license   BSD-3-Clause
9
 * @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
10
 */
11
12
namespace hipanel\modules\finance\controllers;
13
14
use hipanel\actions\IndexAction;
15
use hipanel\actions\RenderAction;
16
use hipanel\base\CrudController;
17
use hipanel\filters\EasyAccessControl;
18
use hipanel\modules\finance\models\query\ChargeQuery;
19
use hipanel\modules\finance\providers\BillTypesProvider;
20
use yii\base\Event;
21
22
/**
23
 * Class ChargeController
24
 * @package hipanel\modules\finance\controllers
25
 */
26
class ChargeController extends CrudController
27
{
28
    /**
29
     * @var BillTypesProvider
30
     */
31
    private $billTypesProvider;
32
33
    public function __construct($id, $module, BillTypesProvider $billTypesProvider, $config = [])
34
    {
35
        parent::__construct($id, $module, $config);
36
37
        $this->billTypesProvider = $billTypesProvider;
38
    }
39
40
    /**
41
     * @inheritDoc
42
     */
43
    public function behaviors()
44
    {
45
        return array_merge(parent::behaviors(), [
0 ignored issues
show
Bug Best Practice introduced by
The return type of return array_merge(paren...bill.charges.read')))); (array<*,array>) is incompatible with the return type of the parent method hipanel\base\Controller::behaviors 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...
46
            'access-bill' => [
47
                'class' => EasyAccessControl::class,
48
                'actions' => [
49
                    '*' => 'bill.charges.read',
50
                ],
51
            ],
52
        ]);
53
    }
54
55
    /**
56
     * @inheritDoc
57
     */
58
    public function actions()
59
    {
60
        return array_merge(parent::actions(), [
61
            'index' => [
62
                'class' => IndexAction::class,
63
                'on beforePerform' => function (Event $event) {
64
                    /** @var ChargeQuery $query */
65
                    $query = $event->sender->getDataProvider()->query;
66
                    $query->withCommonObject()->withLatestCommonObject();
67
                },
68
                'data' => function (RenderAction $action, array $data): array {
0 ignored issues
show
Unused Code introduced by
The parameter $action is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $data is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
69
                    [$billTypes, $billGroupLabels] = $this->getTypesAndGroups();
0 ignored issues
show
Bug introduced by
The variable $billTypes does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
Bug introduced by
The variable $billGroupLabels does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
70
71
                    return compact('billTypes', 'billGroupLabels');
72
                },
73
            ],
74
        ]);
75
    }
76
77
    /**
78
     * @return array
79
     */
80
    private function getTypesAndGroups()
81
    {
82
        return $this->billTypesProvider->getGroupedList();
83
    }
84
}
85