Make validator getClientOptions public

This allows implementing custom client-side validation
without extending every validator.

Fixes #11163
close #13145

docs/guide/input-validation.md

@@ -897,7 +897,7 @@ the former will take precedence.
 > - to extend or customize to fit your specific needs:
 >
 > ```php
-> protected function getClientOptions($model, $attribute)
+> public function getClientOptions($model, $attribute)
 > {
 >     $options = parent::getClientOptions($model, $attribute);
 >     // Modify $options here

framework/CHANGELOG.md

@@ -37,7 +37,7 @@ Yii Framework 2 Change Log
 - Enh #9162: Added support of closures in `value` for attributes in `yii\widgets\DetailView` (arogachev)
 - Enh #10896: Select only primary key when counting records in UniqueValidator (developeruz)
 - Enh #11037: `yii.js` and `yii.validation.js` use `Regexp.test()` instead of `String.match()` (arogachev, nkovacs)
-- Enh #11163: Added separate method for client-side validation options in `yii\validators\Validator` (arogachev)
+- Enh #11163: Added separate method for client-side validation options `yii\validators\Validator::getClientOptions()` (arogachev)
 - Enh #11756: Added type mapping for `varbinary` data type in MySQL DBMS (silverfire)
 - Enh #11929: Changed `type` column type from `int` to `smallInt` in RBAC migrations (silverfire)
 - Enh #12015: Changed visibility `yii\db\ActiveQueryTrait::createModels()` from private to protected (ArekX, dynasource)

framework/UPGRADE.md

@@ -57,6 +57,9 @@ Upgrade from Yii 2.0.10
   This method is implemented in the `yii\db\QueryTrait`, so this only affects your code if you implement QueryInterface
   in a class that does not use the trait.
 
+* `yii\validators\FileValidator::getClientOptions()` and `yii\validators\ImageValidator::getClientOptions()` are now public.
+  If you extend from these classes and override these methods, you must make them public as well.
+
 Upgrade from Yii 2.0.9
 ----------------------
 

framework/captcha/CaptchaValidator.php

@@ -95,7 +95,7 @@ class CaptchaValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $captcha = $this->createCaptchaAction();
         $code = $captcha->getVerifyCode(false);

framework/validators/BooleanValidator.php

@@ -79,7 +79,7 @@ class BooleanValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = [
             'trueValue' => $this->trueValue,

framework/validators/CompareValidator.php

@@ -234,7 +234,7 @@ class CompareValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = [
             'operator' => $this->operator,

framework/validators/EmailValidator.php

@@ -121,7 +121,7 @@ class EmailValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = [
             'pattern' => new JsExpression($this->pattern),

framework/validators/FileValidator.php

@@ -386,7 +386,7 @@ class FileValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $label = $model->getAttributeLabel($attribute);
 

framework/validators/FilterValidator.php

@@ -97,7 +97,7 @@ class FilterValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = [];
         if ($this->skipOnEmpty) {

framework/validators/ImageValidator.php

@@ -172,7 +172,7 @@ class ImageValidator extends FileValidator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = parent::getClientOptions($model, $attribute);
 

framework/validators/IpValidator.php

@@ -597,7 +597,7 @@ class IpValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $messages = [
             'ipv6NotAllowed' => $this->ipv6NotAllowed,

framework/validators/NumberValidator.php

@@ -130,7 +130,7 @@ class NumberValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $label = $model->getAttributeLabel($attribute);
 

framework/validators/RangeValidator.php

@@ -117,7 +117,7 @@ class RangeValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $range = [];
         foreach ($this->range as $value) {

framework/validators/RegularExpressionValidator.php

@@ -74,7 +74,7 @@ class RegularExpressionValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $pattern = Html::escapeJsRegularExpression($this->pattern);
 

framework/validators/RequiredValidator.php

@@ -97,7 +97,7 @@ class RequiredValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $options = [];
         if ($this->requiredValue !== null) {

framework/validators/StringValidator.php

@@ -159,7 +159,7 @@ class StringValidator extends Validator
         return 'yii.validation.string(value, messages, ' . json_encode($options, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . ');';
     }
 
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         $label = $model->getAttributeLabel($attribute);
 

framework/validators/UrlValidator.php

@@ -125,7 +125,7 @@ class UrlValidator extends Validator
     /**
      * @inheritdoc
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         if (strpos($this->pattern, '{schemes}') !== false) {
             $pattern = str_replace('{schemes}', '(' . implode('|', $this->validSchemes) . ')', $this->pattern);

framework/validators/Validator.php

@@ -372,7 +372,7 @@ class Validator extends Component
      * @return array the client-side validation options
      * @since 2.0.11
      */
-    protected function getClientOptions($model, $attribute)
+    public function getClientOptions($model, $attribute)
     {
         return [];
     }