Fix #8452 Jquery Extraction (attempt 2)

framework/UPGRADE.md

@@ -137,6 +137,23 @@ Upgrade from Yii 2.0.x
   If you are using `yii\web\Request::resolve()` or `yii\web\UrlManager::parseRequest()` directly, make sure that
   all potential exceptions are handled correctly or set `yii\web\UrlNormalizer::$normalizer` to `false` to disable normalizer.
 * `yii\base\InvalidParamException` was renamed to `yii\base\InvalidArgumentException`.
+* Classes `yii\widgets\ActiveForm`, `yii\widgets\ActiveField`, `yii\grid\GridView`, `yii\web\View` have been refactored
+  to be more generic without including any 'JQuery' support and client-side processing (validation, automatic submit etc.).
+  You should use widget behaviors from `yii\jquery\*` package to make old code function as before. E.g. attach `yii\jquery\ActiveFormClientScript`
+  to `yii\widgets\ActiveForm`, `yii\jquery\GridViewClientScript` to `yii\grid\GridView` and so on.
+* Fields `$enableClientScript` and `$attributes` have been removed from `yii\widgets\ActiveForm`. Make sure
+  you do not use them or specify them during `ActiveForm::begin()` invocation.
+* Field `yii\grid\GridView::$filterSelector` has been removed. Make sure you do not use it or specify it during
+  `GridView::widget()` invocation. Use `yii\jquery\GridViewClientScript::$filterSelector` instead.
+* Method `getClientOptions()` has been removed from `yii\validators\Validator` and all its descendants.
+  All implementations of `clientValidateAttribute()` around built-in validators now return `null`.
+  Use classes from `yii\jquery\validators\client\*` for building client validation (JavaScript) code.
+* Assets `yii\web\JqueryAsset`, `yii\web\YiiAsset`, `yii\validators\ValidationAsset` have been moved under `yii\jquery\*`
+  namespace. Make sure you refer to the new full-qualified names of this classes.
+* Methods `yii\validators\Validator::formatMessage()`, `yii\validators\IpValidator::getIpParsePattern()` and
+  `yii\validators\FileValidator::buildMimeTypeRegexp()` have been made `public`. Make sure you use correct
+  access level specification in case you override these methods.
+* Default script position for the `yii\web\View::registerJs()` changed to `View::POS_END`.
 
 
 Upgrade from Yii 2.0.13

framework/captcha/CaptchaAsset.php

@@ -8,7 +8,7 @@
 namespace yii\captcha;
 
 use yii\web\AssetBundle;
-use yii\web\YiiAsset;
+use yii\jquery\YiiAsset;
 
 /**
  * This asset bundle provides the javascript files needed for the [[Captcha]] widget.
@@ -21,13 +21,11 @@ class CaptchaAsset extends AssetBundle
     /**
      * @inheritdoc
      */
-    public $sourcePath = '@yii/assets';
-
+    public $sourcePath = '@yii/captcha/assets';
     /**
      * @inheritdoc
      */
     public $js = ['yii.captcha.js',];
-
     /**
      * @inheritdoc
      */

framework/grid/GridView.php

@@ -12,8 +12,6 @@
 use yii\base\InvalidConfigException;
 use yii\base\Model;
 use yii\helpers\Html;
-use yii\helpers\Json;
-use yii\helpers\Url;
 use yii\i18n\Formatter;
 use yii\widgets\BaseListView;
 
@@ -215,10 +213,6 @@ class GridView extends BaseListView
      * as GET parameters to this URL.
      */
     public $filterUrl;
-    /**
-     * @var string additional jQuery selector for selecting filter input fields
-     */
-    public $filterSelector;
     /**
      * @var string whether the filters should be displayed in the grid view. Valid values include:
      *
@@ -278,20 +272,6 @@ public function init()
         $this->initColumns();
     }
 
-    /**
-     * Runs the widget.
-     */
-    public function run()
-    {
-        $id = $this->options['id'];
-        $options = Json::htmlEncode($this->getClientOptions());
-        $view = $this->getView();
-        GridViewAsset::register($view);
-        $view->registerJs("jQuery('#$id').yiiGridView($options);");
-
-        return parent::run();
-    }
-
     /**
      * Renders validator errors of filter model.
      * @return string the rendering result.
@@ -318,25 +298,6 @@ public function renderSection($name)
         }
     }
 
-    /**
-     * Returns the options for the grid view JS widget.
-     * @return array the options
-     */
-    protected function getClientOptions()
-    {
-        $filterUrl = isset($this->filterUrl) ? $this->filterUrl : Yii::$app->request->url;
-        $id = $this->filterRowOptions['id'];
-        $filterSelector = "#$id input, #$id select";
-        if (isset($this->filterSelector)) {
-            $filterSelector .= ', ' . $this->filterSelector;
-        }
-
-        return [
-            'filterUrl' => Url::to($filterUrl),
-            'filterSelector' => $filterSelector,
-        ];
-    }
-
     /**
      * Renders the data models for the grid view.
      */

