init

vendor/yiisoft/yii2/validators/InlineValidator.php

@@ -0,0 +1,91 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\validators;
+
+/**
+ * InlineValidator represents a validator which is defined as a method in the object being validated.
+ *
+ * The validation method must have the following signature:
+ *
+ * ```php
+ * function foo($attribute, $params, $validator)
+ * ```
+ *
+ * where `$attribute` refers to the name of the attribute being validated, while `$params` is an array representing the
+ * additional parameters supplied in the validation rule. Parameter `$validator` refers to the related
+ * [[InlineValidator]] object and is available since version 2.0.11.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @since 2.0
+ */
+class InlineValidator extends Validator
+{
+    /**
+     * @var string|\Closure an anonymous function or the name of a model class method that will be
+     * called to perform the actual validation. The signature of the method should be like the following:
+     *
+     * ```php
+     * function foo($attribute, $params, $validator)
+     * ```
+     *
+     * - `$attribute` is the name of the attribute to be validated;
+     * - `$params` contains the value of [[params]] that you specify when declaring the inline validation rule;
+     * - `$validator` is a reference to related [[InlineValidator]] object. This parameter is available since version 2.0.11.
+     */
+    public $method;
+    /**
+     * @var mixed additional parameters that are passed to the validation method
+     */
+    public $params;
+    /**
+     * @var string|\Closure an anonymous function or the name of a model class method that returns the client validation code.
+     * The signature of the method should be like the following:
+     *
+     * ```php
+     * function foo($attribute, $params, $validator)
+     * {
+     *     return "javascript";
+     * }
+     * ```
+     *
+     * where `$attribute` refers to the attribute name to be validated.
+     *
+     * Please refer to [[clientValidateAttribute()]] for details on how to return client validation code.
+     */
+    public $clientValidate;
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validateAttribute($model, $attribute)
+    {
+        $method = $this->method;
+        if (is_string($method)) {
+            $method = [$model, $method];
+        }
+        call_user_func($method, $attribute, $this->params, $this);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clientValidateAttribute($model, $attribute, $view)
+    {
+        if ($this->clientValidate !== null) {
+            $method = $this->clientValidate;
+            if (is_string($method)) {
+                $method = [$model, $method];
+            }
+
+            return call_user_func($method, $attribute, $this->params, $this);
+        }
+
+        return null;
+    }
+}