Merge remote-tracking branch 'upstream/develop' into 4.5

codeigniter4 · Feb 23, 2024 · 4bb6a85 · 4bb6a85
2 parents 650fd1f + 3c5a22e
commit 4bb6a85
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 24 deletions.
diff --git a/system/Commands/Generators/Views/controller.tpl.php b/system/Commands/Generators/Views/controller.tpl.php
@@ -9,7 +9,7 @@ class {class} extends {extends}
 {
 <?php if ($type === 'controller'): ?>
     /**
-     * Return an array of resource objects, themselves in array format
+     * Return an array of resource objects, themselves in array format.
      *
      * @return ResponseInterface
      */
@@ -19,7 +19,9 @@ public function index()
     }
 
     /**
-     * Return the properties of a resource object
+     * Return the properties of a resource object.
+     *
+     * @param int|string|null $id
      *
      * @return ResponseInterface
      */
@@ -29,7 +31,7 @@ public function show($id = null)
     }
 
     /**
-     * Return a new resource object, with default properties
+     * Return a new resource object, with default properties.
      *
      * @return ResponseInterface
      */
@@ -39,7 +41,7 @@ public function new()
     }
 
     /**
-     * Create a new resource object, from "posted" parameters
+     * Create a new resource object, from "posted" parameters.
      *
      * @return ResponseInterface
      */
@@ -49,7 +51,9 @@ public function create()
     }
 
     /**
-     * Return the editable properties of a resource object
+     * Return the editable properties of a resource object.
+     *
+     * @param int|string|null $id
      *
      * @return ResponseInterface
      */
@@ -59,7 +63,9 @@ public function edit($id = null)
     }
 
     /**
-     * Add or update a model resource, from "posted" properties
+     * Add or update a model resource, from "posted" properties.
+     *
+     * @param int|string|null $id
      *
      * @return ResponseInterface
      */
@@ -69,7 +75,9 @@ public function update($id = null)
     }
 
     /**
-     * Delete the designated resource object from the model
+     * Delete the designated resource object from the model.
+     *
+     * @param int|string|null $id
      *
      * @return ResponseInterface
      */
@@ -79,7 +87,7 @@ public function delete($id = null)
     }
 <?php elseif ($type === 'presenter'): ?>
     /**
-     * Present a view of resource objects
+     * Present a view of resource objects.
      *
      * @return ResponseInterface
      */
@@ -89,9 +97,9 @@ public function index()
     }
 
     /**
-     * Present a view to present a specific resource object
+     * Present a view to present a specific resource object.
      *
-     * @param string $id
+     * @param int|string|null $id
      *
      * @return ResponseInterface
      */
@@ -101,9 +109,9 @@ public function show($id = null)
     }
 
     /**
-     * Present a view to present a new single resource object
+     * Present a view to present a new single resource object.
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function new()
     {
@@ -114,19 +122,19 @@ public function new()
      * Process the creation/insertion of a new resource object.
      * This should be a POST.
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function create()
     {
         //
     }
 
     /**
-     * Present a view to edit the properties of a specific resource object
+     * Present a view to edit the properties of a specific resource object.
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function edit($id = null)
     {
@@ -137,33 +145,33 @@ public function edit($id = null)
      * Process the updating, full or partial, of a specific resource object.
      * This should be a POST.
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function update($id = null)
     {
         //
     }
 
     /**
-     * Present a view to confirm the deletion of a specific resource object
+     * Present a view to confirm the deletion of a specific resource object.
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function remove($id = null)
     {
         //
     }
 
     /**
-     * Process the deletion of a specific resource object
+     * Process the deletion of a specific resource object.
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return ResponseInterface
      */
     public function delete($id = null)
     {

diff --git a/user_guide_src/source/installation/upgrade_4xx.rst b/user_guide_src/source/installation/upgrade_4xx.rst
@@ -47,6 +47,15 @@ Namespaces
 Application Structure
 =====================
 
+.. important::
+    **index.php** is no longer in the root of the project! It has been moved inside
+    the **public** folder, for better security and separation of components.
+
+    This means that you should configure your web server to "point" to your project's
+    **public** folder, and not to the project root.
+
+    If you would use Shared Hosting, see :ref:`deployment-to-shared-hosting-services`.
+
 - The **application** folder is renamed as **app** and the framework still has **system** folders,
   with the same interpretation as before.
 - The framework now provides for a **public** folder, intended as the document root for your app.