PHP Class Piwik\Settings\Storage\Factory

ファイルを表示 Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
getConfigStorage ( string $section ) : mixed
getMeasurableSettingsStorage ( integer $idSite, string $pluginName ) : Storage	Get a storage instance for measurable settings.
getNonPersistentStorage ( string $key ) : Storage	Get a storage with a backend that will never persist or load any value.
getPluginStorage ( string $pluginName, string $userLogin ) : Storage	Get a storage instance for plugin settings.
getSitesTable ( integer $idSite ) : Storage	Get a storage instance for settings that will be saved in the "site" table.

Private Methods

Method	Description
makeStorage ( Piwik\Settings\Storage\Backend\BackendInterface $backend )

Method Details

getConfigStorage() public method

public getConfigStorage ( string $section ) : mixed
$section	string
return	mixed

getMeasurableSettingsStorage() public method

The storage will hold values that belong to the given idSite and plugin name. Be aware that a storage instance for a specific site and plugin will be cached during one request for better performance.

public getMeasurableSettingsStorage ( integer $idSite, string $pluginName ) : Storage
$idSite	integer	If idSite is empty it will use a backend that never actually persists any value. Pass $idSite = 0 to create a storage for a site that is about to be created.
$pluginName	string
return	Storage

getNonPersistentStorage() public method

Get a storage with a backend that will never persist or load any value.

public getNonPersistentStorage ( string $key ) : Storage
$key	string
return	Storage

getPluginStorage() public method

The storage will hold values that belong to the given plugin name and user login. Be aware that instances for a specific plugin and login will be cached during one request for better performance.

public getPluginStorage ( string $pluginName, string $userLogin ) : Storage
$pluginName	string
$userLogin	string	Use an empty string if settings should be not for a specific login
return	Storage

getSitesTable() public method

The storage will hold values that belong to the given idSite. Be aware that a storage instance for a specific site will be cached during one request for better performance.

public getSitesTable ( integer $idSite ) : Storage
$idSite	integer	If idSite is empty it will use a backend that never actually persists any value. Pass $idSite = 0 to create a storage for a site that is about to be created.
return	Storage