Docs For Class rcube

Description

Configuration class for Roundcube

Located in /rcube_config.php (line 27)

Method Summary

rcube_config __construct ()

array all ()

mixed get (string $name, [mixed $def = null])

string get_crypto_key (string $key)

mixed get_error ()

float get_timezone ()

string header_delimiter ()

booelan load_from_file (string $fpath)

string mail_domain (string $host, [boolean $encode = true])

void merge (array $prefs)

void set (string $name, mixed $value)

void set_user_prefs (array $prefs)

Methods

Constructor __construct (line 37)

Object constructor

access: public

rcube_config __construct ()

all (line 235)

Getter for all config options

return: Hash array containg all config properties
access: public

array all ()

get (line 157)

Getter for a specific config parameter

return: The requested config value
access: public

mixed get (string $name, [mixed $def = null])

string $name: Parameter name
mixed $def: Default value if not set

get_crypto_key (line 256)

Return requested DES crypto key.

return: Crypto key
access: public

string get_crypto_key (string $key)

string $key: Crypto key name

get_error (line 344)

Getter for error state

return: Error message on error, False if no errors
access: public

mixed get_error ()

get_timezone (line 245)

Special getter for user's timezone offset including DST

return: Timezone offset (in hours)
access: public

float get_timezone ()

header_delimiter (line 287)

Try to autodetect operating system and find the correct line endings

return: The appropriate mail header delimiter
access: public

string header_delimiter ()

load_from_file (line 132)

Read configuration from a file and merge with the already stored config values

return: True on success, false on failure
access: public

booelan load_from_file (string $fpath)

string $fpath: Full path to the config file to be loaded

mail_domain (line 321)

Return the mail domain configured for the given host

return: Resolved SMTP host
access: public

string mail_domain (string $host, [boolean $encode = true])

string $host: IMAP host
boolean $encode: If true, domain name will be converted to IDN ASCII

merge (line 193)

Override config options with the given values (eg. user prefs)

access: public

void merge (array $prefs)

array $prefs: Hash array with config props to merge over

set (line 182)

Setter for a config parameter

access: public

void set (string $name, mixed $value)

string $name: Parameter name
mixed $value: Parameter value

set_user_prefs (line 205)

Merge the given prefs over the current config and make sure that they survive further merging.

access: public

void set_user_prefs (array $prefs)

array $prefs: Hash array with user prefs