[ Index ]
 

Code source de Typo3 4.1.3

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/t3lib/ -> class.t3lib_modsettings.php (sommaire)

Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings. Provides a presets box for BE modules. inspired by t3lib_fullsearch

Author: René Fritz <r.fritz@colorcube.de>
Poids: 584 lignes (16 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

t3lib_modSettings:: (13 méthodes):
  init()
  setSessionType()
  setStoreList()
  addToStoreList()
  addToStoreListFromPrefix()
  initStorage()
  cleanupStorageArray()
  compileEntry()
  getStoredData()
  processStoreControl()
  writeStoredSetting()
  getStoreControl()
  processEntry()


Classe: t3lib_modSettings  - X-Ref

Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings.
Provides a presets box for BE modules.

init($prefix='', $storeList='')   X-Ref
Initializes the object

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

setSessionType($type='ses')   X-Ref
Set session type to 'ses' which will store the settings data not permanently.

param: string        Default is 'ses'
return: void

setStoreList($storeList)   X-Ref
Set MOD_SETTINGS keys which should be stored

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

addToStoreList($storeList)   X-Ref
Add MOD_SETTINGS keys to the current list

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

addToStoreListFromPrefix($prefix='')   X-Ref
Add names of keys of the MOD_SETTING array by a prefix

param: string        prefix of MOD_SETTING array keys that should be stored
return: void

initStorage()   X-Ref
Get the stored settings from MOD_SETTINGS and set them in $this->storedSettings

return: void

cleanupStorageArray($storedSettings)   X-Ref
Remove corrupted data entries from the stored settings array

param: array        $storedSettings
return: array        $storedSettings

compileEntry($data)   X-Ref
Creates an entry for the stored settings array
Collects data from MOD_SETTINGS selected by the storeList

param: 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
return: array        $storageArr: entry for the stored settings array

getStoredData($storeIndex, $writeArray=array()   X-Ref
Copies the stored data from entry $index to $writeArray which can be used to set MOD_SETTINGS

param: mixed        The entry key
param: array        Preset data array. Will be overwritten by copied values.
return: array        Data array

processStoreControl($mconfName='')   X-Ref
Processing of the storage command LOAD, SAVE, REMOVE

param: string        Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)
return: string        Storage message. Also set in $this->msg

writeStoredSetting($writeArray=array()   X-Ref
Write the current storage array and update MOD_SETTINGS

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

getStoreControl($showElements='load,remove,save', $useOwnForm=TRUE)   X-Ref
Returns the storage control box

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

processEntry($storageArr)   X-Ref
Processing entry for the stored settings array
Can be overwritten by extended class

param: array        $storageData: entry for the stored settings array
return: array        $storageData: entry for the stored settings array



Généré le : Sun Nov 25 17:13:16 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics