PluginSettingsDAO Class Reference [Plugins]

Operations for retrieving and modifying plugin settings. More...

List of all members.

Public Member Functions
&	_buildObject (&$node, $paramArray=array())
	_performReplacement ($rawInput, $paramArray=array())
	deleteSetting ($conferenceId, $schedConfId, $pluginName, $name)
	deleteSettingsByConferenceId ($conferenceId)
	deleteSettingsByPlugin ($pluginName, $conferenceId=null, $schedConfId=null)
&	getPluginSettings ($conferenceId, $schedConfId, $pluginName)
	getSetting ($conferenceId, $schedConfId, $pluginName, $name)
	installSettings ($conferenceId, $schedConfId, $pluginName, $filename, $paramArray=array())
	updateSetting ($conferenceId, $schedConfId, $pluginName, $name, $value, $type=null)

---

Detailed Description

Operations for retrieving and modifying plugin settings.

See also:

Plugin, PluginRegistry

Definition at line 18 of file PluginSettingsDAO.inc.php.

---

Member Function Documentation

& PluginSettingsDAO._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

Definition at line 221 of file PluginSettingsDAO.inc.php.

References _performReplacement().

Referenced by installSettings().

PluginSettingsDAO._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

Definition at line 207 of file PluginSettingsDAO.inc.php.

Referenced by _buildObject(), and installSettings().

PluginSettingsDAO.deleteSetting	(	$	conferenceId,
		$	schedConfId,
		$	pluginName,
		$	name
	)

Delete a plugin setting.

Parameters:

	$conferenceId	int
	$schedConfIf	int
	$schedConfId	int
	$pluginName	int
	$name	string

Definition at line 153 of file PluginSettingsDAO.inc.php.

PluginSettingsDAO.deleteSettingsByConferenceId

(

$

conferenceId

)

Delete all settings for a conference.

Parameters:

$conferenceId

int

Definition at line 195 of file PluginSettingsDAO.inc.php.

PluginSettingsDAO.deleteSettingsByPlugin	(	$	pluginName,
		$	conferenceId = null,
		$	schedConfId = null
	)

Delete all settings for a plugin.

Parameters:

$pluginName

string

Definition at line 167 of file PluginSettingsDAO.inc.php.

& PluginSettingsDAO.getPluginSettings	(	$	conferenceId,
		$	schedConfId,
		$	pluginName
	)

Retrieve and cache all settings for a plugin.

Parameters:

	$conferenceId	int
	$schedConfIf	int
	$pluginName	string

Returns:

array

Definition at line 73 of file PluginSettingsDAO.inc.php.

PluginSettingsDAO.getSetting	(	$	conferenceId,
		$	schedConfId,
		$	pluginName,
		$	name
	)

Retrieve a plugin setting value.

Parameters:

	$conferenceId	int
	$schedConfIf	int
	$pluginName	string
	$name

Returns:

mixed

Definition at line 48 of file PluginSettingsDAO.inc.php.

PluginSettingsDAO.installSettings	(	$	conferenceId,
		$	schedConfId,
		$	pluginName,
		$	filename,
		$	paramArray = array()
	)

Install plugin settings from an XML file.

Parameters:

	$conferenceId	int ID of conference, if applicable
	$schedConfId	int ID of scheduled conference, if applicable
	$pluginName	name of plugin for settings to apply to
	$filename	string Name of XML file to parse and install
	$paramArray	array Optional parameters for variable replacement in settings

Definition at line 247 of file PluginSettingsDAO.inc.php.

References _buildObject(), _performReplacement(), and updateSetting().

PluginSettingsDAO.updateSetting	(	$	conferenceId,
		$	schedConfId,
		$	pluginName,
		$	name,
		$	value,
		$	type = null
	)

Add/update a plugin setting.

Parameters:

	$conferenceId	int
	$schedConfIf	int
	$pluginName	string
	$name	string
	$value	mixed
	$type	string data type of the setting. If omitted, type will be guessed

Definition at line 111 of file PluginSettingsDAO.inc.php.

Referenced by installSettings().

---

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

• classes/plugins/PluginSettingsDAO.inc.php