Documentation TYPO3 par Ameos

t3lib_modSettings Class Reference

List of all members.

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)
 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 125 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 231 of file class.t3lib_modsettings.php.

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

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 231 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 245 of file class.t3lib_modsettings.php.

References $prefix, and t3lib_div::devLog().

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 245 of file class.t3lib_modsettings.php.

References $prefix, 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 294 of file class.t3lib_modsettings.php.

References $storedSettings.

t3lib_modSettings::cleanupStorageArray storedSettings  ) 
 

Remove corrupted data entries from the stored settings array

Parameters:
array $storedSettings
Returns:
array $storedSettings

Definition at line 294 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 316 of file class.t3lib_modsettings.php.

References processEntry().

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 316 of file class.t3lib_modsettings.php.

References 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 474 of file class.t3lib_modsettings.php.

References initStorage(), and t3lib_div::trimExplode().

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 474 of file class.t3lib_modsettings.php.

References 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 343 of file class.t3lib_modsettings.php.

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 343 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 181 of file class.t3lib_modsettings.php.

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

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 181 of file class.t3lib_modsettings.php.

References $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 279 of file class.t3lib_modsettings.php.

References $storedSettings, and cleanupStorageArray().

t3lib_modSettings::initStorage  ) 
 

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

Returns:
void

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

References $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 576 of file class.t3lib_modsettings.php.

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 576 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::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 197 of file class.t3lib_modsettings.php.

References $type.

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 197 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 218 of file class.t3lib_modsettings.php.

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

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 218 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)
Returns:
void

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

References cleanupStorageArray(), t3lib_div::devLog(), and t3lib_BEfunc::getModuleData().

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)
Returns:
void

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

References cleanupStorageArray(), t3lib_div::devLog(), and t3lib_BEfunc::getModuleData().

Referenced by processStoreControl().


Member Data Documentation

t3lib_modSettings::$formName = 'storeControl'
 

Name of the form. Needed for JS

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

t3lib_modSettings::$msg = ''
 

Message from the last storage command

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

Referenced by processStoreControl().

t3lib_modSettings::$prefix = ''
 

prefix of MOD_SETTING array keys that should be stored

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

Referenced by addToStoreListFromPrefix(), and init().

t3lib_modSettings::$storedSettings = array()
 

The stored settings array

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

Referenced by cleanupStorageArray(), and initStorage().

t3lib_modSettings::$storeList = array()
 

Names of keys of the MOD_SETTING array which should be stored

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

Referenced by addToStoreList(), init(), and setStoreList().

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.

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

Referenced by setSessionType().


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


Généré par Les experts TYPO3 avec  doxygen 1.4.6