PHP Class BookStack\Services\SettingService

The settings are a simple key-value database store.

Protected Properties

Method	Description
__construct ( Setting $setting, Illuminate\Contracts\Cache\Repository $cache )	SettingService constructor.
get ( $key, string \| boolean $default = false ) : boolean \| string	Gets a setting from the database, If not found, Returns default, Which is false by default.
has ( $key ) : boolean	Checks if a setting exists.
put ( $key, $value ) : boolean	Add a setting to the database.
remove ( $key ) : boolean	Removes a setting from the database.

Method	Description
clearFromCache ( $key )	Clear an item from the cache completely.
formatValue ( $value, $default ) : mixed	Format a settings value
getOverrideValue ( $key ) : boolean \| null	Returns an override value for a setting based on certain app conditions.
getSettingObjectByKey ( $key ) : mixed	Gets a setting model from the database for the given key.
getValueFromStore ( $key, $default ) : mixed	Gets a setting value from the cache or database.

SettingService constructor.

public __construct ( Setting $setting, Illuminate\Contracts\Cache\Repository $cache )
$setting	BookStack\Setting
$cache	Illuminate\Contracts\Cache\Repository

Clear an item from the cache completely.

protected clearFromCache ( $key )
$key

Format a settings value

protected formatValue ( $value, $default ) : mixed
$value
$default
return	mixed

Gets a setting from the database, If not found, Returns default, Which is false by default.

public get ( $key, string \| boolean $default = false ) : boolean \| string
$key
$default	string \| boolean
return	boolean \| string

Used where certain configuration options overrule others. Returns null if no override value is available.

protected getOverrideValue ( $key ) : boolean \| null
$key
return	boolean \| null

Gets a setting model from the database for the given key.

protected getSettingObjectByKey ( $key ) : mixed
$key
return	mixed

Looks at the system defaults if not cached or in database.

protected getValueFromStore ( $key, $default ) : mixed
$key
$default
return	mixed

Checks if a setting exists.

Add a setting to the database.

Removes a setting from the database.

protected $cache

protected $cachePrefix

protected $setting