From aa249adf6dcaa075168472d479a532538c174da3 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sun, 14 Jul 2019 22:49:17 +0200 Subject: [PATCH] some more minor fixups (phpdoc, unused using) --- src/Factory/DependencyFactory.php | 1 - src/Model/Config/Config.php | 24 +++++++++++++++++------- src/Model/Config/DbaConfig.php | 7 +++++++ 3 files changed, 24 insertions(+), 8 deletions(-) diff --git a/src/Factory/DependencyFactory.php b/src/Factory/DependencyFactory.php index 0ac56f6c5e..36ab20a013 100644 --- a/src/Factory/DependencyFactory.php +++ b/src/Factory/DependencyFactory.php @@ -8,7 +8,6 @@ use Friendica\Factory; use Friendica\Util\BasePath; use Friendica\Util\BaseURL; use Friendica\Util\Config; -use Psr\Log\NullLogger; class DependencyFactory { diff --git a/src/Model/Config/Config.php b/src/Model/Config/Config.php index e7dd0a5693..aa81f1cae9 100644 --- a/src/Model/Config/Config.php +++ b/src/Model/Config/Config.php @@ -3,14 +3,19 @@ namespace Friendica\Model\Config; +/** + * The Config model backend, which is using the general DB-model backend for configs + */ class Config extends DbaConfig { /** * Loads all configuration values and returns the loaded category as an array. * - * @param string $cat The category of the configuration values to load + * @param string|null $cat The category of the configuration values to load * - * @return array + * @return array The config array + * + * @throws \Exception In case DB calls are invalid */ public function load(string $cat = null) { @@ -38,15 +43,17 @@ class Config extends DbaConfig } /** - * Get a particular system-wide config variable given the category name - * ($cat) and a key ($key). + * Get a particular, system-wide config variable out of the DB with the + * given category name ($cat) and a key ($key). * * Note: Boolean variables are defined as 0/1 in the database * * @param string $cat The category of the configuration value * @param string $key The configuration key to query * - * @return null|mixed Stored value or null if it does not exist + * @return array|string|null Stored value or null if it does not exist + * + * @throws \Exception In case DB calls are invalid */ public function get(string $cat, string $key) { @@ -77,6 +84,8 @@ class Config extends DbaConfig * @param mixed $value The value to store * * @return bool Operation success + * + * @throws \Exception In case DB calls are invalid */ public function set(string $cat, string $key, $value) { @@ -102,13 +111,14 @@ class Config extends DbaConfig } /** - * Removes the configured value from the stored cache - * and removes it from the database. + * Removes the configured value from the database. * * @param string $cat The category of the configuration value * @param string $key The configuration key to delete * * @return bool Operation success + * + * @throws \Exception In case DB calls are invalid */ public function delete(string $cat, string $key) { diff --git a/src/Model/Config/DbaConfig.php b/src/Model/Config/DbaConfig.php index aa6a1f3e27..cd6b6da8c0 100644 --- a/src/Model/Config/DbaConfig.php +++ b/src/Model/Config/DbaConfig.php @@ -4,11 +4,18 @@ namespace Friendica\Model\Config; use Friendica\Database\Database; +/** + * The DB-based model of (P-)Config values + * Encapsulates db-calls in case of config queries + */ abstract class DbaConfig { /** @var Database */ protected $dba; + /** + * @param Database $dba The database connection of this model + */ public function __construct(Database $dba) { $this->dba = $dba;