Deprecate default value parameters in Session and Config interfaces

- It is more efficient to use the null coalescing operator ?? that prevents the computation of the default value if the key has been found

diff --git a/src/Core/Config/Capability/IManageConfigValues.php b/src/Core/Config/Capability/IManageConfigValues.php
index f18e8e1e3d7c9dcf16d4fb051bcaba8b88a9c25e..bf9144cf50b892dd87a7da9564b311373cc96fc0 100644 (file)
--- a/src/Core/Config/Capability/IManageConfigValues.php
+++ b/src/Core/Config/Capability/IManageConfigValues.php
@@ -51,7 +51,7 @@ interface IManageConfigValues
         *
         * @param string  $cat        The category of the configuration value
         * @param string  $key           The configuration key to query
-        * @param mixed   $default_value optional, The value to return if key is not set (default: null)
+        * @param mixed   $default_value Deprecated, use `Config->get($cat, $key, null, $refresh) ?? $default_value` instead
         * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
         *
         * @return mixed Stored value or null if it does not exist

diff --git a/src/Core/PConfig/Capability/IManagePersonalConfigValues.php b/src/Core/PConfig/Capability/IManagePersonalConfigValues.php
index ead3c261479f8a173b9dfd4a652dd2f5251fbd06..191869daa8a1dc15d6275fb1c2458430bf8c4d2c 100644 (file)
--- a/src/Core/PConfig/Capability/IManagePersonalConfigValues.php
+++ b/src/Core/PConfig/Capability/IManagePersonalConfigValues.php
@@ -51,7 +51,7 @@ interface IManagePersonalConfigValues
         * @param int     $uid           The user_id
         * @param string  $cat           The category of the configuration value
         * @param string  $key           The configuration key to query
-        * @param mixed   $default_value optional, The value to return if key is not set (default: null)
+        * @param mixed   $default_value Deprecated, use `PConfig->get($uid, $cat, $key, null, $refresh) ?? $default_value` instead
         * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
         *
         * @return mixed Stored value or null if it does not exist

diff --git a/src/Core/Session/Capability/IHandleSessions.php b/src/Core/Session/Capability/IHandleSessions.php
index d0b649845b5c4c050c8bcdb52ab6fe283b4d3351..72905fc576166fa02071851442e0ebd6cdffb67b 100644 (file)
--- a/src/Core/Session/Capability/IHandleSessions.php
+++ b/src/Core/Session/Capability/IHandleSessions.php
@@ -48,7 +48,7 @@ interface IHandleSessions
         * Handle the case where session_start() hasn't been called and the super global isn't available.
         *
         * @param string $name
-        * @param mixed  $defaults
+        * @param mixed  $defaults Deprecated, use `Session->get($name) ?? $defaults` instead
         *
         * @return mixed
         */
@@ -58,7 +58,7 @@ interface IHandleSessions
         * Retrieves a value from the provided key if it exists and removes it from session
         *
         * @param string $name
-        * @param mixed  $defaults
+        * @param mixed  $defaults Deprecated, use `Session->pop($name) ?? $defaults` instead
         *
         * @return mixed
         */