Merge pull request #7672 from kenjis/docs-validation-rules

docs: improve Validation

Author: kenjis

user_guide_src/source/installation/upgrade_435.rst

@@ -18,7 +18,20 @@ Breaking Changes
 Validation Placeholders
 =======================
 
-- To use :ref:`validation-placeholders` securely, please remember to create a validation rule for the field you will use as a placeholder.
+To use :ref:`validation-placeholders` securely, please remember to create a validation rule for the field you will use as a placeholder.
+
+E.g., if you have the following code::
+
+    $validation->setRules([
+        'email' => 'required|max_length[254]|valid_email|is_unique[users.email,id,{id}]',
+    ]);
+
+You need to add the rules for ``{id}``::
+
+    $validation->setRules([
+        'id'    => 'max_length[19]|is_natural_no_zero', // Add this
+        'email' => 'required|max_length[254]|valid_email|is_unique[users.email,id,{id}]',
+    ]);
 
 Session::stop()
 ===============

user_guide_src/source/libraries/validation/002.php

@@ -3,10 +3,10 @@
 // ...
 
 $rules = [
-    'username' => 'required',
-    'password' => 'required|min_length[10]',
-    'passconf' => 'required|matches[password]',
-    'email'    => 'required|valid_email',
+    'username' => 'required|max_length[30]',
+    'password' => 'required|max_length[255]|min_length[10]',
+    'passconf' => 'required|max_length[255]|matches[password]',
+    'email'    => 'required|max_length[254]|valid_email',
 ];
 
 // ...

user_guide_src/source/libraries/validation/005.php

@@ -1,4 +1,4 @@
 <?php
 
-$validation->setRule('username', 'Username', 'required|min_length[3]');
-$validation->setRule('password', 'Password', ['required', 'min_length[8]', 'alpha_numeric_punct']);
+$validation->setRule('username', 'Username', 'required|max_length[30]|min_length[3]');
+$validation->setRule('password', 'Password', ['required', 'max_length[255]', 'min_length[8]', 'alpha_numeric_punct']);

user_guide_src/source/libraries/validation/006.php

@@ -1,11 +1,11 @@
 <?php
 
 $validation->setRules([
-    'username' => 'required',
-    'password' => 'required|min_length[10]',
+    'username' => 'required|max_length[30]',
+    'password' => 'required|max_length[255]|min_length[10]',
 ]);
 // or
 $validation->setRules([
-    'username' => 'required',
-    'password' => ['required', 'min_length[10]'],
+    'username' => ['required', 'max_length[30]'],
+    'password' => ['required', 'max_length[255]', 'min_length[10]'],
 ]);

user_guide_src/source/libraries/validation/007.php

@@ -1,11 +1,11 @@
 <?php
 
 $validation->setRules([
-    'username' => ['label' => 'Username', 'rules' => 'required'],
-    'password' => ['label' => 'Password', 'rules' => 'required|min_length[10]'],
+    'username' => ['label' => 'Username', 'rules' => 'required|max_length[30]'],
+    'password' => ['label' => 'Password', 'rules' => 'required|max_length[255]|min_length[10]'],
 ]);
 // or
 $validation->setRules([
-    'username' => ['label' => 'Username', 'rules' => 'required'],
-    'password' => ['label' => 'Password', 'rules' => ['required', 'min_length[10]']],
+    'username' => ['label' => 'Username', 'rules' => 'required|max_length[30]'],
+    'password' => ['label' => 'Password', 'rules' => ['required', '|max_length[255]', 'min_length[10]']],
 ]);

user_guide_src/source/libraries/validation/009.php

@@ -19,10 +19,10 @@
 
 // Joe Smith
 $validation->setRules([
-    'contacts.name' => 'required',
+    'contacts.name' => 'required|max_length[60]',
 ]);
 
 // Fred Flintsone & Wilma
 $validation->setRules([
-    'contacts.friends.name' => 'required',
+    'contacts.friends.name' => 'required|max_length[60]',
 ]);

user_guide_src/source/libraries/validation/010.php

@@ -2,5 +2,5 @@
 
 // Fred Flintsone & Wilma
 $validation->setRules([
-    'contacts.*.name' => 'required',
+    'contacts.*.name' => 'required|max_length[60]',
 ]);

user_guide_src/source/libraries/validation/011.php

@@ -13,5 +13,5 @@
 
 // Rule
 $validation->setRules([
-    'user_ids.*' => 'required',
+    'user_ids.*' => 'required|max_length[19]',
 ]);

user_guide_src/source/libraries/validation/013.php

@@ -5,10 +5,10 @@
 class Validation
 {
     public $signup = [
-        'username'     => 'required',
-        'password'     => 'required',
-        'pass_confirm' => 'required|matches[password]',
-        'email'        => 'required|valid_email',
+        'username'     => 'required|max_length[30]',
+        'password'     => 'required|max_length[255]',
+        'pass_confirm' => 'required|max_length[255]|matches[password]',
+        'email'        => 'required|max_length[254]|valid_email',
     ];
 
     // ...

user_guide_src/source/libraries/validation/015.php

@@ -5,10 +5,10 @@
 class Validation
 {
     public $signup = [
-        'username'     => 'required',
-        'password'     => 'required',
-        'pass_confirm' => 'required|matches[password]',
-        'email'        => 'required|valid_email',
+        'username'     => 'required|max_length[30]',
+        'password'     => 'required|max_length[255]',
+        'pass_confirm' => 'required|max_length[255]|matches[password]',
+        'email'        => 'required|max_length[254]|valid_email',
     ];
 
     public $signup_errors = [