feat(view): add ViewData class

Author: szaleq

src/classes/Common/View/View.php

@@ -9,6 +9,8 @@
  */
 class View
 {
+    protected ViewData $data;
+
     /**
      * Constructor.
      *
@@ -17,8 +19,9 @@ class View
      */
     public function __construct(
         protected string $file,
-        protected array $data = []
+        array $data = []
     ) {
+        $this->data = new ViewData($data);
     }
 
     /**
@@ -30,17 +33,21 @@ public function __construct(
      */
     public function with(array $data, bool $override = true): View
     {
-        $this->data = $override ? $data : array_merge($this->data, $data);
+        if ($override) {
+            $this->data->replace($data);
+        } else {
+            $this->data->merge($data);
+        }
 
         return $this;
     }
 
     /**
      * Returns data array.
      *
-     * @return array<string, mixed> View data.
+     * @return ViewData View data.
      */
-    public function getData(): array
+    public function getData(): ViewData
     {
         return $this->data;
     }
@@ -53,7 +60,7 @@ public function getData(): array
      */
     public function render(bool $echo = false): string
     {
-        ViewHelper::pushVariables($this->data);
+        ViewHelper::pushVariables($this->data->getAll());
 
         ob_start();
         include $this->file;

src/classes/Common/View/ViewComposer.php

@@ -18,6 +18,13 @@ abstract class ViewComposer
      */
     protected static ?array $views = null;
 
+    /**
+     * View data instance
+     *
+     * @var ViewData
+     */
+    protected ViewData $viewData;
+
     /**
      * List of views served by this composer
      *
@@ -54,12 +61,12 @@ public static function getViews()
      */
     public function compose(View $view): void
     {
-        $viewData = $view->getData();
+        $this->viewData = $view->getData();
 
         $view->with(
             array_merge(
                 $this->with(),
-                $viewData,
+                $this->viewData->getAll(),
                 $this->override()
             )
         );

src/classes/Common/View/ViewData.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoWStarterTheme\Common\View;
+
+/**
+ * View Data Container.
+ */
+class ViewData
+{
+    /** @var array<string, mixed> */
+    private array $data;
+
+    /**
+     * ViewData constructor.
+     *
+     * @param array<string, mixed> $data Initial data for the view.
+     */
+    public function __construct(array $data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * Get the view data.
+     *
+     * @return array<string, mixed>
+     */
+    public function getAll(): array
+    {
+        return $this->data;
+    }
+
+    /**
+     * Get a specific data item.
+     *
+     * @param string $key     Key of the data item to retrieve.
+     * @param mixed  $default Default value if the key does not exist.
+     * @return mixed|null
+     */
+    public function get(string $key, mixed $default = null): mixed
+    {
+        return $this->data[$key] ?? $default;
+    }
+
+    /**
+     * Set a specific data item.
+     *
+     * @param string $key   Key of the data item to set.
+     * @param mixed  $value Value to set for the key.
+     * @return void
+     */
+    public function set(string $key, mixed $value): void
+    {
+        $this->data[$key] = $value;
+    }
+
+    /**
+     * Merge additional data into the existing data array.
+     *
+     * @param array<string, mixed> $data Data to merge with the existing data.
+     * @return void
+     */
+    public function merge(array $data): void
+    {
+        $this->data = array_merge($this->data, $data);
+    }
+
+    /**
+     * Replace the entire data array with new data.
+     *
+     * @param array<string, mixed> $data New data.
+     * @return void
+     */
+    public function replace(array $data): void
+    {
+        $this->data = $data;
+    }
+}