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 | |
Definition at line 125 of file class.t3lib_modsettings.php.
| t3lib_modSettings::init | ( | $ | prefix = '', |
|
| $ | storeList = '' | |||
| ) |
Initializes the object
| 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) |
Definition at line 181 of file class.t3lib_modsettings.php.
| t3lib_modSettings::setSessionType | ( | $ | type = 'ses' |
) |
Set session type to 'ses' which will store the settings data not permanently.
| string | Default is 'ses' |
Definition at line 197 of file class.t3lib_modsettings.php.
| t3lib_modSettings::setStoreList | ( | $ | storeList | ) |
Set MOD_SETTINGS keys which should be stored
| mixed | array or string (,) - set additional names of keys of the MOD_SETTING array which should be stored |
Definition at line 218 of file class.t3lib_modsettings.php.
| t3lib_modSettings::addToStoreList | ( | $ | storeList | ) |
Add MOD_SETTINGS keys to the current list
| mixed | array or string (,) - add names of keys of the MOD_SETTING array which should be stored |
Definition at line 231 of file class.t3lib_modsettings.php.
| t3lib_modSettings::addToStoreListFromPrefix | ( | $ | prefix = '' |
) |
Add names of keys of the MOD_SETTING array by a prefix
| string | prefix of MOD_SETTING array keys that should be stored |
Definition at line 245 of file class.t3lib_modsettings.php.
| t3lib_modSettings::initStorage | ( | ) |
Get the stored settings from MOD_SETTINGS and set them in $this->storedSettings
Definition at line 279 of file class.t3lib_modsettings.php.
| t3lib_modSettings::cleanupStorageArray | ( | $ | storedSettings | ) |
Remove corrupted data entries from the stored settings array
| array | $storedSettings |
Definition at line 294 of file class.t3lib_modsettings.php.
| t3lib_modSettings::compileEntry | ( | $ | data | ) |
Creates an entry for the stored settings array Collects data from MOD_SETTINGS selected by the storeList
| 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 |
Definition at line 316 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
| mixed | The entry key | |
| array | Preset data array. Will be overwritten by copied values. |
Definition at line 343 of file class.t3lib_modsettings.php.
| t3lib_modSettings::processStoreControl | ( | $ | mconfName = '' |
) |
Processing of the storage command LOAD, SAVE, REMOVE
| string | Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module) |
Definition at line 360 of file class.t3lib_modsettings.php.
| t3lib_modSettings::writeStoredSetting | ( | $ | writeArray = array(), |
|
| $ | mconfName = '' | |||
| ) |
Write the current storage array and update MOD_SETTINGS
| 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) |
Definition at line 442 of file class.t3lib_modsettings.php.
| t3lib_modSettings::getStoreControl | ( | $ | showElements = 'load, |
|
| remove | , | |||
| save' | , | |||
| $ | useOwnForm = TRUE | |||
| ) |
Returns the storage control box
| string | List of elemetns which should be shown: load,remove,save | |
| boolean | If set the box is wrapped with own form tag |
Definition at line 474 of file class.t3lib_modsettings.php.
| t3lib_modSettings::processEntry | ( | $ | storageArr | ) |
Processing entry for the stored settings array Can be overwritten by extended class
| array | $storageData: entry for the stored settings array |
Definition at line 576 of file class.t3lib_modsettings.php.
| 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.
| t3lib_modSettings::$prefix = '' |
prefix of MOD_SETTING array keys that should be stored
Definition at line 136 of file class.t3lib_modsettings.php.
| 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.
| t3lib_modSettings::$storedSettings = array() |
The stored settings array
Definition at line 146 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.
| t3lib_modSettings::$formName = 'storeControl' |
Name of the form. Needed for JS
Definition at line 157 of file class.t3lib_modsettings.php.