t3lib_modSettings Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	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)
Öffentliche Attribute
	$type = 'perm'
	$prefix = ''
	$storeList = array()
	$storedSettings = array()
	$msg = ''
	$formName = 'storeControl'
	$writeDevLog = 0

---

Dokumentation der Elementfunktionen

t3lib_modSettings::addToStoreList

(

$

storeList

)

Add MOD_SETTINGS keys to the current list

Parameter:

mixed

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

Rückgabe:

void

t3lib_modSettings::addToStoreListFromPrefix

(

$

prefix = ''

)

Add names of keys of the MOD_SETTING array by a prefix

Parameter:

string

prefix of MOD_SETTING array keys that should be stored

Rückgabe:

void

t3lib_modSettings::cleanupStorageArray

(

$

storedSettings

)

Remove corrupted data entries from the stored settings array

Parameter:

array

$storedSettings

Rückgabe:

array $storedSettings

t3lib_modSettings::compileEntry

(

$

data

)

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

Parameter:

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

Rückgabe:

array $storageArr: entry for the stored settings array

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

Returns the storage control box

Parameter:

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

Rückgabe:

string HTML code

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

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

Parameter:

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

Rückgabe:

array Data array

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

Initializes the object

Parameter:

	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)

Rückgabe:

void

t3lib_modSettings::initStorage

(

)

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

Rückgabe:

void

t3lib_modSettings::processEntry

(

$

storageArr

)

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

Parameter:

array

$storageData: entry for the stored settings array

Rückgabe:

array $storageData: entry for the stored settings array

t3lib_modSettings::processStoreControl

(

$

mconfName = ''

)

Processing of the storage command LOAD, SAVE, REMOVE

Parameter:

string

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

Rückgabe:

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

t3lib_modSettings::setSessionType

(

$

type = 'ses'

)

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

Parameter:

string

Default is 'ses'

Rückgabe:

void

t3lib_modSettings::setStoreList

(

$

storeList

)

Set MOD_SETTINGS keys which should be stored

Parameter:

mixed

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

Rückgabe:

void

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

Write the current storage array and update MOD_SETTINGS

Parameter:

	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)

Rückgabe:

void

---

Dokumentation der Datenelemente

t3lib_modSettings::$formName = 'storeControl'

Name of the form. Needed for JS

t3lib_modSettings::$msg = ''

Message from the last storage command

t3lib_modSettings::$prefix = ''

prefix of MOD_SETTING array keys that should be stored

t3lib_modSettings::$storedSettings = array()

The stored settings array

t3lib_modSettings::$storeList = array()

Names of keys of the MOD_SETTING array which should be stored

t3lib_modSettings::$type = 'perm'

If type is set 'ses' then the module data will be stored into the session and will be lost with logout. Type 'perm' will store the data permanently.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_modsettings.php