Issues in Alert.php - All Issues - Inspection of "Refactoring" - Dominus77/yii2-sweetalert2-widget - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d98ee...89135c )

by Alexey

created 2018-01-15 15:47 UTC

Alert.php (2 issues)

Labels

Severity

Major 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace dominus77\sweetalert2;

use Yii;
use yii\bootstrap\Widget;
use yii\helpers\Json;
use yii\helpers\ArrayHelper;
use dominus77\sweetalert2\assets\SweetAlert2Asset;
use dominus77\sweetalert2\assets\AnimateCssAsset;

/**
 * Alert widget renders a message from session flash or custom messages.
 * @package dominus77\sweetalert2
 */
class Alert extends Widget
{
    //modal type
    const TYPE_INFO = 'info';
    const TYPE_ERROR = 'error';
    const TYPE_SUCCESS = 'success';
    const TYPE_WARNING = 'warning';
    const TYPE_QUESTION = 'question';
    //input type
    const INPUT_TYPE_TEXT = 'text';
    const INPUT_TYPE_EMAIL = 'email';
    const INPUT_TYPE_PASSWORD = 'password';
    const INPUT_TYPE_NUMBER = 'number';
    const INPUT_TYPE_RANGE = 'range';
    const INPUT_TYPE_TEXTAREA = 'textarea';
    const INPUT_TYPE_SELECT = 'select';
    const INPUT_TYPE_RADIO = 'radio';
    const INPUT_TYPE_CHECKBOX = 'checkbox';
    const INPUT_TYPE_FILE = 'file';

    /**
     * All the flash messages stored for the session are displayed and removed from the session
     * Defaults to false.
     * @var bool
     */
    public $useSessionFlash = false;

    /**
     * @var string alert callback
     */
    public $callback = 'function() {}';

    /**
     * Initializes the widget
     */
    public function init()
    {
        parent::init();
        $this->registerAssets();
    }

    /**
     * @return string|void
     */
    public function run()
    {
        if ($this->useSessionFlash) {
            if($session = $this->getSession()) {
                $flashes = $session->getAllFlashes();
                $steps = [];
                foreach ($flashes as $type => $data) {
                    $data = (array)$data;
                    foreach ($data as $message) {
                        array_push($steps, ['type' => $type, 'text' => $message]);
                    }
                    $session->removeFlash($type);
                }
                if (!empty($steps)) {
                    if (!is_array($steps[0]['text'])) {
                        $this->initSwalQueue($steps);
                    } else {
                        $steps[0]['text']['type'] = isset($steps[0]['text']['type']) ? $steps[0]['text']['type'] : $steps[0]['type'];
                        if (isset($steps[0]['text']['animation']) && $steps[0]['text']['animation'] == false) {
                            if (isset($steps[0]['text']['customClass'])) {
                                $this->registerAnimate();
                            }
                        }
                        $this->options = $steps[0]['text'];
                        $this->callback = isset($steps[1]['text']['callback']) ? $steps[1]['text']['callback'] : $this->callback;
                        $this->initSwal($this->getOptions(), $this->callback);
                    }
                }
            }
        } else {
            $this->initSwal($this->getOptions(), $this->callback);
        }
    }

    /**
     * Get widget options
     *
     * @return string
     */
    public function getOptions()
    {
        if (isset($this->options['id']))
            unset($this->options['id']);

        if (ArrayHelper::isIndexed($this->options)) {
            $str = '';
            foreach ($this->options as $value) {
                $str .= '"' . $value . '",';
            }
            return chop($str, ' ,');
        }
        return Json::encode($this->options);
    }

    /**
     * @param array $steps
     */
    protected function initSwalQueue($steps = [])
    {
        $view = $this->getView();
        $js = "swal.queue(" . Json::encode($steps) . ");";
        $this->view->registerJs($js, $view::POS_END);
    }

    /**
     * @param string $options
     * @param string $callback
     */
    protected function initSwal($options = '', $callback = '')
    {
        $view = $this->getView();
        $js = "swal({$options}).then({$callback}).catch(swal.noop);";
        $this->view->registerJs($js, $view::POS_END);
    }

    /**
     * Register Animate Assets
     */
    protected function registerAnimate()
    {
        AnimateCssAsset::register($this->view);
    }

    /**
     * Register client assets
     */
    protected function registerAssets()
    {
        SweetAlert2Asset::register($this->view);
        if (isset($this->options['animation']) && $this->options['animation'] == false) {
            if (isset($this->options['customClass'])) {
                $this->registerAnimate();
            }
        }
    }

    /**
     * @return \yii\web\Session
     */
    private function getSession()
    {
        if($session = Yii::$app->getSession()) {
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.
}
            return $session;
        }
        return false;
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());
}
    }
}


