AjaxModal::setActionUrl() - Code Metrics - Inspection of "minor" - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3c8880...e2c218 )

by Dmitry

created 2016-06-24 08:17 UTC

AjaxModal::setActionUrl() A

↳ Parent: AjaxModal

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	4
cp	0
crap	2

<?php

/*
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\widgets;

use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\helpers\Url;
use yii\web\JsExpression;

/**
 * Class AjaxModal.
 *
 * @property $actionUrl string URL
 * @property $modalFormId string ID for modal form
 * @property $errorText string The error text for PNotify generation. On set will be processed through [[Yii::t()]]
 * @property $successText string The success text for PNotify generation. On set will be processed through [[Yii::t()]]
 * @property $loadingText string The text that will be displayed on submit button after press. On set will be processed through [[Yii::t()]]
 * @property $loadingHtml string The HTML to be appended to the modal body
 */
class AjaxModal extends \yii\bootstrap\Modal
{
    /**
     * @var bool
     */
    public $bulkPage = false;

    /**
     * @var bool
     */
    public $usePost = false;

    /**
     * @var string
     */
    public $scenario;

    /**
     * @var string URL
     */
    protected $_actionUrl;

    /**
     * @var string ID for modal form
     */
    protected $_modalFormId;

    /**
     * @var string The error text for PNotify generation.
     * On set will be processed through [[Yii::t()]]
     */
    protected $_errorText;

    /**
     * @var string The success text for PNotify generation.
     * On set will be processed through [[Yii::t()]]
     */
    protected $_successText;

    /**
     * @var string The text that will be displayed on submit button after press.
     * On set will be processed through [[Yii::t()]]
     */
    protected $_loadingText;

    /**
     * @var boolean whether to handle the submit of the form in the modal with special AJAX script
     * @see registerClientScript
     */
    public $handleSubmit = true;

    public function getActionUrl()
    {
        return $this->_actionUrl ? Url::to($this->_actionUrl) : Url::to($this->scenario);
    }

    public function setActionUrl($url)
    {
        $this->_actionUrl = $url;
    }

    public function getModalFormId()
    {
        return $this->_modalFormId ?: $this->scenario . '-form';
    }

    public function setModalFormId($id)
    {
        $this->_modalFormId = $id;
    }

    public function getErrorText()
    {
        return $this->_errorText ?: Yii::t('app', 'An error occurred. Try again later.');
    }

    public function setErrorText($text)
    {
        $this->_errorText = Yii::t('app', $text);
    }

    public function getSuccessText()
    {
        return $this->_successText ?: Yii::t('app', 'Settings saved');
    }

    public function setSuccessText($text)
    {
        $this->_successText = Yii::t('app', $text);
    }

    public function getLoadingText()
    {
        return $this->_loadingText ?: Yii::t('app', 'loading') . '...';
    }

    public function setLoadingText($text)
    {
        $this->_loadingText = Yii::t('app', $text);
    }

    public function init()
    {
        if (!$this->scenario) {
            throw new InvalidConfigException("Attribute 'scenario' is required");
        }

        Html::addCssClass($this->options['class'], 'text-left');

        $this->initAdditionalOptions();
        if ($this->handleSubmit !== false) {
            $this->registerClientScript();
        }
        parent::init();
    }

    protected function initAdditionalOptions()
    {
        $quotedHtml = Json::htmlEncode($this->loadingHtml);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        if (!isset($this->clientEvents['show.bs.modal'])) {
            if ($this->bulkPage) {
                if ($this->usePost) {

                    $this->clientEvents['show.bs.modal'] = new JsExpression("function() {
                        var selection = jQuery('div[role=\"grid\"]').yiiGridView('getSelectedRows');
                        $.post('{$this->actionUrl}', {selection: selection}).done(function (data) {

                            $('#{$this->id} .modal-body').html(data);
                        });
                    }");
                } else {
                    $this->clientEvents['show.bs.modal'] = new JsExpression("function() {
                        var selection = jQuery('div[role=\"grid\"]').yiiGridView('getSelectedRows');
                        $.get('{$this->actionUrl}', {selection: selection}).done(function (data) {

                            $('#{$this->id} .modal-body').html(data);
                        });
                    }");
                }
            } else {

                if ($this->usePost) {
                    $this->clientEvents['show.bs.modal'] = new JsExpression("function() {
                        $.post('{$this->actionUrl}').done(function (data) {

                            $('#{$this->id} .modal-body').html(data);
                        });
                    }");
                } else {
                    $this->clientEvents['show.bs.modal'] = new JsExpression("function() {
                        $.get('{$this->actionUrl}').done(function (data) {

                            $('#{$this->id} .modal-body').html(data);
                        });
                    }");
                }
            }
        }
        if (!isset($this->clientEvents['hidden.bs.modal'])) {
            $this->clientEvents['hidden.bs.modal'] = new JsExpression("function() {
                jQuery('#{$this->id} .modal-body').html({$quotedHtml});
            }");
        }
    }

