Merge pull request #7209 from kenjis/docs-improve-validation

docs: update validation.rst

Author: kenjis

user_guide_src/source/libraries/validation.rst

@@ -603,13 +603,13 @@ shown above. The primary benefit here is that it provides some extra navigation
 Creating a Rule Class
 ---------------------
 
-Within the file itself, each method is a rule and must accept a string as the first parameter, and must return
+Within the file itself, each method is a rule and must accept a value to validate as the first parameter, and must return
 a boolean true or false value signifying true if it passed the test or false if it did not:
 
 .. literalinclude:: validation/034.php
 
 By default, the system will look within ``CodeIgniter\Language\en\Validation.php`` for the language strings used
-within errors. In custom rules, you may provide error messages by accepting a ``$error`` variable by reference in the
+within errors. In custom rules, you may provide error messages by accepting a ``&$error`` variable by reference in the
 second parameter:
 
 .. literalinclude:: validation/035.php
@@ -624,13 +624,13 @@ Your new custom rule could now be used just like any other rule:
 Allowing Parameters
 -------------------
 
-If your method needs to work with parameters, the function will need a minimum of three parameters: the string to validate,
+If your method needs to work with parameters, the function will need a minimum of three parameters: the value to validate,
 the parameter string, and an array with all of the data that was submitted the form. The ``$data`` array is especially handy
 for rules like ``required_with`` that needs to check the value of another submitted field to base its result on:
 
 .. literalinclude:: validation/037.php
 
-Custom errors can be returned as the fourth parameter, just as described above.
+Custom errors can be returned as the fourth parameter ``&$error``, just as described above.
 
 .. _validation-using-closure-rule:
 

user_guide_src/source/libraries/validation/034.php

@@ -2,8 +2,8 @@
 
 class MyRules
 {
-    public function even(string $str): bool
+    public function even($value): bool
     {
-        return (int) $str % 2 === 0;
+        return (int) $value % 2 === 0;
     }
 }

user_guide_src/source/libraries/validation/035.php

@@ -2,9 +2,9 @@
 
 class MyRules
 {
-    public function even(string $str, ?string &$error = null): bool
+    public function even($value, ?string &$error = null): bool
     {
-        if ((int) $str % 2 !== 0) {
+        if ((int) $value % 2 !== 0) {
             $error = lang('myerrors.evenError');
 
             return false;

user_guide_src/source/libraries/validation/037.php

@@ -2,14 +2,14 @@
 
 class MyRules
 {
-    public function required_with($str, string $fields, array $data): bool
+    public function required_with($value, string $params, array $data): bool
     {
-        $fields = explode(',', $fields);
+        $params = explode(',', $params);
 
         // If the field is present we can safely assume that
         // the field is here, no matter whether the corresponding
         // search field is present or not.
-        $present = $this->required($str ?? '');
+        $present = $this->required($value ?? '');
 
         if ($present) {
             return true;
@@ -20,7 +20,7 @@ public function required_with($str, string $fields, array $data): bool
         // as $fields is the lis
         $requiredFields = [];
 
-        foreach ($fields as $field) {
+        foreach ($params as $field) {
             if (array_key_exists($field, $data)) {
                 $requiredFields[] = $field;
             }