framework/widgets/ActiveFormAsset.php → framework/jquery/ActiveFormAsset.php

@@ -5,10 +5,9 @@
  * @license http://www.yiiframework.com/license/
  */
 
-namespace yii\widgets;
+namespace yii\jquery;
 
 use yii\web\AssetBundle;
-use yii\web\YiiAsset;
 
 /**
  * The asset bundle for the [[ActiveForm]] widget.
@@ -21,13 +20,11 @@ class ActiveFormAsset extends AssetBundle
     /**
      * @inheritdoc
      */
-    public $sourcePath = '@yii/assets';
-
+    public $sourcePath = '@yii/jquery/assets';
     /**
      * @inheritdoc
      */
     public $js = ['yii.activeForm.js'];
-
     /**
      * @inheritdoc
      */

framework/jquery/ActiveFormClientScript.php

@@ -0,0 +1,113 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\jquery;
+
+use Yii;
+use yii\helpers\Json;
+
+/**
+ * ActiveFormClientScript is a behavior for [[\yii\widgets\ActiveForm]], which allows composition
+ * of the client-side and AJAX form validation via underlying JQuery plugin.
+ *
+ * Usage example:
+ *
+ * ```php
+ * <?php $form = \yii\widgets\ActiveForm::begin([
+ *     'id' => 'example-form',
+ *     'as clientScript' => \yii\jquery\ActiveFormClientScript::class,
+ *     // ...
+ * ]); ?>
+ * ...
+ * <?php \yii\widgets\ActiveForm::end(); ?>
+ * ```
+ *
+ * @see \yii\widgets\ActiveForm
+ * @see \yii\widgets\ActiveFormClientScriptBehavior
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.1.0
+ */
+class ActiveFormClientScript extends \yii\widgets\ActiveFormClientScript
+{
+    /**
+     * {@inheritdoc}
+     */
+    protected function defaultClientValidatorMap()
+    {
+        return [
+            \yii\validators\BooleanValidator::class => \yii\jquery\validators\client\BooleanValidator::class,
+            \yii\validators\CompareValidator::class => \yii\jquery\validators\client\CompareValidator::class,
+            \yii\validators\EmailValidator::class => \yii\jquery\validators\client\EmailValidator::class,
+            \yii\validators\FilterValidator::class => \yii\jquery\validators\client\FilterValidator::class,
+            \yii\validators\IpValidator::class => \yii\jquery\validators\client\IpValidator::class,
+            \yii\validators\NumberValidator::class => \yii\jquery\validators\client\NumberValidator::class,
+            \yii\validators\RangeValidator::class => \yii\jquery\validators\client\RangeValidator::class,
+            \yii\validators\RegularExpressionValidator::class => \yii\jquery\validators\client\RegularExpressionValidator::class,
+            \yii\validators\RequiredValidator::class => \yii\jquery\validators\client\RequiredValidator::class,
+            \yii\validators\StringValidator::class => \yii\jquery\validators\client\StringValidator::class,
+            \yii\validators\UrlValidator::class => \yii\jquery\validators\client\UrlValidator::class,
+            \yii\validators\ImageValidator::class => \yii\jquery\validators\client\ImageValidator::class,
+            \yii\validators\FileValidator::class => \yii\jquery\validators\client\FileValidator::class,
+            \yii\captcha\CaptchaValidator::class => \yii\jquery\validators\client\CaptchaClientValidator::class,
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function registerClientScript()
+    {
+        $id = $this->owner->options['id'];
+        $options = Json::htmlEncode($this->getClientOptions());
+        $attributes = Json::htmlEncode($this->attributes);
+        $view = $this->owner->getView();
+        ActiveFormAsset::register($view);
+        $view->registerJs("jQuery('#$id').yiiActiveForm($attributes, $options);");
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getFieldClientOptions($field)
+    {
+        $options = parent::getFieldClientOptions($field);
+
+        // only get the options that are different from the default ones (set in yii.activeForm.js)
+        return array_diff_assoc($options, [
+            'validateOnChange' => true,
+            'validateOnBlur' => true,
+            'validateOnType' => false,
+            'validationDelay' => 500,
+            'encodeError' => true,
+            'error' => '.help-block',
+            'updateAriaInvalid' => true,
+        ]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getClientOptions()
+    {
+        $options = parent::getClientOptions();
+
+        // only get the options that are different from the default ones (set in yii.activeForm.js)
+        return array_diff_assoc($options, [
+            'encodeErrorSummary' => true,
+            'errorSummary' => '.error-summary',
+            'validateOnSubmit' => true,
+            'errorCssClass' => 'has-error',
+            'successCssClass' => 'has-success',
+            'validatingCssClass' => 'validating',
+            'ajaxParam' => 'ajax',
+            'ajaxDataType' => 'json',
+            'scrollToError' => true,
+            'scrollToErrorOffset' => 0,
+        ]);
+    }
+}

framework/grid/GridViewAsset.php → framework/jquery/GridViewAsset.php

@@ -5,10 +5,9 @@
  * @license http://www.yiiframework.com/license/
  */
 
-namespace yii\grid;
+namespace yii\jquery;
 
 use yii\web\AssetBundle;
-use yii\web\YiiAsset;
 
 /**
  * This asset bundle provides the javascript files for the [[GridView]] widget.
@@ -21,13 +20,11 @@ class GridViewAsset extends AssetBundle
     /**
      * @inheritdoc
      */
-    public $sourcePath = '@yii/assets';
-
+    public $sourcePath = '@yii/jquery/assets';
     /**
      * @inheritdoc
      */
     public $js = ['yii.gridView.js'];
-
     /**
      * @inheritdoc
      */

framework/jquery/GridViewClientScript.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\jquery;
+
+use Yii;
+use yii\base\Behavior;
+use yii\base\Widget;
+use yii\helpers\Json;
+use yii\helpers\Url;
+
+/**
+ * GridViewClientScript is a behavior for [[\yii\grid\GridView]] widget, which allows automatic filter submission via jQuery component.
+ *
+ * A basic usage looks like the following:
+ *
+ * ```php
+ * <?= yii\grid\GridView::widget([
+ *     'dataProvider' => $dataProvider,
+ *     'as clientScript' => [
+ *         'class' => yii\jquery\GridViewClientScript::class
+ *     ],
+ *     'columns' => [
+ *         'id',
+ *         'name',
+ *         'created_at:datetime',
+ *         // ...
+ *     ],
+ * ]) ?>
+ * ```
+ *
+ * @see \yii\grid\GridView
+ * @see GridViewAsset
+ *
+ * @property \yii\grid\GridView $owner the owner of this behavior.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.1.0
+ */
+class GridViewClientScript extends Behavior
+{
+    /**
+     * @var string additional jQuery selector for selecting filter input fields.
+     */
+    public $filterSelector;
+
+
+    /**
+     * @inheritdoc
+     */
+    public function events()
+    {
+        return [
+            Widget::EVENT_BEFORE_RUN => 'beforeRun'
+        ];
+    }
+
+    /**
+     * Handles [[Widget::EVENT_BEFORE_RUN]] event, registering related client script.
+     * @param \yii\base\Event $event event instance.
+     */
+    public function beforeRun($event)
+    {
+        $id = $this->owner->options['id'];
+        $options = Json::htmlEncode($this->getClientOptions());
+        $view = $this->owner->getView();
+        GridViewAsset::register($view);
+        $view->registerJs("jQuery('#$id').yiiGridView($options);");
+    }
+
+    /**
+     * Returns the options for the grid view JS widget.
+     * @return array the options
+     */
+    protected function getClientOptions()
+    {
+        $filterUrl = isset($this->owner->filterUrl) ? $this->owner->filterUrl : Yii::$app->request->url;
+        $id = $this->owner->filterRowOptions['id'];
+        $filterSelector = "#$id input, #$id select";
+        if (isset($this->filterSelector)) {
+            $filterSelector .= ', ' . $this->filterSelector;
+        }
+
+        return [
+            'filterUrl' => Url::to($filterUrl),
+            'filterSelector' => $filterSelector,
+        ];
+    }
+}

framework/web/JqueryAsset.php → framework/jquery/JqueryAsset.php

@@ -5,7 +5,9 @@
  * @license http://www.yiiframework.com/license/
  */
 
-namespace yii\web;
+namespace yii\jquery;
+
+use yii\web\AssetBundle;
 
 /**
  * This asset bundle provides the [jQuery](http://jquery.com/) JavaScript library.

framework/validators/PunycodeAsset.php → framework/jquery/PunycodeAsset.php

@@ -5,7 +5,7 @@
  * @license http://www.yiiframework.com/license/
  */
 
-namespace yii\validators;
+namespace yii\jquery;
 
 use yii\web\AssetBundle;