Gentics Portal.Node PHP API
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SettingsModule Class Reference

Public Member Functions

 init ()
 get ($name)
 set ($name, $value)

Static Public Member Functions

static t ($str= '', $params=array(), $dic= 'core')

Public Attributes

 $fields
 $layoutForBackend = '//layouts/gportal'

Detailed Description

Definition at line 5 of file SettingsModule.php.

Member Function Documentation

SettingsModule::get (   $name)

Method for getting setting from DB

Parameters
string$namesetting name
Returns
mixed

Definition at line 37 of file SettingsModule.php.

References Settings\instance().

{
if (!in_array($name, $this->fields)) {
return false;
}
return Settings::instance()->get($name);
}
SettingsModule::init ( )

Model initial method

Returns
void

Definition at line 20 of file SettingsModule.php.

{
$this->setImport(
array(
'settings.models.*'
)
);
}
SettingsModule::set (   $name,
  $value 
)

Method for saving setting into DB

Parameters
string$namesetting name
mixed$valuesetting value
Returns
bool if success

Definition at line 53 of file SettingsModule.php.

References Settings\instance().

{
if (!in_array($name, $this->fields)) {
return false;
}
Settings::instance()->set($name, $value);
return true;
}
static SettingsModule::t (   $str = '',
  $params = array(),
  $dic = 'core' 
)
static

Translates a message to the specified language.

Parameters
string$strmessage
array$paramsparams
string$dicdictionary
Returns
string

Definition at line 71 of file SettingsModule.php.

Referenced by ManageController\actionIndex().

{
return Yii::t("SettingsModule." . $dic, $str, $params);
}

The documentation for this class was generated from the following file: