Fix various files

Author: paulbalandan

user_guide_src/source/guides/api/code/001.php

@@ -4,12 +4,13 @@
 
 use App\Controllers\BaseController;
 use CodeIgniter\API\ResponseTrait;
+use CodeIgniter\HTTP\ResponseInterface;
 
 class Ping extends BaseController
 {
     use ResponseTrait;
 
-    public function getIndex()
+    public function getIndex(): ResponseInterface
     {
         return $this->respond(['status' => 'ok'], 200);
     }

user_guide_src/source/guides/api/code/002.php

@@ -4,14 +4,13 @@
 
 use App\Controllers\BaseController;
 use CodeIgniter\API\ResponseTrait;
+use CodeIgniter\HTTP\ResponseInterface;
 
 class Ping extends BaseController
 {
     use ResponseTrait;
 
-    protected $format = 'json';
-
-    public function getIndex()
+    public function getIndex(): ResponseInterface
     {
         return $this->respond(['status' => 'ok'], 200);
     }

user_guide_src/source/guides/api/code/003.php

@@ -5,12 +5,13 @@
 use App\Controllers\BaseController;
 use CodeIgniter\API\ResponseTrait;
 use CodeIgniter\CodeIgniter;
+use CodeIgniter\HTTP\ResponseInterface;
 
 class Ping extends BaseController
 {
     use ResponseTrait;
 
-    public function getIndex()
+    public function getIndex(): ResponseInterface
     {
         return $this->respond([
             'status'  => 'ok',

user_guide_src/source/guides/api/code/007.php

@@ -6,7 +6,7 @@
 
 class AuthorModel extends Model
 {
-    protected $table         = 'authors';
+    protected $table         = 'author';
     protected $primaryKey    = 'id';
     protected $allowedFields = ['name'];
     protected $useTimestamps = true;

user_guide_src/source/guides/api/code/008.php

@@ -6,7 +6,7 @@
 
 class BookModel extends Model
 {
-    protected $table         = 'books';
+    protected $table         = 'book';
     protected $primaryKey    = 'id';
     protected $allowedFields = ['title', 'author_id', 'year'];
     protected $useTimestamps = true;

user_guide_src/source/guides/api/code/009.php

@@ -9,8 +9,6 @@ class Books extends BaseController
 {
     use ResponseTrait;
 
-    protected $format = 'json';
-
     /**
      * List one or many resources
      * GET /api/books

user_guide_src/source/guides/api/code/012.php

@@ -5,20 +5,19 @@
 use App\Controllers\BaseController;
 use App\Transformers\BookTransformer;
 use CodeIgniter\Api\ResponseTrait;
+use CodeIgniter\HTTP\ResponseInterface;
 
 class Books extends BaseController
 {
     use ResponseTrait;
 
-    protected $format = 'json';
-
     /**
      * List one or many resources
      * GET /api/books
      *    and
      * GET /api/books/{id}
      */
-    public function getIndex(?int $id = null)
+    public function getIndex(?int $id = null): ResponseInterface
     {
         $model       = model('BookModel');
         $transformer = new BookTransformer();
@@ -45,10 +44,9 @@ public function getIndex(?int $id = null)
      *
      * PUT /api/books/{id}
      */
-    public function putIndex(int $id)
+    public function putIndex(int $id): ResponseInterface
     {
-        $data  = $this->request->getRawInput();
-        $model = model('BookModel');
+        $data = $this->request->getRawInput();
 
         $rules = [
             'title'     => 'required|string|max_length[255]',
@@ -78,7 +76,7 @@ public function putIndex(int $id)
      *
      * POST /api/books
      */
-    public function postIndex()
+    public function postIndex(): ResponseInterface
     {
         $data = $this->request->getPost();
 
@@ -105,7 +103,7 @@ public function postIndex()
      *
      * DELETE /api/books/{id}
      */
-    public function deleteIndex(int $id)
+    public function deleteIndex(int $id): ResponseInterface
     {
         $model = model('BookModel');
 

user_guide_src/source/guides/api/code/013.php

@@ -6,16 +6,17 @@
 
 class BookModel extends Model
 {
-    protected string $table        = 'book';
-    protected array $allowedFields = ['title', 'author_id', 'year'];
+    protected $table         = 'book';
+    protected $allowedFields = ['title', 'author_id', 'year'];
 
     /**
      * Include author_id and author_name
      * in the results.
      */
     public function withAuthorInfo()
     {
-        return $this->select('books.*, authors.id as author_id, authors.name as author_name')
-            ->join('authors', 'books.author_id = authors.id');
+        return $this
+            ->select('book.*, author.id as author_id, author.name as author_name')
+            ->join('author', 'book.author_id = author.id');
     }
 }

user_guide_src/source/guides/api/code/014.php

@@ -8,7 +8,8 @@ class BookModel extends Model
 {
     public function withAuthorInfo()
     {
-        return $this->select('books.*, authors.name as author_name')
-            ->join('authors', 'books.author_id = authors.id');
+        return $this
+            ->select('book.*, author.name as author_name')
+            ->join('author', 'book.author_id = author.id');
     }
 }

user_guide_src/source/guides/api/conclusion.rst

@@ -1,6 +1,6 @@
 Conclusion
 ==========
 
-This guide provided an overview of using CodeIgniter 4 to build a simple RESTful API for managing books and authors. You learned how to set up a CodeIgniter project, configure a database, create models, and implement API endpoints using controllers and auto-routing, along with the ResponseTrait for consistent API responses.
+This guide provided an overview of using CodeIgniter4 to build a simple RESTful API for managing books and authors. You learned how to set up a CodeIgniter project, configure a database, create models, and implement API endpoints using controllers and auto-routing, along with the ``ResponseTrait`` for consistent API responses.
 
 From here, you can expand your API by adding more resources, implementing authentication and authorization using `CodeIgniter Shield <https://shield.codeigniter.com/>`__, and exploring advanced features like :doc:`../../libraries/throttler`, :doc:`../../incoming/controller_attributes`, and :doc:`../../general/caching`. CodeIgniter's flexibility and powerful features make it an excellent choice for building robust APIs.