Merge pull request #7028 from kenjis/fix-docs-upgrade_xxx

docs: update Upgrading from 3.x to 4.x Libraries

Author: kenjis

user_guide_src/source/installation/upgrade_configuration.rst

@@ -15,6 +15,8 @@ What has been changed
 =====================
 
 - In CI4, the configurations are now stored in classes which extend ``CodeIgniter\Config\BaseConfig``.
+- The **application/config/config.php** in CI3 will be **app/Config/App.php**
+  and some other files like **app/Config/Security.php** for the specific classes.
 - Within the configuration class, the config values are stored in public class properties.
 - The method to fetch config values has been changed.
 
@@ -30,21 +32,21 @@ Upgrade Guide
    from the CI3 config into the new CI4 config class as public class properties.
 4. Now, you have to change the config fetching syntax everywhere you fetch config
    values. The CI3 syntax is something like ``$this->config->item('item_name');``.
-   You have to change this into ``config('MyConfigFile')->item_name;``.
+   You have to change this into ``config('MyConfig')->item_name;``.
 
 Code Example
 ============
 
 CodeIgniter Version 3.x
 ------------------------
 
-Path: **application/config**:
+Path: **application/config/site.php**:
 
 .. literalinclude:: upgrade_configuration/ci3sample/001.php
 
 CodeIgniter Version 4.x
 -----------------------
 
-Path: **app/Config**:
+Path: **app/Config/Site.php**:
 
 .. literalinclude:: upgrade_configuration/001.php

user_guide_src/source/installation/upgrade_configuration/001.php

@@ -4,7 +4,7 @@
 
 use CodeIgniter\Config\BaseConfig;
 
-class CustomClass extends BaseConfig
+class Site extends BaseConfig
 {
     public $siteName  = 'My Great Site';
     public $siteEmail = 'webmaster@example.com';

user_guide_src/source/installation/upgrade_database.rst

@@ -14,7 +14,8 @@ Documentations
 What has been changed
 =====================
 - The functionality in CI3 is basically the same as in CI4.
-- The method names have changed to camelCase and the query builder now needs to be initialized before you can run queries on it.
+- The method names have changed to camelCase and the :doc:`Query Builder <../database/query_builder>`
+  now needs to be initialized before you can run queries on it.
 
 Upgrade Guide
 =============

user_guide_src/source/installation/upgrade_file_upload/001.php

@@ -12,9 +12,13 @@ public function index()
     public function do_upload()
     {
         $this->validate([
-            'userfile' => 'uploaded[userfile]|max_size[userfile,100]'
-                           . '|mime_in[userfile,image/png,image/jpg,image/gif]'
-                           . '|ext_in[userfile,png,jpg,gif]|max_dims[userfile,1024,768]',
+            'userfile' => [
+                'uploaded[userfile]',
+                'max_size[userfile,100]',
+                'mime_in[userfile,image/png,image/jpg,image/gif]',
+                'ext_in[userfile,png,jpg,gif]',
+                'max_dims[userfile,1024,768]',
+            ],
         ]);
 
         $file = $this->request->getFile('userfile');

user_guide_src/source/installation/upgrade_responses.rst

@@ -17,7 +17,7 @@ What has been changed
 Upgrade Guide
 =============
 1. The methods in the HTTP Responses class are named slightly different. The most important change in the naming is the switch from underscored method names to camelCase. The method ``set_content_type()`` from version 3 is now named ``setContentType()`` and so on.
-2. In the most cases you have to change ``$this->output`` to ``$this->response`` followed by the method. You can find all methods :doc:`here </outgoing/response>`.
+2. In the most cases you have to change ``$this->output`` to ``$this->response`` followed by the method. You can find all methods in :doc:`../outgoing/response`.
 
 Code Example
 ============

user_guide_src/source/installation/upgrade_security.rst

@@ -12,11 +12,11 @@ Documentations
 - :doc:`Security Documentation CodeIgniter 4.X </libraries/security>`
 
 .. note::
-    If you use the :doc:`form helper </helpers/form_helper>` and enable the CSRF filter globally, then ``form_open()`` will automatically insert a hidden CSRF field in your forms. So you do not have to upgrade this by yourself.
+    If you use the :doc:`../helpers/form_helper` and enable the CSRF filter globally, then :php:func:`form_open()` will automatically insert a hidden CSRF field in your forms. So you do not have to upgrade this by yourself.
 
 What has been changed
 =====================
-- The method to implement CSRF tokens to html forms has been changed.
+- The method to implement CSRF tokens to HTML forms has been changed.
 
 Upgrade Guide
 =============

user_guide_src/source/installation/upgrade_security/001.php

@@ -14,5 +14,6 @@ class Filters extends BaseConfig
             'csrf',
         ],
     ];
+
     // ...
 }

user_guide_src/source/installation/upgrade_sessions/001.php

@@ -2,7 +2,7 @@
 
 $session = session();
 
-$_SESSION['item'];
+$_SESSION['item'];  // But we do not recommend to use superglobal directly.
 $session->get('item');
 $session->item;
 session('item');

user_guide_src/source/installation/upgrade_validations.rst

@@ -13,7 +13,7 @@ Documentations of Library
 
 What has been changed
 =====================
-- If you want to change validation error display, you have to set CI4 validation View templates.
+- If you want to change validation error display, you have to set CI4 :ref:`validation View templates <validation-customizing-error-display>`.
 - CI4 validation has no Callbacks nor Callable in CI3.
 - CI4 validation format rules do not permit empty string.
 - CI4 validation never changes your data.
@@ -29,7 +29,7 @@ Upgrade Guide
     - ``$this->load->helper(array('form', 'url'));`` to ``helper(['form', 'url']);``
     - remove the line ``$this->load->library('form_validation');``
     - ``if ($this->form_validation->run() == FALSE)`` to ``if (! $this->validate([]))``
-    - ``$this->load->view('myform');`` to ``echo view('myform', ['validation' => $this->validator,]);``
+    - ``$this->load->view('myform');`` to ``return view('myform', ['validation' => $this->validator,]);``
 
 3. You have to change the validation rules. The new syntax is to set the rules as array in the controller:
 

user_guide_src/source/installation/upgrade_validations/002.php

@@ -13,11 +13,11 @@ public function index()
         if (! $this->validate([
             // Validation rules
         ])) {
-            echo view('myform', [
+            return view('myform', [
                 'validation' => $this->validator,
             ]);
-        } else {
-            echo view('formsuccess');
         }
+
+        return view('formsuccess');
     }
 }