/sources/config.php

Description
Description | Functions
Functions
Description | Functions
delete_value (line 260)

Delete a situational value.

void delete_value (ID_TEXT $name)
  • ID_TEXT $name: The name of the value
get_long_value (line 166)

Find a specified long value.

  • return: The value (NULL: value not found)
?SHORT_TEXT get_long_value (ID_TEXT $name)
  • ID_TEXT $name: The name of the value
get_long_value_newer_than (line 178)

Find the specified configuration option if it is younger than a specified time.

  • return: The value (NULL: value newer than not found)
?SHORT_TEXT get_long_value_newer_than (ID_TEXT $name, TIME $cutoff)
  • ID_TEXT $name: The name of the value
  • TIME $cutoff: The cutoff time (an absolute time, not a relative "time ago")
get_option (line 273)

Find the value of the specified configuration option.

  • return: The value (NULL: either null value, or no option found whilst $missing_ok set)
?SHORT_TEXT get_option (ID_TEXT $name, [boolean $missing_ok = false])
  • ID_TEXT $name: The name of the option
  • boolean $missing_ok: Where to accept a missing option (and return NULL)
get_tutorial_link (line 143)

Find a specified tutorial link identifier.

  • return: The value (NULL: value not found)
?SHORT_TEXT get_tutorial_link (ID_TEXT $name)
  • ID_TEXT $name: The name of the value
get_value (line 203)

Find a specified value.

  • return: The value (NULL: value not found and default is NULL)
?SHORT_TEXT get_value (ID_TEXT $name, [?ID_TEXT $default = NULL], [boolean $env_also = false])
  • ID_TEXT $name: The name of the value
  • ?ID_TEXT $default: Value to return if value not found (NULL: return NULL)
  • boolean $env_also: Whether to also check server environmental variables
get_value_newer_than (line 226)

Find the specified configuration option if it is younger than a specified time.

  • return: The value (NULL: value newer than not found)
?SHORT_TEXT get_value_newer_than (ID_TEXT $name, TIME $cutoff)
  • ID_TEXT $name: The name of the value
  • TIME $cutoff: The cutoff time (an absolute time, not a relative "time ago")
init__config (line 24)

Standard code module initialisation function.

void init__config ()
invert_value (line 404)

Very simple function to invert the meaning of an old hidden option. We often use this when we've promoted a hidden option into a new proper option but inverted the meaning in the process - we use this in the default value generation code, as an in-line aid to preserve existing hidden option settings.

  • return: The inverted value
ID_TEXT invert_value (ID_TEXT $old)
  • ID_TEXT $old: The old value
load_options (line 119)

Load all config options.

void load_options ()
multi_lang (line 52)

Find whether to run in multi-lang mode.

  • return: Whether to run in multi-lang mode.
boolean multi_lang ()
set_long_value (line 189)

Set the specified situational value to the specified long value.

void set_long_value (ID_TEXT $name, SHORT_TEXT $value)
  • ID_TEXT $name: The name of the value
  • SHORT_TEXT $value: The value
set_tutorial_link (line 154)

Set the specified value to the specified tutorial link identifier.

void set_tutorial_link (ID_TEXT $name, SHORT_TEXT $value)
  • ID_TEXT $name: The name of the value
  • SHORT_TEXT $value: The value
set_value (line 239)

Set the specified situational value to the specified value.

void set_value (ID_TEXT $name, SHORT_TEXT $value)
  • ID_TEXT $name: The name of the value
  • SHORT_TEXT $value: The value
update_stat (line 389)

Increment the specified stored value, by the specified amount.

void update_stat (ID_TEXT $stat, integer $increment)
  • ID_TEXT $stat: The codename for the stat
  • integer $increment: What to increment the statistic by

Documentation generated on Sun, 02 Jan 2011 23:11:59 +0000 by phpDocumentor 1.4.3