Piwik\Settings\

Settings

Base class of all settings providers.

Methods

The abstract class defines the following methods:

• __construct()
• getTitle()
• getSettingsWritableByCurrentUser() — Returns the settings that can be displayed for the current user.
• addSetting() — Adds a new setting to the settings container.
• save() — Saves (persists) the current setting values in the database.

__construct()

Signature

getTitle()

Signature

• It does not return anything or a mixed result.

getSettingsWritableByCurrentUser()

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

Signature

• It returns a Setting[] value.

addSetting()

Adds a new setting to the settings container.

Signature

• It accepts the following parameter(s):

  • $setting (Setting) —

• It does not return anything or a mixed result.

• It throws one of the following exceptions:
  • Exception — If there is a setting with the same name that already exists. If the name contains non-alphanumeric characters.

save()

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

Signature

• It does not return anything or a mixed result.