Applying code suggestions

Co-authored-by: John Paul E. Balandan, CPA <paulbalandan@gmail.com>
Co-authored-by: michalsn <michal@sniatala.pl>

Author: 3 people

system/Config/Services.php

@@ -872,10 +872,8 @@ public static function typography(bool $getShared = true)
 
     /**
      * The Context class provides a way to store and retrieve static data throughout requests.
-     *
-     * @return Context
      */
-    public static function context(bool $getShared = true)
+    public static function context(bool $getShared = true): Context
     {
         if ($getShared) {
             return static::getSharedInstance('context');

system/Context/Context.php

@@ -14,26 +14,25 @@
 namespace CodeIgniter\Context;
 
 use CodeIgniter\Helpers\Array\ArrayHelper;
+use SensitiveParameter;
+use SensitiveParameterValue;
 
-class Context
+final class Context
 {
     /**
      * The data stored in the context.
      *
      * @var array<string, mixed>
      */
-    protected array $data;
+    private array $data;
 
     /**
-     * The data that is stored, but not included in logs.
+     * The data that is stored but not included in logs.
      *
      * @var array<string, mixed>
      */
     private array $hiddenData;
 
-    /**
-     * Constructor
-     */
     public function __construct()
     {
         $this->data       = [];
@@ -42,6 +41,7 @@ public function __construct()
 
     /**
      * Set a key-value pair to the context.
+     * Supports dot notation for nested arrays.
      *
      * @param array<string, mixed>|string $key   The key to identify the data. Can be a string or an array of key-value pairs.
      * @param mixed                       $value The value to be stored in the context.
@@ -51,43 +51,48 @@ public function __construct()
     public function set(array|string $key, mixed $value = null): self
     {
         if (is_array($key)) {
-            $this->data = array_merge($this->data, $key);
+            foreach ($key as $k => $v) {
+                ArrayHelper::dotSet($this->data, $k, $v);
+            }
 
             return $this;
         }
 
-        $this->data[$key] = $value;
+        ArrayHelper::dotSet($this->data, $key, $value);
 
         return $this;
     }
 
     /**
      * Set a hidden key-value pair to the context. This data will not be included in logs.
+     * Supports dot notation for nested arrays.
      *
      * @param array<string, mixed>|string $key   The key to identify the data. Can be a string or an array of key-value pairs.
      * @param mixed                       $value The value to be stored in the context.
      *
      * @return $this
      */
-    public function setHidden(array|string $key, mixed $value = null): self
+    public function setHidden(#[SensitiveParameter] array|string $key, #[SensitiveParameter] mixed $value = null): self
     {
         if (is_array($key)) {
-            $this->hiddenData = array_merge($this->hiddenData, $key);
+            foreach ($key as $k => $v) {
+                ArrayHelper::dotSet($this->hiddenData, $k, $v);
+            }
 
             return $this;
         }
 
-        $this->hiddenData[$key] = $value;
+        ArrayHelper::dotSet($this->hiddenData, $key, $value);
 
         return $this;
     }
 
     /**
      * Get a value from the context by its key, or return a default value if the key does not exist.
-     * Supports dot notation for nested arrays (e.g., 'user.profile.name' to access $data['user']['profile']['name']).
+     * Supports dot notation for nested arrays.
      *
-     * @param string     $key     The key to identify the data.
-     * @param mixed|null $default The default value to return if the key does not exist in the context.
+     * @param string $key     The key to identify the data.
+     * @param mixed  $default The default value to return if the key does not exist in the context.
      *
      * @return mixed The value associated with the key, or the default value if the key does not exist.
      */
@@ -98,34 +103,28 @@ public function get(string $key, mixed $default = null): mixed
 
     /**
      * Get only the specified keys from the context. If a key does not exist, it will be ignored.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $keys An array of keys to retrieve from the context.
      *
      * @return array<string, mixed> An array of key-value pairs for the specified keys that exist in the context.
      */
     public function getOnly(array|string $keys): array
     {
-        if (is_string($keys)) {
-            $keys = [$keys];
-        }
-
-        return array_filter($this->data, static fn ($k): bool => in_array($k, $keys, true), ARRAY_FILTER_USE_KEY);
+        return ArrayHelper::dotOnly($this->data, $keys);
     }
 
     /**
      * Get all keys from the context except the specified keys.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $keys An array of keys to exclude from the context.
      *
      * @return array<string, mixed> An array of key-value pairs for all keys in the context except the specified keys.
      */
     public function getExcept(array|string $keys): array
     {
-        if (is_string($keys)) {
-            $keys = [$keys];
-        }
-
-        return array_filter($this->data, static fn ($k): bool => ! in_array($k, $keys, true), ARRAY_FILTER_USE_KEY);
+        return ArrayHelper::dotExcept($this->data, $keys);
     }
 
     /**
@@ -140,47 +139,42 @@ public function getAll(): array
 
     /**
      * Get a hidden value from the context by its key, or return a default value if the key does not exist.
+     * Supports dot notation for nested arrays.
      *
      * @param string     $key     The key to identify the data.
      * @param mixed|null $default The default value to return if the key does not exist in the context.
      *
      * @return mixed The value associated with the key, or the default value if the key does not exist.
      */
-    public function getHidden(string $key, mixed $default = null): mixed
+    public function getHidden(#[SensitiveParameter] string $key, #[SensitiveParameter] mixed $default = null): mixed
     {
         return ArrayHelper::dotSearch($key, $this->hiddenData) ?? $default;
     }
 
     /**
      * Get only the specified keys from the hidden context. If a key does not exist, it will be ignored.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $keys An array of keys to retrieve from the hidden context.
      *
      * @return array<string, mixed> An array of key-value pairs for the specified keys that exist in the hidden context.
      */
-    public function getOnlyHidden(array|string $keys): array
+    public function getOnlyHidden(#[SensitiveParameter] array|string $keys): array
     {
-        if (is_string($keys)) {
-            $keys = [$keys];
-        }
-
-        return array_filter($this->hiddenData, static fn ($k): bool => in_array($k, $keys, true), ARRAY_FILTER_USE_KEY);
+        return ArrayHelper::dotOnly($this->hiddenData, $keys);
     }
 
     /**
      * Get all keys from the hidden context except the specified keys.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $keys An array of keys to exclude from the hidden context.
      *
      * @return array<string, mixed> An array of key-value pairs for all keys in the hidden context except the specified keys.
      */
-    public function getExceptHidden(array|string $keys): array
+    public function getExceptHidden(#[SensitiveParameter] array|string $keys): array
     {
-        if (is_string($keys)) {
-            $keys = [$keys];
-        }
-
-        return array_filter($this->hiddenData, static fn ($k): bool => ! in_array($k, $keys, true), ARRAY_FILTER_USE_KEY);
+        return ArrayHelper::dotExcept($this->hiddenData, $keys);
     }
 
     /**
@@ -195,30 +189,33 @@ public function getAllHidden(): array
 
     /**
      * Check if a key exists in the context.
+     * Supports dot notation for nested arrays.
      *
      * @param string $key The key to check for existence in the context.
      *
      * @return bool True if the key exists in the context, false otherwise.
      */
     public function has(string $key): bool
     {
-        return ArrayHelper::dotKeyExists($key, $this->data);
+        return ArrayHelper::dotHas($key, $this->data);
     }
 
     /**
      * Check if a key exists in the hidden context.
+     * Supports dot notation for nested arrays.
      *
      * @param string $key The key to check for existence in the hidden context.
      *
      * @return bool True if the key exists in the hidden context, false otherwise.
      */
     public function hasHidden(string $key): bool
     {
-        return ArrayHelper::dotKeyExists($key, $this->hiddenData);
+        return ArrayHelper::dotHas($key, $this->hiddenData);
     }
 
     /**
      * Remove a key-value pair from the context by its key.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $key The key to identify the data to be removed from the context.
      *
@@ -228,35 +225,36 @@ public function remove(array|string $key): self
     {
         if (is_array($key)) {
             foreach ($key as $k) {
-                unset($this->data[$k]);
+                ArrayHelper::dotUnset($this->data, $k);
             }
 
             return $this;
         }
 
-        unset($this->data[$key]);
+        ArrayHelper::dotUnset($this->data, $key);
 
         return $this;
     }
 
     /**
      * Remove a key-value pair from the hidden context by its key.
+     * Supports dot notation for nested arrays.
      *
      * @param list<string>|string $key The key to identify the data to be removed from the hidden context.
      *
      * @return $this
      */
-    public function removeHidden(array|string $key): self
+    public function removeHidden(#[SensitiveParameter] array|string $key): self
     {
         if (is_array($key)) {
             foreach ($key as $k) {
-                unset($this->hiddenData[$k]);
+                ArrayHelper::dotUnset($this->hiddenData, $k);
             }
 
             return $this;
         }
 
-        unset($this->hiddenData[$key]);
+        ArrayHelper::dotUnset($this->hiddenData, $key);
 
         return $this;
     }
@@ -297,4 +295,17 @@ public function clearHidden(): self
 
         return $this;
     }
+
+    public function __debugInfo(): array
+    {
+        return [
+            'data'       => $this->data,
+            'hiddenData' => new SensitiveParameterValue($this->hiddenData),
+        ];
+    }
+
+    public function __clone()
+    {
+        $this->hiddenData = [];
+    }
 }