fix phpdoc

This commit is contained in:
Philipp Holzer 2019-07-14 22:41:09 +02:00
parent 05439e4866
commit a654470061
No known key found for this signature in database
GPG key ID: D8365C3D36B77D90
3 changed files with 11 additions and 19 deletions

View file

@ -68,7 +68,7 @@ class ConfigCache
* *
* @return null|mixed Returns the value of the Config entry or null if not set * @return null|mixed Returns the value of the Config entry or null if not set
*/ */
public function get(string $cat, string $key = null) public function get(string $cat, $key = null)
{ {
if (isset($this->config[$cat][$key])) { if (isset($this->config[$cat][$key])) {
return $this->config[$cat][$key]; return $this->config[$cat][$key];

View file

@ -5,10 +5,11 @@ namespace Friendica\Core\Config;
use Friendica\Model; use Friendica\Model;
/** /**
* This class is responsible for all system-wide configuration values in Friendica * This class implements the Just-In-Time configuration, which will cache
* There are two types of storage * config values in a cache, once they are retrieved.
* - The Config-Files (loaded into the FileCache @see Cache\ConfigCache ) *
* - The Config-DB-Table (per Config-DB-model @see Model\Config\Config ) * Default Configuration type.
* Provides the best performance for pages loading few configuration variables.
*/ */
class JitConfiguration extends Configuration class JitConfiguration extends Configuration
{ {
@ -106,16 +107,7 @@ class JitConfiguration extends Configuration
} }
/** /**
* @brief Deletes the given key from the system configuration. * {@inheritDoc}
*
* Removes the configured value from the stored cache in $this->configCache
* (@param string $cat The category of the configuration value
*
* @param string $key The configuration key to delete
*
* @return bool
* @see ConfigCache ) and removes it from the database (@see IConfigAdapter ).
*
*/ */
public function delete(string $cat, string $key) public function delete(string $cat, string $key)
{ {

View file

@ -5,10 +5,10 @@ namespace Friendica\Core\Config;
use Friendica\Model; use Friendica\Model;
/** /**
* This class is responsible for all system-wide configuration values in Friendica * This class implements the preload Time configuration, which will cache
* There are two types of storage * all config values per call in a cache.
* - The Config-Files (loaded into the FileCache @see Cache\ConfigCache ) *
* - The Config-DB-Table (per Config-DB-model @see Model\Config\Config ) * Minimizes the number of database queries to retrieve configuration values at the cost of memory.
*/ */
class PreloadConfiguration extends Configuration class PreloadConfiguration extends Configuration
{ {