Refactor News to News/Index & add jsonSerialize()

Author: carlbennett

src/Controllers/News.php renamed to src/Controllers/News/Index.php

@@ -1,10 +1,10 @@
 <?php
 
-namespace BNETDocs\Controllers;
+namespace BNETDocs\Controllers\News;
 
 use \BNETDocs\Libraries\User\User;
 
-class News extends Base
+class Index extends \BNETDocs\Controllers\Base
 {
   public const NEWS_PER_PAGE = 5;
 
@@ -13,7 +13,7 @@ class News extends Base
    */
   public function __construct()
   {
-    $this->model = new \BNETDocs\Models\News();
+    $this->model = new \BNETDocs\Models\News\Index();
   }
 
   /**

src/Libraries/Core/Pagination.php

@@ -4,7 +4,7 @@
 
 use \OutOfBoundsException;
 
-class Pagination
+class Pagination implements \JsonSerializable
 {
   private array $dataset;
   private int $limit;
@@ -43,6 +43,16 @@ public function getPage(): array
     return $set;
   }
 
+  public function jsonSerialize(): mixed
+  {
+    return [
+      'current_page' => $this->currentPage(),
+      'page_count' => $this->pageCount(),
+      'items_per_page' => $this->limit,
+      'page_items' => $this->getPage(),
+    ];
+  }
+
   public function nextPage(): int
   {
     if ($this->page >= $this->pageCount())

src/Models/News.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace BNETDocs\Models\News;
+
+class Index extends \BNETDocs\Models\ActiveUser implements \JsonSerializable
+{
+    public bool $acl_allowed = false;
+    public ?array $news_posts = null;
+    public ?\BNETDocs\Libraries\Core\Pagination $pagination = null;
+
+    public function jsonSerialize(): mixed
+    {
+        return \array_merge(parent::jsonSerialize(), [
+            'acl_allowed' => $this->acl_allowed,
+            'news_posts' => $this->news_posts,
+            'pagination' => $this->pagination,
+        ]);
+    }
+}

src/Models/News/Index.php

@@ -1,5 +1,5 @@
 <?php /* vim: set colorcolumn= expandtab shiftwidth=2 softtabstop=2 tabstop=4 smarttab: */
-namespace BNETDocs\Templates;
+namespace BNETDocs\Templates\News;
 use \BNETDocs\Libraries\User\User;
 use \CarlBennett\MVC\Libraries\Common;
 use \CarlBennett\MVC\Libraries\Pair;

src/Templates/News.phtml renamed to src/Templates/News/Index.phtml

@@ -1,6 +1,6 @@
 <?php
 
-namespace BNETDocs\Templates;
+namespace BNETDocs\Templates\News;
 
 use \CarlBennett\MVC\Libraries\Common;
 

src/Templates/News.rss.phtml renamed to src/Templates/News/Index.rss.phtml

@@ -0,0 +1,17 @@
+<?php
+
+namespace BNETDocs\Views\News;
+
+class IndexHtml extends \BNETDocs\Views\Base\Html
+{
+    public static function invoke(\BNETDocs\Interfaces\Model $model): void
+    {
+        if (!$model instanceof \BNETDocs\Models\News\Index)
+        {
+            throw new \BNETDocs\Exceptions\InvalidModelException($model);
+        }
+
+        (new \BNETDocs\Libraries\Core\Template($model, 'News/Index'))->invoke();
+        $model->_responseHeaders['Content-Type'] = self::mimeType();
+    }
+}

src/Views/News/IndexHtml.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace BNETDocs\Views\News;
+
+class IndexRSS extends \BNETDocs\Views\Base\RSS
+{
+    public static function invoke(\BNETDocs\Interfaces\Model $model): void
+    {
+        if (!$model instanceof \BNETDocs\Models\News\Index)
+        {
+            throw new \BNETDocs\Exceptions\InvalidModelException($model);
+        }
+
+        (new \BNETDocs\Libraries\Core\Template($model, 'News/Index.rss'))->invoke();
+        $model->_responseHeaders['Content-Type'] = self::mimeType();
+    }
+}