ConferenceSettingsDAO Class Reference
[Conference]

Class for Conference Settings DAO. Operations for retrieving and modifying conference settings. More...

Inheritance diagram for ConferenceSettingsDAO:

SettingsDAO List of all members.

Public Member Functions

_buildLocalizedObject (&$node, $paramArray=array(), $locale=null)
_buildObject (&$node, $paramArray=array())
 _cacheMiss (&$cache, $id)
_getCache ($conferenceId)
 _installer_regexp_callback ($matches)
 _performLocalizedReplacement ($rawInput, $paramArray=array(), $locale=null)
 _performReplacement ($rawInput, $paramArray=array())
 deleteSetting ($conferenceId, $name, $locale=null)
 deleteSettingsByConference ($conferenceId)
getConferenceSettings ($conferenceId)
getSetting ($conferenceId, $name, $locale=null)
 installSettings ($conferenceId, $filename, $paramArray=array())
 reloadLocalizedDefaultSettings ($conferenceId, $filename, $paramArray, $locale)
 updateSetting ($conferenceId, $name, $value, $type=null, $isLocalized=false)

Detailed Description

Class for Conference Settings DAO. Operations for retrieving and modifying conference settings.

Definition at line 19 of file ConferenceSettingsDAO.inc.php.


Member Function Documentation

& ConferenceSettingsDAO._buildLocalizedObject ( &$  node,
paramArray = array(),
locale = null 
)

Used internally by reloadLocalizedSettingDefaults to recursively build nested arrays. Deals with translation and variable replacement calls.

Parameters:
$node object XMLNode <array> tag
$paramArray array Parameters to be replaced in key/value contents
$locale string contains the name of the locale that should be used for the translation

Definition at line 277 of file ConferenceSettingsDAO.inc.php.

References _performLocalizedReplacement().

Referenced by reloadLocalizedDefaultSettings().

& ConferenceSettingsDAO._buildObject ( &$  node,
paramArray = array() 
)

Used internally by installSettings to recursively build nested arrays. Deals with translation and variable replacement calls.

Parameters:
$node object XMLNode <array> tag
$paramArray array Parameters to be replaced in key/value contents

Reimplemented from SettingsDAO.

Definition at line 189 of file ConferenceSettingsDAO.inc.php.

ConferenceSettingsDAO._installer_regexp_callback ( matches  ) 

Used internally by conference setting installation code to perform translation function.

Reimplemented from SettingsDAO.

Definition at line 348 of file ConferenceSettingsDAO.inc.php.

ConferenceSettingsDAO._performLocalizedReplacement ( rawInput,
paramArray = array(),
locale = null 
)

Used internally by reloadLocalizedSettingDefaults to perform variable and translation replacements.

Parameters:
$rawInput string contains text including variable and/or translate replacements.
$paramArray array contains variables for replacement
$locale string contains the name of the locale that should be used for the translation
Returns:
string

Definition at line 260 of file ConferenceSettingsDAO.inc.php.

Referenced by _buildLocalizedObject(), and reloadLocalizedDefaultSettings().

ConferenceSettingsDAO._performReplacement ( rawInput,
paramArray = array() 
)

Used internally by installSettings to perform variable and translation replacements.

Parameters:
$rawInput string contains text including variable and/or translate replacements.
$paramArray array contains variables for replacement
Returns:
string

Reimplemented from SettingsDAO.

Definition at line 175 of file ConferenceSettingsDAO.inc.php.

ConferenceSettingsDAO.deleteSetting ( conferenceId,
name,
locale = null 
)

Delete a conference setting.

Parameters:
$conferenceId int
$name string
$locale string

Definition at line 142 of file ConferenceSettingsDAO.inc.php.

References _getCache().

ConferenceSettingsDAO.deleteSettingsByConference ( conferenceId  ) 

Delete all settings for a conference.

Parameters:
$conferenceId int

Definition at line 160 of file ConferenceSettingsDAO.inc.php.

References _getCache().

& ConferenceSettingsDAO.getConferenceSettings ( conferenceId  ) 

Retrieve and cache all settings for a conference.

Parameters:
$conferenceId int
Returns:
array

Definition at line 71 of file ConferenceSettingsDAO.inc.php.

References _getCache().

Referenced by _cacheMiss().

& ConferenceSettingsDAO.getSetting ( conferenceId,
name,
locale = null 
)

Retrieve a conference setting value.

Parameters:
$conferenceId int
$name string
$locale string optional
Returns:
mixed

Definition at line 42 of file ConferenceSettingsDAO.inc.php.

References _getCache().

ConferenceSettingsDAO.installSettings ( conferenceId,
filename,
paramArray = array() 
)

Install conference settings from an XML file.

Parameters:
$conferenceId int ID of conference for settings to apply to
$filename string Name of XML file to parse and install
$paramArray array Optional parameters for variable replacement in settings

Reimplemented from SettingsDAO.

Definition at line 213 of file ConferenceSettingsDAO.inc.php.

ConferenceSettingsDAO.reloadLocalizedDefaultSettings ( conferenceId,
filename,
paramArray,
locale 
)

Install locale field Only conference settings from an XML file.

Parameters:
$conferenceId int ID of conference for settings to apply to
$filename string Name of XML file to parse and install
$paramArray array Optional parameters for variable replacement in settings
$locale string locale id for which settings will be loaded

Definition at line 302 of file ConferenceSettingsDAO.inc.php.

References _buildLocalizedObject(), _performLocalizedReplacement(), and updateSetting().

ConferenceSettingsDAO.updateSetting ( conferenceId,
name,
value,
type = null,
isLocalized = false 
)

Add/update a conference setting.

Parameters:
$conferenceId int
$name string
$value mixed
$type string data type of the setting. If omitted, type will be guessed
$isLocalized boolean

Definition at line 102 of file ConferenceSettingsDAO.inc.php.

References _getCache().

Referenced by reloadLocalizedDefaultSettings().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7