    protected function registerClientScript()
    {
        $url = is_string($this->handleSubmit) ? $this->handleSubmit : $this->actionUrl;

        Yii::$app->view->registerJs(<<<JS
            jQuery(document).on('submit', '#{$this->modalFormId}', function(event) {

                event.preventDefault();
                var form = jQuery(this);
                var btn = jQuery('form[data-pjax] button').button('{$this->loadingText}');

                jQuery.ajax({
                    url: '$url',
                    type: 'POST',
                    timeout: 0,
                    data: form.serialize(),
                    error: function() {
                        new PNotify({
                            text: "{$this->errorText}",

                            type: 'error',
                            buttons: {
                                sticker: false
                            },
                            icon: false
                        });
                    },
                    success: function() {
                        jQuery('#$this->id').modal('hide');
                        new PNotify({
                            text: "{$this->successText}",

                            type: 'info',
                            buttons: {
                                sticker: false
                            },
                            icon: false
                        });
                        btn.button('reset');
                    }
                });
            });
JS
        );
    }

    public function getLoadingHtml()
    {
        return <<<HTML
        <div class="progress">
            <div class="progress-bar progress-bar-striped active" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%">
                <span class="sr-only">{$this->loadingText}</span>

            </div>
        </div>
HTML;
    }

    /**
     * {@inheritdoc}
     */
    protected function renderBodyBegin()
    {
        return Html::beginTag('div', ['class' => 'modal-body']) . $this->loadingHtml;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * {@inheritdoc}
     */
    protected function registerClientEvents()
    {
        if (!empty($this->clientEvents)) {
            foreach ($this->clientEvents as $event => $handler) {
                if ($handler instanceof \Closure) {
                    $this->clientEvents[$event] = call_user_func($handler, $this);
                }
            }
        }

        parent::registerClientEvents();
    }
}


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 Yii;
15		use yii\base\InvalidConfigException;
16		use yii\helpers\Html;
17		use yii\helpers\Json;
18		use yii\helpers\Url;
19		use yii\web\JsExpression;
20
21		/**
22		* Class AjaxModal.
23		*
24		* @property $actionUrl string URL
25		* @property $modalFormId string ID for modal form
26		* @property $errorText string The error text for PNotify generation. On set will be processed through [[Yii::t()]]
27		* @property $successText string The success text for PNotify generation. On set will be processed through [[Yii::t()]]
28		* @property $loadingText string The text that will be displayed on submit button after press. On set will be processed through [[Yii::t()]]
29		* @property $loadingHtml string The HTML to be appended to the modal body
30		*/
31		class AjaxModal extends \yii\bootstrap\Modal
32		{
33		/**
34		* @var bool
35		*/
36		public $bulkPage = false;
37
38		/**
39		* @var bool
40		*/
41		public $usePost = false;
42
43		/**
44		* @var string
45		*/
46		public $scenario;
47
48		/**
49		* @var string URL
50		*/
51		protected $_actionUrl;
52
53		/**
54		* @var string ID for modal form
55		*/
56		protected $_modalFormId;
57
58		/**
59		* @var string The error text for PNotify generation.
60		* On set will be processed through [[Yii::t()]]
61		*/
62		protected $_errorText;
63
64		/**
65		* @var string The success text for PNotify generation.
66		* On set will be processed through [[Yii::t()]]
67		*/
68		protected $_successText;
69
70		/**
71		* @var string The text that will be displayed on submit button after press.
72		* On set will be processed through [[Yii::t()]]
73		*/
74		protected $_loadingText;
75
76		/**
77		* @var boolean whether to handle the submit of the form in the modal with special AJAX script
78		* @see registerClientScript
79		*/
80		public $handleSubmit = true;
81
82		public function getActionUrl()
83		{
84		return $this->_actionUrl ? Url::to($this->_actionUrl) : Url::to($this->scenario);
85		}
86
87		public function setActionUrl($url)
88		{
89		$this->_actionUrl = $url;
90		}
91
92		public function getModalFormId()
93		{
94		return $this->_modalFormId ?: $this->scenario . '-form';
95		}
96
97		public function setModalFormId($id)
98		{
99		$this->_modalFormId = $id;
100		}
101
102		public function getErrorText()
103		{
104		return $this->_errorText ?: Yii::t('app', 'An error occurred. Try again later.');
105		}
106
107		public function setErrorText($text)
108		{
109		$this->_errorText = Yii::t('app', $text);
110		}
111
112		public function getSuccessText()
113		{
114		return $this->_successText ?: Yii::t('app', 'Settings saved');
115		}
116
117		public function setSuccessText($text)
118		{
119		$this->_successText = Yii::t('app', $text);
120		}
121
122		public function getLoadingText()
123		{
124		return $this->_loadingText ?: Yii::t('app', 'loading') . '...';
125		}
126
127		public function setLoadingText($text)
128		{
129		$this->_loadingText = Yii::t('app', $text);
130		}
131
132		public function init()
133		{
134		if (!$this->scenario) {
135		throw new InvalidConfigException("Attribute 'scenario' is required");
136		}
137
138		Html::addCssClass($this->options['class'], 'text-left');
139
140		$this->initAdditionalOptions();
141		if ($this->handleSubmit !== false) {
142		$this->registerClientScript();
143		}
144		parent::init();
145		}
146
147		protected function initAdditionalOptions()
148		{
149		$quotedHtml = Json::htmlEncode($this->loadingHtml);
		0 ignored issues – show Documentation introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `loadingHtml` does not exist on `object<hipanel\widgets\AjaxModal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
150		if (!isset($this->clientEvents['show.bs.modal'])) {
151		if ($this->bulkPage) {
152	View Code Duplication	if ($this->usePost) {
		0 ignored issues – show Duplication introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
153		$this->clientEvents['show.bs.modal'] = new JsExpression("function() {
154		var selection = jQuery('div[role=\"grid\"]').yiiGridView('getSelectedRows');
155		$.post('{$this->actionUrl}', {selection: selection}).done(function (data) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `actionUrl` does not seem to exist. Did you mean `_actionUrl`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
156		$('#{$this->id} .modal-body').html(data);
157		});
158		}");
159		} else {
160		$this->clientEvents['show.bs.modal'] = new JsExpression("function() {
161		var selection = jQuery('div[role=\"grid\"]').yiiGridView('getSelectedRows');
162		$.get('{$this->actionUrl}', {selection: selection}).done(function (data) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `actionUrl` does not seem to exist. Did you mean `_actionUrl`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
163		$('#{$this->id} .modal-body').html(data);
164		});
165		}");
166		}
167	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
168		if ($this->usePost) {
169		$this->clientEvents['show.bs.modal'] = new JsExpression("function() {
170		$.post('{$this->actionUrl}').done(function (data) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `actionUrl` does not seem to exist. Did you mean `_actionUrl`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
171		$('#{$this->id} .modal-body').html(data);
172		});
173		}");
174		} else {
175		$this->clientEvents['show.bs.modal'] = new JsExpression("function() {
176		$.get('{$this->actionUrl}').done(function (data) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `actionUrl` does not seem to exist. Did you mean `_actionUrl`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
177		$('#{$this->id} .modal-body').html(data);
178		});
179		}");
180		}
181		}
182		}
183		if (!isset($this->clientEvents['hidden.bs.modal'])) {
184		$this->clientEvents['hidden.bs.modal'] = new JsExpression("function() {
185		jQuery('#{$this->id} .modal-body').html({$quotedHtml});
186		}");
187		}
188		}
189
190		protected function registerClientScript()
191		{
192		$url = is_string($this->handleSubmit) ? $this->handleSubmit : $this->actionUrl;
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `actionUrl` does not seem to exist. Did you mean `_actionUrl`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
193		Yii::$app->view->registerJs(<<<JS
194		jQuery(document).on('submit', '#{$this->modalFormId}', function(event) {
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `modalFormId` does not seem to exist. Did you mean `_modalFormId`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
195		event.preventDefault();
196		var form = jQuery(this);
197		var btn = jQuery('form[data-pjax] button').button('{$this->loadingText}');
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `loadingText` does not seem to exist. Did you mean `_loadingText`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
198		jQuery.ajax({
199		url: '$url',
200		type: 'POST',
201		timeout: 0,
202		data: form.serialize(),
203		error: function() {
204		new PNotify({
205		text: "{$this->errorText}",
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `errorText` does not seem to exist. Did you mean `_errorText`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
206		type: 'error',
207		buttons: {
208		sticker: false
209		},
210		icon: false
211		});
212		},
213		success: function() {
214		jQuery('#$this->id').modal('hide');
215		new PNotify({
216		text: "{$this->successText}",
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `successText` does not seem to exist. Did you mean `_successText`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
217		type: 'info',
218		buttons: {
219		sticker: false
220		},
221		icon: false
222		});
223		btn.button('reset');
224		}
225		});
226		});
227		JS
228		);
229		}
230
231		public function getLoadingHtml()
232		{
233		return <<<HTML
234		<div class="progress">
235		<div class="progress-bar progress-bar-striped active" role="progressbar" aria-valuenow="100" aria-valuemin="0" aria-valuemax="100" style="width: 100%">
236		<span class="sr-only">{$this->loadingText}</span>
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `loadingText` does not seem to exist. Did you mean `_loadingText`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
237		</div>
238		</div>
239		HTML;
240		}
241
242		/**
243		* {@inheritdoc}
244		*/
245		protected function renderBodyBegin()
246		{
247		return Html::beginTag('div', ['class' => 'modal-body']) . $this->loadingHtml;
		0 ignored issues – show Documentation introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report The property `loadingHtml` does not exist on `object<hipanel\widgets\AjaxModal>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
248		}
249
250		/**
251		* {@inheritdoc}
252		*/
253		protected function registerClientEvents()
254		{
255		if (!empty($this->clientEvents)) {
256		foreach ($this->clientEvents as $event => $handler) {
257		if ($handler instanceof \Closure) {
258		$this->clientEvents[$event] = call_user_func($handler, $this);
259		}
260		}
261		}
262
263		parent::registerClientEvents();
264		}
265		}
266

hiqdev / hipanel-core

Push — master ( 3c8880...e2c218 )

AjaxModal::setActionUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like