src/Core/PConfig/IPConfig.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2020, Friendica
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\PConfig;
  23
  24 /**
  25  * Interface for accessing user specific configurations
  26  */
  27 interface IPConfig
  28 {
  29
  30         /**
  31          * Loads all configuration values of a user's config family into a cached storage.
  32          *
  33          * All configuration values of the given user are stored with the $uid in the cache
  34          *
  35          * @param int $uid The user_id
  36          * @param string $cat The category of the configuration value
  37          *
  38          * @return void
  39          * @see Cache
  40          *
  41          */
  42         function load(int $uid, string $cat = 'config');
  43
  44         /**
  45          * Get a particular user's config variable given the category name
  46          * ($cat) and a key.
  47          *
  48          * Get a particular user's config value from the given category ($cat)
  49          * and the $key with the $uid from a cached storage either from the $this->configAdapter
  50          * (@see IConfigAdapter) or from the $this->configCache (@see PConfigCache).
  51          *
  52          * @param int     $uid           The user_id
  53          * @param string  $cat           The category of the configuration value
  54          * @param string  $key           The configuration key to query
  55          * @param mixed   $default_value optional, The value to return if key is not set (default: null)
  56          * @param boolean $refresh       optional, If true the config is loaded from the db and not from the cache (default: false)
  57          *
  58          * @return mixed Stored value or null if it does not exist
  59          */
  60         function get(int $uid, string $cat, string $key, $default_value = null, bool $refresh = false);
  61
  62         /**
  63          * Sets a configuration value for a user
  64          *
  65          * Stores a config value ($value) in the category ($family) under the key ($key)
  66          * for the user_id $uid.
  67          *
  68          * @note  Please do not store booleans - convert to 0/1 integer values!
  69          *
  70          * @param int    $uid   The user_id
  71          * @param string $cat   The category of the configuration value
  72          * @param string $key   The configuration key to set
  73          * @param mixed  $value The value to store
  74          *
  75          * @return bool Operation success
  76          */
  77         function set(int $uid, string $cat, string $key, $value);
  78
  79         /**
  80          * Deletes the given key from the users's configuration.
  81          *
  82          * Removes the configured value from the stored cache in $this->configCache
  83          * (@see ConfigCache) and removes it from the database (@see IConfigAdapter)
  84          *  with the given $uid.
  85          *
  86          * @param int $uid The user_id
  87          * @param string $cat The category of the configuration value
  88          * @param string $key The configuration key to delete
  89          *
  90          * @return bool
  91          */
  92         function delete(int $uid, string $cat, string $key);
  93
  94
  95         /**
  96          * Returns the Config Cache
  97          *
  98          * @return Cache
  99          */
 100         function getCache();
 101 }