Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Raue <christian.raue@gmail.com>2014-07-23 22:27:56 +0400
committerChristian Raue <christian.raue@gmail.com>2014-07-23 22:27:56 +0400
commitd9adcfe6169c6c10059a670f2ed984908eb4e105 (patch)
tree25cfca25851214c1b744a07e67e9c120adfd7513 /core/Settings
parent2788e1dad22533f3e0dbddbdd16c51251c4e130a (diff)
removed lots of trailing whitespace
Diffstat (limited to 'core/Settings')
-rw-r--r--core/Settings/Setting.php42
-rw-r--r--core/Settings/SystemSetting.php6
-rw-r--r--core/Settings/UserSetting.php4
3 files changed, 26 insertions, 26 deletions
diff --git a/core/Settings/Setting.php b/core/Settings/Setting.php
index 41cffbe526..2b8e53bf26 100644
--- a/core/Settings/Setting.php
+++ b/core/Settings/Setting.php
@@ -19,7 +19,7 @@ abstract class Setting
/**
* Describes the setting's PHP data type. When saved, setting values will always be casted to this
* type.
- *
+ *
* See {@link Piwik\Plugin\Settings} for a list of supported data types.
*
* @var string
@@ -30,7 +30,7 @@ abstract class Setting
* Describes what HTML element should be used to manipulate the setting through Piwik's UI.
*
* See {@link Piwik\Plugin\Settings} for a list of supported control types.
- *
+ *
* @var string
*/
public $uiControlType = null;
@@ -38,22 +38,22 @@ abstract class Setting
/**
* Name-value mapping of HTML attributes that will be added HTML form control, eg,
* `array('size' => 3)`. Attributes will be escaped before outputting.
- *
+ *
* @var array
*/
public $uiControlAttributes = array();
/**
* The list of all available values for this setting. If null, the setting can have any value.
- *
+ *
* If supplied, this field should be an array mapping available values with their prettified
* display value. Eg, if set to `array('nb_visits' => 'Visits', 'nb_actions' => 'Actions')`,
* the UI will display **Visits** and **Actions**, and when the user selects one, Piwik will
* set the setting to **nb_visits** or **nb_actions** respectively.
- *
+ *
* The setting value will be validated if this field is set. If the value is not one of the
* available values, an error will be triggered.
- *
+ *
* _Note: If a custom validator is supplied (see {@link $validate}), the setting value will
* not be validated._
*
@@ -63,7 +63,7 @@ abstract class Setting
/**
* Text that will appear above this setting's section in the _Plugin Settings_ admin page.
- *
+ *
* @var null|string
*/
public $introduction = null;
@@ -71,7 +71,7 @@ abstract class Setting
/**
* Text that will appear directly underneath the setting title in the _Plugin Settings_ admin
* page. If set, should be a short description of the setting.
- *
+ *
* @var null|string
*/
public $description = null;
@@ -80,20 +80,20 @@ abstract class Setting
* Text that will appear next to the setting's section in the _Plugin Settings_ admin page. If set,
* it should contain information about the setting that is more specific than a general description,
* such as the format of the setting value if it has a special format.
- *
+ *
* @var null|string
*/
public $inlineHelp = null;
/**
* A closure that does some custom validation on the setting before the setting is persisted.
- *
+ *
* The closure should take two arguments: the setting value and the {@link Setting} instance being
* validated. If the value is found to be invalid, the closure should throw an exception with
* a message that describes the error.
- *
+ *
* **Example**
- *
+ *
* $setting->validate = function ($value, Setting $setting) {
* if ($value > 60) {
* throw new \Exception('The time limit is not allowed to be greater than 60 minutes.');
@@ -107,13 +107,13 @@ abstract class Setting
/**
* A closure that transforms the setting value. If supplied, this closure will be executed after
* the setting has been validated.
- *
+ *
* _Note: If a transform is supplied, the setting's {@link $type} has no effect. This means the
* transformation function will be responsible for casting the setting value to the appropriate
* data type._
*
* **Example**
- *
+ *
* $setting->transform = function ($value, Setting $setting) {
* if ($value > 30) {
* $value = 30;
@@ -128,7 +128,7 @@ abstract class Setting
/**
* Default value of this setting.
- *
+ *
* The default value is not casted to the appropriate data type. This means _**you**_ have to make
* sure the value is of the correct type.
*
@@ -169,7 +169,7 @@ abstract class Setting
/**
* Returns the setting's persisted name, eg, `'refreshInterval'`.
- *
+ *
* @return string
*/
public function getName()
@@ -179,7 +179,7 @@ abstract class Setting
/**
* Returns `true` if this setting can be displayed for the current user, `false` if otherwise.
- *
+ *
* @return bool
*/
public function isWritableByCurrentUser()
@@ -199,7 +199,7 @@ abstract class Setting
/**
* Sets the object used to persist settings.
- *
+ *
* @return StorageInterface
*/
public function setStorage(StorageInterface $storage)
@@ -210,7 +210,7 @@ abstract class Setting
/**
* Returns the previously persisted setting value. If no value was set, the default value
* is returned.
- *
+ *
* @return mixed
* @throws \Exception If the current user is not allowed to change the value of this setting.
*/
@@ -221,7 +221,7 @@ abstract class Setting
/**
* Sets and persists this setting's value overwriting any existing value.
- *
+ *
* @param mixed $value
* @throws \Exception If the current user is not allowed to change the value of this setting.
*/
@@ -242,7 +242,7 @@ abstract class Setting
/**
* Returns the display order. The lower the return value, the earlier the setting will be displayed.
- *
+ *
* @return int
*/
public function getOrder()
diff --git a/core/Settings/SystemSetting.php b/core/Settings/SystemSetting.php
index f26c979ae1..935aec1388 100644
--- a/core/Settings/SystemSetting.php
+++ b/core/Settings/SystemSetting.php
@@ -14,7 +14,7 @@ use Piwik\Piwik;
/**
* Describes a system wide setting. Only the Super User can change this type of setting and
* the value of this setting will affect all users.
- *
+ *
* See {@link \Piwik\Plugin\Settings}.
*
*
@@ -33,7 +33,7 @@ class SystemSetting extends Setting
/**
* Constructor.
- *
+ *
* @param string $name The persisted name of the setting.
* @param string $title The display name of the setting.
*/
@@ -47,7 +47,7 @@ class SystemSetting extends Setting
/**
* Returns the display order. System settings are displayed before user settings.
- *
+ *
* @return int
*/
public function getOrder()
diff --git a/core/Settings/UserSetting.php b/core/Settings/UserSetting.php
index 8f56f7104d..fa29269707 100644
--- a/core/Settings/UserSetting.php
+++ b/core/Settings/UserSetting.php
@@ -24,7 +24,7 @@ class UserSetting extends Setting
/**
* Constructor.
- *
+ *
* @param string $name The setting's persisted name.
* @param string $title The setting's display name.
* @param null|string $userLogin The user this setting applies to. Will default to the current user login.
@@ -41,7 +41,7 @@ class UserSetting extends Setting
/**
* Returns the display order. User settings are displayed after system settings.
- *
+ *
* @return int
*/
public function getOrder()