Piwik \环境\

设置

基设置类型类。

方法

该类定义了以下方法:

• __construct ()——构造函数。
• getName ()-获取设置的名称。
• 方法()-获取设置的PHP类型。
• getDefaultValue ()
• setDefaultValue ()—设置/覆盖当前默认值
• setIsWritableByCurrentUser ()—设置设置是否可写。
• isWritableByCurrentUser ()——返回真正的如果此设置对当前用户可写，假否则如果。
• save ()-如果实际设置了一个值，则保存(持久)数据库中该设置的值。
• getValue ()-返回之前持久化的设置值。
• setValue ()-设置并持久化此设置的值，覆盖任何现有值。

__construct ()

构造函数。

签名

• 它接受以下参数:
  • 美元的名字（字符串) -设置的持久化名称。只允许使用字母数字字符，例如，“refreshInterval”．
  • defaultValue美元（混合-如果没有指定值，则此设置为默认值。
  • 美元的类型（字符串) -例如一个数组，int，…参见SettingConfig::TYPE_* constants
  • pluginName美元（字符串) -设置所属插件的名称
• 它会抛出以下异常之一:
  • 异常

getName ()

获取设置的名称。

签名

• 它返回一个字符串价值。

方法()

获取设置的PHP类型。

签名

• 它返回一个字符串价值。

getDefaultValue ()

签名

• 它返回一个混合价值。

setDefaultValue ()

设置/覆盖当前默认值

签名

• 它接受以下参数:

  • defaultValue美元（字符串) - - -

• 它不返回任何东西，也不返回混合结果。

setIsWritableByCurrentUser ()

设置设置是否可写。例如，要从UI中隐藏设置，将其设置为false。

签名

• 它接受以下参数:

  • isWritable美元（保龄球) - - -

• 它不返回任何东西，也不返回混合结果。

isWritableByCurrentUser ()

返回真正的如果此设置对当前用户可写，假否则如果。如果它为当前用户返回可写的，它将在插件设置UI中可见。

签名

• 它返回一个保龄球价值。

save ()

如果实际设置了一个值，则在数据库中保存(持久)此设置的值。

签名

• 它不返回任何东西，也不返回混合结果。

getValue ()

返回先前持久化的设置值。如果没有设置，则返回默认值。

签名

• 它返回一个混合价值。

setValue ()

设置并持久化此设置的值，覆盖任何现有值。

在实际设置值之前，它将确保当前用户被允许更改值。该值将首先通过系统内置的验证方法或集合进行验证FieldConfig:: $验证自定义方法。之后，该值将通过可能指定的FieldConfig:: $变换方法。在存储实际值之前，该值将被转换为实际指定的$type。

签名

• 它接受以下参数:

  • 美元的价值（混合) - - -

• 它不返回任何东西，也不返回混合结果。

• 它会抛出以下异常之一:
  • 异常—当前用户不允许修改该设置。