Inheritance diagram for PluginSettingsDAO:

Public Member Functions
	_buildObject ($node, $paramArray=array())

	_cacheMiss ($cache, $id)

	_getCache ($contextId, $pluginName)

	_performReplacement ($rawInput, $paramArray=array())

	deleteByContextId ($contextId)

	deleteSetting ($contextId, $pluginName, $name)

	deleteSettingsByPlugin ($contextId, $pluginName)

	getPluginSettings ($contextId, $pluginName)

	getSetting ($contextId, $pluginName, $name)

	installSettings ($contextId, $pluginName, $filename, $paramArray=array())

	settingExists ($contextId, $pluginName, $name)

	updateSetting ($contextId, $pluginName, $name, $value, $type=null)

Public Member Functions inherited from DAO
	__construct ($dataSource=null, $callHooks=true)

	concat ()

	convertFromDB ($value, $type)

	convertToDB ($value, &$type)

	dateFromDB ($d)

	datetimeFromDB ($dt)

	datetimeToDB ($dt)

	dateToDB ($d)

	flushCache ()

	formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)

	getAdditionalFieldNames ()

	getAffectedRows ()

	getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)

	getDataSource ()

	getDirectionMapping ($direction)

	getDriver ()

	getLocaleFieldNames ()

	getType ($value)

	handleError ($dataSource, $sql)

	nullOrInt ($value)

	replace ($table, $arrFields, $keyCols)

&	retrieve ($sql, $params=false, $callHooks=true)

&	retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)

&	retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)

&	retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)

	setCacheDir ()

	setDataSource ($dataSource)

	update ($sql, $params=false, $callHooks=true, $dieOnError=true)

	updateDataObjectSettings ($tableName, $dataObject, $idArray)

Additional Inherited Members
Static Public Member Functions inherited from DAO
static	getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')

Data Fields inherited from DAO
	$_dataSource

Protected Member Functions inherited from DAO
	_getInsertId ($table='', $id='')

Detailed Description

Operations for retrieving and modifying plugin settings.

See also: Plugin

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

Member Function Documentation

◆ _buildObject()

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().

◆ _cacheMiss()

PluginSettingsDAO::_cacheMiss	(	$cache,
		$id
	)

Callback for a cache miss.

Parameters

$cache	Cache object
$id	string Identifier to look up in cache

Returns: mixed

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

References getPluginSettings().

◆ _getCache()

PluginSettingsDAO::_getCache	(	$contextId,
		$pluginName
	)

Get the cache for plugin settings.

Parameters

$contextId	int Context ID
$pluginName	string Plugin symbolic name

Returns: Cache

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

References CacheManager\getManager().

Referenced by deleteSetting(), deleteSettingsByPlugin(), getPluginSettings(), getSetting(), and updateSetting().

◆ _performReplacement()

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().

◆ deleteByContextId()

PluginSettingsDAO::deleteByContextId ( $contextId )

Delete all settings for a context.

Parameters

$contextId int

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

References DAO\update().

◆ deleteSetting()

PluginSettingsDAO::deleteSetting	(	$contextId,
		$pluginName,
		$name
	)

Delete a plugin setting.

Parameters

$contextId	int
$pluginName	int
$name	string

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

References _getCache(), strtolower_codesafe(), and DAO\update().

◆ deleteSettingsByPlugin()

PluginSettingsDAO::deleteSettingsByPlugin	(	$contextId,
		$pluginName
	)

Delete all settings for a plugin.

Parameters

$contextId	int
$pluginName	string

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

References _getCache(), strtolower_codesafe(), and DAO\update().

◆ getPluginSettings()

PluginSettingsDAO::getPluginSettings	(	$contextId,
		$pluginName
	)

Retrieve and cache all settings for a plugin.

Parameters

$contextId	int Context ID
$pluginName	string Plugin symbolic name

Returns: array

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

References _getCache(), DAO\convertFromDB(), DAO\retrieve(), and strtolower_codesafe().

Referenced by _cacheMiss(), and installSettings().

◆ getSetting()

PluginSettingsDAO::getSetting	(	$contextId,
		$pluginName,
		$name
	)

Retrieve a plugin setting value.

Parameters

$contextId	int Context ID
$pluginName	string Plugin symbolic name
$name	Setting name

Returns: mixed

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

References _getCache(), and strtolower_codesafe().

◆ installSettings()

PluginSettingsDAO::installSettings	(	$contextId,
		$pluginName,
		$filename,
		$paramArray = `array()`
	)

Install plugin settings from an XML file.

Parameters

$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 245 of file PluginSettingsDAO.inc.php.

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

◆ settingExists()

PluginSettingsDAO::settingExists	(	$contextId,
		$pluginName,
		$name
	)

Does the plugin setting exist.

Parameters

$contextId	int Context ID
$pluginName	string Plugin symbolic name
$name	Setting name

Returns: boolean

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

References DAO\retrieve(), and strtolower_codesafe().

◆ updateSetting()

PluginSettingsDAO::updateSetting	(	$contextId,
		$pluginName,
		$name,
		$value,
		$type = `null`
	)

Add/update a plugin setting.

Parameters

$contextId	int Context ID
$pluginName	string Symbolic plugin name
$name	string Setting name
$value	mixed Setting value
$type	string data type of the setting. If omitted, type will be guessed

Returns: int Return value from ADODB's replace() function.

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

References _getCache(), DAO\convertToDB(), DAO\replace(), and strtolower_codesafe().

Referenced by installSettings().

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

PluginSettingsDAO.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _buildObject()

◆ _cacheMiss()

◆ _getCache()

◆ _performReplacement()

◆ deleteByContextId()

◆ deleteSetting()

◆ deleteSettingsByPlugin()

◆ getPluginSettings()

◆ getSetting()

◆ installSettings()

◆ settingExists()

◆ updateSetting()