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
This commit is contained in:
Hypolite Petovan 2022-11-02 20:38:23 -04:00
parent da3041a4d4
commit 23dda5d510
3 changed files with 4 additions and 4 deletions

View File

@ -51,7 +51,7 @@ interface IManageConfigValues
* *
* @param string $cat The category of the configuration value * @param string $cat The category of the configuration value
* @param string $key The configuration key to query * @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) * @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 * @return mixed Stored value or null if it does not exist

View File

@ -51,7 +51,7 @@ interface IManagePersonalConfigValues
* @param int $uid The user_id * @param int $uid The user_id
* @param string $cat The category of the configuration value * @param string $cat The category of the configuration value
* @param string $key The configuration key to query * @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) * @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 * @return mixed Stored value or null if it does not exist

View File

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