PHP Class Piwik\Settings\Settings

Mostrar archivo Open project: piwik/piwik Class Usage Examples

Protected Properties

Property	Type	Description
$pluginName
$title	string	By default the plugin name is shown in the UI when managing plugin settings. However, you can overwrite the displayed title by specifying a title.

Public Methods

Method	Description
__construct ( )
getPluginName ( )
getSetting ( $name ) : Piwik\Settings\Setting
getSettingsWritableByCurrentUser ( ) : Piwik\Settings\Setting[]	Returns the settings that can be displayed for the current user.
getTitle ( )
save ( )	Saves (persists) the current setting values in the database.

Protected Methods

Method	Description
addSetting ( Piwik\Settings\Setting $setting )	Makes a new plugin setting available.
init ( )	Implemented by descendants. This method should define plugin settings (via the {@link addSetting()}) method and set the introduction text (via the {@link setIntroduction()}).

Method Details

__construct() public method

public __construct ( )

addSetting() protected method

Makes a new plugin setting available.

protected addSetting ( Piwik\Settings\Setting $setting )
$setting	Piwik\Settings\Setting

getPluginName() public method

public getPluginName ( )

getSetting() public method

public getSetting ( $name ) : Piwik\Settings\Setting
return	Piwik\Settings\Setting

getSettingsWritableByCurrentUser() public method

Returns the settings that can be displayed for the current user.

public getSettingsWritableByCurrentUser ( ) : Piwik\Settings\Setting[]
return	Piwik\Settings\Setting[]

getTitle() public method

public getTitle ( )

init() abstract protected method

Implemented by descendants. This method should define plugin settings (via the {@link addSetting()}) method and set the introduction text (via the {@link setIntroduction()}).

abstract protected init ( )

save() public method

Saves (persists) the current setting values in the database.

public save ( )

Property Details

$pluginName protected_oe property

protected $pluginName

$title protected_oe property

By default the plugin name is shown in the UI when managing plugin settings. However, you can overwrite the displayed title by specifying a title.

protected string $title
return	string