Completed
Push — master ( 3c8880...e2c218 )
by Dmitry
06:42 queued 02:46
created

Alert::run()   B

Complexity

Conditions 4
Paths 4

Size

Total Lines 24
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 20

Importance

Changes 0
Metric Value
cc 4
eloc 15
nc 4
nop 0
dl 0
loc 24
ccs 0
cts 21
cp 0
crap 20
rs 8.6845
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * HiPanel core package
5
 *
6
 * @link      https://hipanel.com/
7
 * @package   hipanel-core
8
 * @license   BSD-3-Clause
9
 * @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
10
 */
11
12
namespace hipanel\widgets;
13
14
use hipanel\helpers\ArrayHelper;
15
16
/**
17
 * Alert widget renders a message from session flash. All flash messages are displayed
18
 * in the sequence they were assigned using setFlash. You can set message as following:.
19
 *
20
 * ```php
21
 * \Yii::$app->getSession()->setFlash('error', 'This is the message');
22
 * \Yii::$app->getSession()->setFlash('success', 'This is the message');
23
 * \Yii::$app->getSession()->setFlash('info', 'This is the message');
24
 * ```
25
 *
26
 * Multiple messages could be set as follows:
27
 *
28
 * ```php
29
 * \Yii::$app->getSession()->setFlash('error', ['Error 1', 'Error 2']);
30
 * ```
31
 */
32
class Alert extends \yii\bootstrap\Widget
33
{
34
    /**
35
     * @var array the alert types configuration for the flash messages.
36
     * This array is setup as $key => $value, where:
37
     * - $key is the name of the session flash variable
38
     * - $value is the bootstrap alert type (i.e. danger, success, info, warning)
39
     */
40
    public $alertTypes = [
41
        'error' => 'alert-danger',
42
        'danger' => 'alert-danger',
43
        'success' => 'alert-success',
44
        'info' => 'alert-info',
45
        'warning' => 'alert-warning',
46
    ];
47
48
    /**
49
     * @var array the options for rendering the close button tag.
50
     */
51
    public $closeButton = [];
52
53
    /**
54
     * @param mixed $message Flash value to be normalized
55
     * @return array
56
     */
57
    public function normalizeMessage($message)
58
    {
59
        $res = [];
60
        if (is_string($message)) {
61
            $res['text'] = $message;
62
        } elseif (is_array($message)) {
63
            $res = $message;
64
        }
65
66
        return $res;
67
    }
68
69
    public function run()
70
    {
71
        $session = \Yii::$app->getSession();
0 ignored issues
show
Bug introduced by
The method getSession does only exist in yii\web\Application, but not in yii\console\Application.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
72
        $flashes = $session->getAllFlashes();
73
        $notifications = [];
74
75
        foreach ($flashes as $type => $data) {
76
            if (isset($this->alertTypes[$type])) {
77
                $data = (array) $data;
78
79
                foreach ($data as $message) {
80
                    $message = $this->normalizeMessage($message);
81
                    $notifications[] = ArrayHelper::merge([
82
                        'type' => $type,
83
                    ], $message);
84
                }
85
                $session->removeFlash($type);
86
            }
87
        }
88
89
        echo PNotify::widget([
90
            'notifications' => $notifications,
91
        ]);
92
    }
93
}
94