Merge pull request #6311 from kenjis/fix-type-RESTful-controllers

docs: fix types in PHPDocs in RESTful controllers

Author: kenjis

system/RESTful/ResourceController.php

@@ -12,6 +12,7 @@
 namespace CodeIgniter\RESTful;
 
 use CodeIgniter\API\ResponseTrait;
+use CodeIgniter\HTTP\Response;
 
 /**
  * An extendable controller to provide a RESTful API for a resource.
@@ -23,7 +24,7 @@ class ResourceController extends BaseResource
     /**
      * Return an array of resource objects, themselves in array format
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function index()
     {
@@ -33,9 +34,9 @@ public function index()
     /**
      * Return the properties of a resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function show($id = null)
     {
@@ -45,7 +46,7 @@ public function show($id = null)
     /**
      * Return a new resource object, with default properties
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function new()
     {
@@ -55,7 +56,7 @@ public function new()
     /**
      * Create a new resource object, from "posted" parameters
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function create()
     {
@@ -65,9 +66,9 @@ public function create()
     /**
      * Return the editable properties of a resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function edit($id = null)
     {
@@ -77,9 +78,9 @@ public function edit($id = null)
     /**
      * Add or update a model resource, from "posted" properties
      *
-     * @param mixed $id
+     * @param string|null|int$id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function update($id = null)
     {
@@ -89,9 +90,9 @@ public function update($id = null)
     /**
      * Delete the designated resource object from the model
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function delete($id = null)
     {
@@ -100,6 +101,8 @@ public function delete($id = null)
 
     /**
      * Set/change the expected response representation for returned objects
+     *
+     * @return void
      */
     public function setFormat(string $format = 'json')
     {

system/RESTful/ResourcePresenter.php

@@ -11,6 +11,8 @@
 
 namespace CodeIgniter\RESTful;
 
+use CodeIgniter\HTTP\Response;
+
 /**
  * An extendable controller to help provide a UI for a resource.
  */
@@ -19,7 +21,7 @@ class ResourcePresenter extends BaseResource
     /**
      * Present a view of resource objects
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function index()
     {
@@ -29,9 +31,9 @@ public function index()
     /**
      * Present a view to present a specific resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function show($id = null)
     {
@@ -41,7 +43,7 @@ public function show($id = null)
     /**
      * Present a view to present a new single resource object
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function new()
     {
@@ -52,7 +54,7 @@ public function new()
      * Process the creation/insertion of a new resource object.
      * This should be a POST.
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function create()
     {
@@ -62,9 +64,9 @@ public function create()
     /**
      * Present a view to edit the properties of a specific resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function edit($id = null)
     {
@@ -75,9 +77,9 @@ 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 Response|string|void
      */
     public function update($id = null)
     {
@@ -87,9 +89,9 @@ public function update($id = null)
     /**
      * Present a view to confirm the deletion of a specific resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function remove($id = null)
     {
@@ -99,9 +101,9 @@ public function remove($id = null)
     /**
      * Process the deletion of a specific resource object
      *
-     * @param mixed $id
+     * @param int|string|null $id
      *
-     * @return mixed
+     * @return Response|string|void
      */
     public function delete($id = null)
     {