Fixes #4955: Replaced callbacks with events for `ActiveForm`

framework/CHANGELOG.md

@@ -258,6 +258,9 @@ Yii Framework 2 Change Log
 - Chg #4591: `yii\helpers\Url::to()` will no longer prefix relative URLs with the base URL (qiangxue)
 - Chg #4595: `yii\widgets\LinkPager`'s `nextPageLabel`, `prevPageLabel`, `firstPageLabel`, `lastPageLabel` are now taking `false` instead of `null` for "no label" (samdark)
 - Chg #4911: Changed callback signature used in `yii\base\ArrayableTrait::fields()` from `function ($field, $model) {` to `function ($model, $field) {` (samdark)
+- Chg #4955: Replaced callbacks with events for `ActiveForm` (qiangxue)
+    - Removed `beforeValidate()`, `beforeValidateAll()`, `afterValidate()`, `afterValidateAll()`, `ajaxBeforeSend()` and `ajaxComplete()` from `ActiveForm`.
+    - Added `beforeValidate`, `afterValidate`, `beforeSubmit`, `ajaxBeforeSend` and `ajaxComplete` events to `yii.activeForm`.
 - Chg: Replaced `clearAll()` and `clearAllAssignments()` in `yii\rbac\ManagerInterface` with `removeAll()`, `removeAllRoles()`, `removeAllPermissions()`, `removeAllRules()` and `removeAllAssignments()` (qiangxue)
 - Chg: Added `$user` as the first parameter of `yii\rbac\Rule::execute()` (qiangxue)
 - Chg: `yii\grid\DataColumn::getDataCellValue()` visibility is now `public` to allow accessing the value from a GridView directly (cebe)

framework/UPGRADE.md

@@ -213,3 +213,18 @@ new ones save the following code as `convert.php` that should be placed in the s
 * `Html::radio()`, `Html::checkbox()`, `Html::radioList()`, `Html::checkboxList()` no longer generate the container
   tag around each radio/checkbox when you specify labels for them. You should manually render such container tags,
   or set the `item` option for `Html::radioList()`, `Html::checkboxList()` to generate the container tags.
+
+* `beforeValidate()`, `beforeValidateAll()`, `afterValidate()`, `afterValidateAll()`, `ajaxBeforeSend()` and `ajaxComplete()`
+  are removed from `ActiveForm`. The same functionality is now achieved via JavaScript event mechanism. For example,
+  if you want to do something before performing validation on the client side, you can write the following
+  JavaScript code:
+
+  ```js
+  $('#myform').on('beforeValidate', function (event, messages, deferreds, attribute) {
+      if (attribute === undefined) {
+          // the event is triggered when submitting the form
+      } elseif (attribute.id === 'something') {
+          // the event is triggered before validating "something"
+      }
+  });
+  ```

framework/widgets/ActiveForm.php

@@ -15,7 +15,6 @@ use yii\helpers\ArrayHelper;
 use yii\helpers\Url;
 use yii\helpers\Html;
 use yii\helpers\Json;
-use yii\web\JsExpression;
 
 /**
  * ActiveForm is a widget that builds an interactive HTML form for one or multiple data models.
@@ -146,79 +145,6 @@ class ActiveForm extends Widget
      */
     public $ajaxDataType = 'json';
     /**
-     * @var string|JsExpression a JS callback that will be called when the form is being submitted.
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form) {
-     *     ...return false to cancel submission...
-     * }
-     * ~~~
-     */
-    public $beforeSubmit;
-    /**
-     * @var string|JsExpression a JS callback that is called before validating an attribute.
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, attribute, messages) {
-     *     ...return false to cancel the validation...
-     * }
-     * ~~~
-     */
-    public $beforeValidate;
-    /**
-     * @var string|JsExpression a JS callback that is called before any validation has run (Only called when the form is submitted).
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, data) {
-     *     ...return false to cancel the validation...
-     * }
-     * ~~~
-     */
-    public $beforeValidateAll;
-    /**
-     * @var string|JsExpression a JS callback that is called after validating an attribute.
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, attribute, messages) {
-     * }
-     * ~~~
-     */
-    public $afterValidate;
-    /**
-     * @var string|JsExpression a JS callback that is called after all validation has run (Only called when the form is submitted).
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, data, messages) {
-     * }
-     * ~~~
-     */
-    public $afterValidateAll;
-    /**
-     * @var string|JsExpression a JS pre-request callback function on AJAX-based validation.
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, jqXHR, textStatus) {
-     * }
-     * ~~~
-     */
-    public $ajaxBeforeSend;
-    /**
-     * @var string|JsExpression a JS callback to be called when the request finishes on AJAX-based validation.
-     * The signature of the callback should be:
-     *
-     * ~~~
-     * function ($form, jqXHR, textStatus) {
-     * }
-     * ~~~
-     */
-    public $ajaxComplete;
-    /**
      * @var array the client validation options for individual attributes. Each element of the array
      * represents the validation options for a particular attribute.
      * @internal
@@ -282,11 +208,6 @@ class ActiveForm extends Widget
         if ($this->validationUrl !== null) {
             $options['validationUrl'] = Url::to($this->validationUrl);
         }
-        foreach (['beforeSubmit', 'beforeValidate', 'beforeValidateAll', 'afterValidate', 'afterValidateAll', 'ajaxBeforeSend', 'ajaxComplete'] as $name) {
-            if (($value = $this->$name) !== null) {
-                $options[$name] = $value instanceof JsExpression ? $value : new JsExpression($value);
-            }
-        }
 
         // only get the options that are different from the default ones (set in yii.activeForm.js)
         return array_diff_assoc($options, [

tests/unit/framework/helpers/HtmlTest.php

@@ -140,7 +140,7 @@ class HtmlTest extends TestCase
 
     public function testButton()
     {
-        $this->assertEquals('<button>Button</button>', Html::button());
+        $this->assertEquals('<button type="button">Button</button>', Html::button());
         $this->assertEquals('<button name="test" value="value">content<></button>', Html::button('content<>', ['name' => 'test', 'value' => 'value']));
         $this->assertEquals('<button type="submit" class="t" name="test" value="value">content<></button>', Html::button('content<>', ['type' => 'submit', 'name' => 'test', 'value' => 'value', 'class' => "t"]));
     }