Public Member Functions
	init ($prefix= '', $storeList= '')
	setSessionType ($type= 'ses')
	setStoreList ($storeList)
	addToStoreList ($storeList)
	addToStoreListFromPrefix ($prefix= '')
	initStorage ()
	cleanupStorageArray ($storedSettings)
	compileEntry ($data)
	getStoredData ($storeIndex, $writeArray=array())
	processStoreControl ($mconfName= '')
	writeStoredSetting ($writeArray=array(), $mconfName= '')
	getStoreControl ($showElements= 'load, remove, save', $useOwnForm=TRUE)
	processEntry ($storageArr)
Public Attributes
	$type = 'perm'
	$prefix = ''
	$storeList = array()
	$storedSettings = array()
	$msg = ''
	$formName = 'storeControl'
	$writeDevLog = 0

Detailed Description

Definition at line 123 of file class.t3lib_modsettings.php.

Member Function Documentation

t3lib_modSettings::addToStoreList ( $ storeList )

Add MOD_SETTINGS keys to the current list

Parameters:

mixed array or string (,) - add names of keys of the MOD_SETTING array which should be stored

Returns:: void

Definition at line 228 of file class.t3lib_modsettings.php.

References $storeList, t3lib_div\devLog(), and t3lib_div\trimExplode().

t3lib_modSettings::addToStoreListFromPrefix ( $ prefix = '' )

Add names of keys of the MOD_SETTING array by a prefix

Parameters:

string prefix of MOD_SETTING array keys that should be stored

Returns:: void

Definition at line 244 of file class.t3lib_modsettings.php.

References $prefix, $SOBE, $value, and t3lib_div\devLog().

t3lib_modSettings::cleanupStorageArray ( $ storedSettings )

Remove corrupted data entries from the stored settings array

Parameters:

array $storedSettings

Returns:: array $storedSettings

Definition at line 289 of file class.t3lib_modsettings.php.

References $storedSettings.

Referenced by initStorage(), and writeStoredSetting().

t3lib_modSettings::compileEntry ( $ data )

Creates an entry for the stored settings array Collects data from MOD_SETTINGS selected by the storeList

Parameters:

array Should work with data from _GP('storeControl'). This is ['title']: Title for the entry. ['desc']: A description text. Currently not used by this class

Returns:: array $storageArr: entry for the stored settings array

Definition at line 317 of file class.t3lib_modsettings.php.

References $GLOBALS, $SOBE, and processEntry().

Referenced by processStoreControl().

t3lib_modSettings::getStoreControl	(	$	showElements = `'load`,
		remove	,
		save'	,
		$	useOwnForm = `TRUE`
	)

Returns the storage control box

Parameters:

string	List of elemetns which should be shown: load,remove,save
boolean	If set the box is wrapped with own form tag

Returns:: string HTML code

Definition at line 473 of file class.t3lib_modsettings.php.

References $TYPO3_CONF_VARS, t3lib_div\getIndpEnv(), initStorage(), and t3lib_div\trimExplode().

t3lib_modSettings::getStoredData	(	$	storeIndex,
		$	writeArray = `array()`
	)

Copies the stored data from entry $index to $writeArray which can be used to set MOD_SETTINGS

Parameters:

mixed	The entry key
array	Preset data array. Will be overwritten by copied values.

Returns:: array Data array

Definition at line 344 of file class.t3lib_modsettings.php.

Referenced by processStoreControl().

t3lib_modSettings::init	(	$	prefix = `''`,
		$	storeList = `''`
	)

Initializes the object

Parameters:

string	Prefix of MOD_SETTING array keys that should be stored
array	additional names of keys of the MOD_SETTING array which should be stored (array or comma list)

Returns:: void

Definition at line 175 of file class.t3lib_modsettings.php.

References $GLOBALS, $prefix, $storeList, and setStoreList().

t3lib_modSettings::initStorage ( )

Get the stored settings from MOD_SETTINGS and set them in $this->storedSettings

Returns:: void

Definition at line 275 of file class.t3lib_modsettings.php.

References $SOBE, $storedSettings, and cleanupStorageArray().

Referenced by getStoreControl(), and processStoreControl().

t3lib_modSettings::processEntry ( $ storageArr )

Processing entry for the stored settings array Can be overwritten by extended class

Parameters:

array $storageData,: entry for the stored settings array

Returns:: array $storageData: entry for the stored settings array

Definition at line 572 of file class.t3lib_modsettings.php.

Referenced by compileEntry().

t3lib_modSettings::processStoreControl ( $ mconfName = '' )

Processing of the storage command LOAD, SAVE, REMOVE

Parameters:

string Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)

Returns:: string Storage message. Also set in $this->msg

Definition at line 360 of file class.t3lib_modsettings.php.

References $msg, t3lib_div\_GP(), t3lib_div\arrayToLogString(), compileEntry(), t3lib_div\devLog(), getStoredData(), initStorage(), t3lib_div\shortMD5(), and writeStoredSetting().

t3lib_modSettings::setSessionType ( $ type = 'ses' )

Set session type to 'ses' which will store the settings data not permanently.

Parameters:

string Default is 'ses'

Returns:: void

Definition at line 195 of file class.t3lib_modsettings.php.

References $type.

t3lib_modSettings::setStoreList ( $ storeList )

Set MOD_SETTINGS keys which should be stored

Parameters:

mixed array or string (,) - set additional names of keys of the MOD_SETTING array which should be stored

Returns:: void

Definition at line 213 of file class.t3lib_modsettings.php.

References $storeList, t3lib_div\devLog(), and t3lib_div\trimExplode().

Referenced by init().

t3lib_modSettings::writeStoredSetting	(	$	writeArray = `array()`,
		$	mconfName = `''`
	)

Write the current storage array and update MOD_SETTINGS

Parameters:

array	Array of settings which should be overwrite current MOD_SETTINGS
string	Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)