1		<?php
2
3		namespace dominus77\sweetalert2;
4
5		use Yii;
6		use yii\bootstrap\Widget;
7		use yii\helpers\Json;
8		use yii\helpers\ArrayHelper;
9		use dominus77\sweetalert2\assets\SweetAlert2Asset;
10		use dominus77\sweetalert2\assets\AnimateCssAsset;
11
12		/**
13		* Alert widget renders a message from session flash or custom messages.
14		* @package dominus77\sweetalert2
15		*/
16		class Alert extends Widget
17		{
18		//modal type
19		const TYPE_INFO = 'info';
20		const TYPE_ERROR = 'error';
21		const TYPE_SUCCESS = 'success';
22		const TYPE_WARNING = 'warning';
23		const TYPE_QUESTION = 'question';
24		//input type
25		const INPUT_TYPE_TEXT = 'text';
26		const INPUT_TYPE_EMAIL = 'email';
27		const INPUT_TYPE_PASSWORD = 'password';
28		const INPUT_TYPE_NUMBER = 'number';
29		const INPUT_TYPE_RANGE = 'range';
30		const INPUT_TYPE_TEXTAREA = 'textarea';
31		const INPUT_TYPE_SELECT = 'select';
32		const INPUT_TYPE_RADIO = 'radio';
33		const INPUT_TYPE_CHECKBOX = 'checkbox';
34		const INPUT_TYPE_FILE = 'file';
35
36		/**
37		* All the flash messages stored for the session are displayed and removed from the session
38		* Defaults to false.
39		* @var bool
40		*/
41		public $useSessionFlash = false;
42
43		/**
44		* @var string alert callback
45		*/
46		public $callback = 'function() {}';
47
48		/**
49		* Initializes the widget
50		*/
51	4	public function init()
52		{
53	4	parent::init();
54	4	$this->registerAssets();
55	4	}
56
57		/**
58		* @return string\|void
59		*/
60	3	public function run()
61		{
62	3	if ($this->useSessionFlash) {
63	2	if($session = $this->getSession()) {
64	2	$flashes = $session->getAllFlashes();
65	2	$steps = [];
66	2	foreach ($flashes as $type => $data) {
67		$data = (array)$data;
68		foreach ($data as $message) {
69		array_push($steps, ['type' => $type, 'text' => $message]);
70		}
71		$session->removeFlash($type);
72		}
73	2	if (!empty($steps)) {
74		if (!is_array($steps[0]['text'])) {
75		$this->initSwalQueue($steps);
76		} else {
77		$steps[0]['text']['type'] = isset($steps[0]['text']['type']) ? $steps[0]['text']['type'] : $steps[0]['type'];
78		if (isset($steps[0]['text']['animation']) && $steps[0]['text']['animation'] == false) {
79		if (isset($steps[0]['text']['customClass'])) {
80		$this->registerAnimate();
81		}
82		}
83		$this->options = $steps[0]['text'];
84		$this->callback = isset($steps[1]['text']['callback']) ? $steps[1]['text']['callback'] : $this->callback;
85	2	$this->initSwal($this->getOptions(), $this->callback);
86		}
87		}
88		}
89		} else {
90	1	$this->initSwal($this->getOptions(), $this->callback);
91		}
92	3	}
93
94		/**
95		* Get widget options
96		*
97		* @return string
98		*/
99	2	public function getOptions()
100		{
101	2	if (isset($this->options['id']))
102	2	unset($this->options['id']);
103
104	2	if (ArrayHelper::isIndexed($this->options)) {
105	1	$str = '';
106	1	foreach ($this->options as $value) {
107	1	$str .= '"' . $value . '",';
108		}
109	1	return chop($str, ' ,');
110		}
111	1	return Json::encode($this->options);
112		}
113
114		/**
115		* @param array $steps
116		*/
117		protected function initSwalQueue($steps = [])
118		{
119		$view = $this->getView();
120		$js = "swal.queue(" . Json::encode($steps) . ");";
121		$this->view->registerJs($js, $view::POS_END);
122		}
123
124		/**
125		* @param string $options
126		* @param string $callback
127		*/
128	1	protected function initSwal($options = '', $callback = '')
129		{
130	1	$view = $this->getView();
131	1	$js = "swal({$options}).then({$callback}).catch(swal.noop);";
132	1	$this->view->registerJs($js, $view::POS_END);
133	1	}
134
135		/**
136		* Register Animate Assets
137		*/
138	1	protected function registerAnimate()
139		{
140	1	AnimateCssAsset::register($this->view);
141	1	}
142
143		/**
144		* Register client assets
145		*/
146	4	protected function registerAssets()
147		{
148	4	SweetAlert2Asset::register($this->view);
149	4	if (isset($this->options['animation']) && $this->options['animation'] == false) {
150	1	if (isset($this->options['customClass'])) {
151	1	$this->registerAnimate();
152		}
153		}
154	4	}
155
156		/**
157		* @return \yii\web\Session
158		*/
159	2	private function getSession()
160		{
161	2	if($session = Yii::$app->getSession()) {
		0 ignored issues – show Bug introduced 2018-01-15 08:46 UTC by Report Bug Copy Issue Report Show Similar Issues like this 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 Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
162	2	return $session;
163		}
164		return false;
		0 ignored issues – show Bug Best Practice introduced 2018-01-15 15:54 UTC by Report Bug Copy Issue Report Show Similar Issues like this The return type of `return false;` (`false`) is incompatible with the return type documented by `dominus77\sweetalert2\Alert::getSession` of type `yii\web\Session`. 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...
165		}
166		}
167

Dominus77 / yii2-sweetalert2-widget

Push — master ( 6d98ee...89135c )

Alert.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like