some more minor fixups (phpdoc, unused using)
This commit is contained in:
parent
a654470061
commit
aa249adf6d
3 changed files with 24 additions and 8 deletions
src
|
@ -8,7 +8,6 @@ use Friendica\Factory;
|
||||||
use Friendica\Util\BasePath;
|
use Friendica\Util\BasePath;
|
||||||
use Friendica\Util\BaseURL;
|
use Friendica\Util\BaseURL;
|
||||||
use Friendica\Util\Config;
|
use Friendica\Util\Config;
|
||||||
use Psr\Log\NullLogger;
|
|
||||||
|
|
||||||
class DependencyFactory
|
class DependencyFactory
|
||||||
{
|
{
|
||||||
|
|
|
@ -3,14 +3,19 @@
|
||||||
namespace Friendica\Model\Config;
|
namespace Friendica\Model\Config;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The Config model backend, which is using the general DB-model backend for configs
|
||||||
|
*/
|
||||||
class Config extends DbaConfig
|
class Config extends DbaConfig
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Loads all configuration values and returns the loaded category as an array.
|
* 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)
|
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
|
* Get a particular, system-wide config variable out of the DB with the
|
||||||
* ($cat) and a key ($key).
|
* given category name ($cat) and a key ($key).
|
||||||
*
|
*
|
||||||
* Note: Boolean variables are defined as 0/1 in the database
|
* Note: Boolean variables are defined as 0/1 in the database
|
||||||
*
|
*
|
||||||
* @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
|
||||||
*
|
*
|
||||||
* @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)
|
public function get(string $cat, string $key)
|
||||||
{
|
{
|
||||||
|
@ -77,6 +84,8 @@ class Config extends DbaConfig
|
||||||
* @param mixed $value The value to store
|
* @param mixed $value The value to store
|
||||||
*
|
*
|
||||||
* @return bool Operation success
|
* @return bool Operation success
|
||||||
|
*
|
||||||
|
* @throws \Exception In case DB calls are invalid
|
||||||
*/
|
*/
|
||||||
public function set(string $cat, string $key, $value)
|
public function set(string $cat, string $key, $value)
|
||||||
{
|
{
|
||||||
|
@ -102,13 +111,14 @@ class Config extends DbaConfig
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Removes the configured value from the stored cache
|
* Removes the configured value from the database.
|
||||||
* and removes it from the database.
|
|
||||||
*
|
*
|
||||||
* @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 delete
|
* @param string $key The configuration key to delete
|
||||||
*
|
*
|
||||||
* @return bool Operation success
|
* @return bool Operation success
|
||||||
|
*
|
||||||
|
* @throws \Exception In case DB calls are invalid
|
||||||
*/
|
*/
|
||||||
public function delete(string $cat, string $key)
|
public function delete(string $cat, string $key)
|
||||||
{
|
{
|
||||||
|
|
|
@ -4,11 +4,18 @@ namespace Friendica\Model\Config;
|
||||||
|
|
||||||
use Friendica\Database\Database;
|
use Friendica\Database\Database;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The DB-based model of (P-)Config values
|
||||||
|
* Encapsulates db-calls in case of config queries
|
||||||
|
*/
|
||||||
abstract class DbaConfig
|
abstract class DbaConfig
|
||||||
{
|
{
|
||||||
/** @var Database */
|
/** @var Database */
|
||||||
protected $dba;
|
protected $dba;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param Database $dba The database connection of this model
|
||||||
|
*/
|
||||||
public function __construct(Database $dba)
|
public function __construct(Database $dba)
|
||||||
{
|
{
|
||||||
$this->dba = $dba;
|
$this->dba = $dba;
|
||||||
|
|
Loading…
Reference in a new issue