<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "TYPO3 4.0.1: t3lib_modSettings Class Reference",
"datetime" => "Sat Dec 2 19:26:02 2006",
"date" => "2 Dec 2006",
"doxygenversion" => "1.4.6",
"projectname" => "TYPO3 4.0.1",
"projectnumber" => "4.0.1"
);
get_header($doxygen_vars);
?>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<h1>t3lib_modSettings Class Reference</h1><!-- doxytag: class="t3lib_modSettings" --><a href="classt3lib__modSettings-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#1bf8482f9d45111e26f0853c5873ec9f">init</a> ($prefix='', $storeList='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#6f4199982b334c394e2471b78878dade">setSessionType</a> ($type='ses')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#8f864e129a9fc8898fd76195ba0576cc">setStoreList</a> ($storeList)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#6796f306f8fd14ed9e36d7178d8ababb">addToStoreList</a> ($storeList)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#822e29b3e4adf9818057344effe931ac">addToStoreListFromPrefix</a> ($prefix='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#10ed2bd48c4e882d1e18edd6b8a2fece">initStorage</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#32829620fcae520f9ea6420e12a349e5">cleanupStorageArray</a> ($storedSettings)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#07c9bb67def3e0ccff55a8379de4b4d3">compileEntry</a> ($data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#3a9d1f440328f2a1a2c75db2e2860914">getStoredData</a> ($storeIndex, $writeArray=array())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#c10ed6928d6b4c8b5a494e5e4a39ac95">processStoreControl</a> ($mconfName='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#ac0f359f013c69115b5af64884b144a1">writeStoredSetting</a> ($writeArray=array(), $mconfName='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#d4b50b41e6c01db309886b13c08d645a">getStoreControl</a> ($showElements='load, remove, save', $useOwnForm=TRUE)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#e2bf041e847a284ca9036702b41ce083">processEntry</a> ($storageArr)</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#d9e9a2cf3933622ffbd5cfa85f986484">$type</a> = 'perm'</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#c06bdcf09dd7eb01978d16afb1adbd72">$prefix</a> = ''</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#44fd34b7b5ec8432494f45188d1e571d">$storeList</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#a19143dffe8a909fdb3f3f2676f461d3">$storedSettings</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#8269496ec23e4ab02fc8f7987d1be702">$msg</a> = ''</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#3b454c20035454af30e7cbbbe39cd396">$formName</a> = 'storeControl'</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8e3b7115a928809a06357dacfb224468"></a><!-- doxytag: member="t3lib_modSettings::$writeDevLog" ref="8e3b7115a928809a06357dacfb224468" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__modSettings.html#8e3b7115a928809a06357dacfb224468">$writeDevLog</a> = 0</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00125">125</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6796f306f8fd14ed9e36d7178d8ababb"></a><!-- doxytag: member="t3lib_modSettings::addToStoreList" ref="6796f306f8fd14ed9e36d7178d8ababb" args="($storeList)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::addToStoreList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>storeList</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add MOD_SETTINGS keys to the current list<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>array or string (,) - add names of keys of the MOD_SETTING array which should be stored </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00231">231</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00141">$storeList</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. </td>
</tr>
</table>
<a class="anchor" name="822e29b3e4adf9818057344effe931ac"></a><!-- doxytag: member="t3lib_modSettings::addToStoreListFromPrefix" ref="822e29b3e4adf9818057344effe931ac" args="($prefix='')" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::addToStoreListFromPrefix </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>prefix</em> = <code>''</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add names of keys of the MOD_SETTING array by a prefix<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>prefix of MOD_SETTING array keys that should be stored </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00245">245</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00136">$prefix</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>. </td>
</tr>
</table>
<a class="anchor" name="32829620fcae520f9ea6420e12a349e5"></a><!-- doxytag: member="t3lib_modSettings::cleanupStorageArray" ref="32829620fcae520f9ea6420e12a349e5" args="($storedSettings)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::cleanupStorageArray </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>storedSettings</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove corrupted data entries from the stored settings array<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$storedSettings </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array $storedSettings </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00294">294</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00146">$storedSettings</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00279">initStorage()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00442">writeStoredSetting()</a>. </td>
</tr>
</table>
<a class="anchor" name="07c9bb67def3e0ccff55a8379de4b4d3"></a><!-- doxytag: member="t3lib_modSettings::compileEntry" ref="07c9bb67def3e0ccff55a8379de4b4d3" args="($data)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::compileEntry </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Creates an entry for the stored settings array Collects data from MOD_SETTINGS selected by the storeList<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Should work with data from _GP('storeControl'). This is ['title']: Title for the entry. ['desc']: A description text. Currently not used by this class </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array $storageArr: entry for the stored settings array </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00316">316</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00576">processEntry()</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">processStoreControl()</a>. </td>
</tr>
</table>
<a class="anchor" name="d4b50b41e6c01db309886b13c08d645a"></a><!-- doxytag: member="t3lib_modSettings::getStoreControl" ref="d4b50b41e6c01db309886b13c08d645a" args="($showElements='load, remove, save', $useOwnForm=TRUE)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::getStoreControl </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>showElements</em> = <code>'load</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>remove </td>
<td class="mdname" nowrap>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>save' </td>
<td class="mdname" nowrap>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>useOwnForm</em> = <code>TRUE</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the storage control box<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>List of elemetns which should be shown: load,remove,save </td></tr>
<tr><td valign="top"></td><td valign="top"><em>boolean</em> </td><td>If set the box is wrapped with own form tag </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string HTML code </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00474">474</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00279">initStorage()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. </td>
</tr>
</table>
<a class="anchor" name="3a9d1f440328f2a1a2c75db2e2860914"></a><!-- doxytag: member="t3lib_modSettings::getStoredData" ref="3a9d1f440328f2a1a2c75db2e2860914" args="($storeIndex, $writeArray=array())" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::getStoredData </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>storeIndex</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>writeArray</em> = <code>array()</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Copies the stored data from entry $index to $writeArray which can be used to set MOD_SETTINGS<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>The entry key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Preset data array. Will be overwritten by copied values. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array Data array </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00343">343</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">processStoreControl()</a>. </td>
</tr>
</table>
<a class="anchor" name="1bf8482f9d45111e26f0853c5873ec9f"></a><!-- doxytag: member="t3lib_modSettings::init" ref="1bf8482f9d45111e26f0853c5873ec9f" args="($prefix='', $storeList='')" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::init </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>prefix</em> = <code>''</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>storeList</em> = <code>''</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initializes the object<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Prefix of MOD_SETTING array keys that should be stored </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>additional names of keys of the MOD_SETTING array which should be stored (array or comma list) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00181">181</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00136">$prefix</a>, <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00141">$storeList</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00218">setStoreList()</a>. </td>
</tr>
</table>
<a class="anchor" name="10ed2bd48c4e882d1e18edd6b8a2fece"></a><!-- doxytag: member="t3lib_modSettings::initStorage" ref="10ed2bd48c4e882d1e18edd6b8a2fece" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::initStorage </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the stored settings from MOD_SETTINGS and set them in $this->storedSettings<p>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00279">279</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00146">$storedSettings</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00294">cleanupStorageArray()</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00474">getStoreControl()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">processStoreControl()</a>. </td>
</tr>
</table>
<a class="anchor" name="e2bf041e847a284ca9036702b41ce083"></a><!-- doxytag: member="t3lib_modSettings::processEntry" ref="e2bf041e847a284ca9036702b41ce083" args="($storageArr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::processEntry </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>storageArr</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Processing entry for the stored settings array Can be overwritten by extended class<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$storageData: entry for the stored settings array </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array $storageData: entry for the stored settings array </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00576">576</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00316">compileEntry()</a>. </td>
</tr>
</table>
<a class="anchor" name="c10ed6928d6b4c8b5a494e5e4a39ac95"></a><!-- doxytag: member="t3lib_modSettings::processStoreControl" ref="c10ed6928d6b4c8b5a494e5e4a39ac95" args="($mconfName='')" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::processStoreControl </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>mconfName</em> = <code>''</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Processing of the storage command LOAD, SAVE, REMOVE<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Storage message. Also set in $this->msg </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">360</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00151">$msg</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l00262">t3lib_div::_GP()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04461">t3lib_div::arrayToLogString()</a>, <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00316">compileEntry()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00343">getStoredData()</a>, <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00279">initStorage()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l00967">t3lib_div::shortMD5()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00442">writeStoredSetting()</a>. </td>
</tr>
</table>
<a class="anchor" name="6f4199982b334c394e2471b78878dade"></a><!-- doxytag: member="t3lib_modSettings::setSessionType" ref="6f4199982b334c394e2471b78878dade" args="($type='ses')" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::setSessionType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>type</em> = <code>'ses'</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set session type to 'ses' which will store the settings data not permanently.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Default is 'ses' </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00197">197</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00131">$type</a>. </td>
</tr>
</table>
<a class="anchor" name="8f864e129a9fc8898fd76195ba0576cc"></a><!-- doxytag: member="t3lib_modSettings::setStoreList" ref="8f864e129a9fc8898fd76195ba0576cc" args="($storeList)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::setStoreList </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>storeList</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set MOD_SETTINGS keys which should be stored<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mixed</em> </td><td>array or string (,) - set additional names of keys of the MOD_SETTING array which should be stored </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00218">218</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00141">$storeList</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, and <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00181">init()</a>. </td>
</tr>
</table>
<a class="anchor" name="ac0f359f013c69115b5af64884b144a1"></a><!-- doxytag: member="t3lib_modSettings::writeStoredSetting" ref="ac0f359f013c69115b5af64884b144a1" args="($writeArray=array(), $mconfName='')" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::writeStoredSetting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>writeArray</em> = <code>array()</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>$ </td>
<td class="mdname" nowrap> <em>mconfName</em> = <code>''</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Write the current storage array and update MOD_SETTINGS<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Array of settings which should be overwrite current MOD_SETTINGS </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00442">442</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
References <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00294">cleanupStorageArray()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, and <a class="el" href="class_8t3lib__befunc_8php-source.html#l02492">t3lib_BEfunc::getModuleData()</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">processStoreControl()</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="3b454c20035454af30e7cbbbe39cd396"></a><!-- doxytag: member="t3lib_modSettings::$formName" ref="3b454c20035454af30e7cbbbe39cd396" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$formName = 'storeControl' </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Name of the form. Needed for JS
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00157">157</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>. </td>
</tr>
</table>
<a class="anchor" name="8269496ec23e4ab02fc8f7987d1be702"></a><!-- doxytag: member="t3lib_modSettings::$msg" ref="8269496ec23e4ab02fc8f7987d1be702" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$msg = '' </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Message from the last storage command
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00151">151</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00360">processStoreControl()</a>. </td>
</tr>
</table>
<a class="anchor" name="c06bdcf09dd7eb01978d16afb1adbd72"></a><!-- doxytag: member="t3lib_modSettings::$prefix" ref="c06bdcf09dd7eb01978d16afb1adbd72" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$prefix = '' </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
prefix of MOD_SETTING array keys that should be stored
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00136">136</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00245">addToStoreListFromPrefix()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00181">init()</a>. </td>
</tr>
</table>
<a class="anchor" name="a19143dffe8a909fdb3f3f2676f461d3"></a><!-- doxytag: member="t3lib_modSettings::$storedSettings" ref="a19143dffe8a909fdb3f3f2676f461d3" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$storedSettings = array() </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The stored settings array
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00146">146</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00294">cleanupStorageArray()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00279">initStorage()</a>. </td>
</tr>
</table>
<a class="anchor" name="44fd34b7b5ec8432494f45188d1e571d"></a><!-- doxytag: member="t3lib_modSettings::$storeList" ref="44fd34b7b5ec8432494f45188d1e571d" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$storeList = array() </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Names of keys of the MOD_SETTING array which should be stored
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00141">141</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00231">addToStoreList()</a>, <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00181">init()</a>, and <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00218">setStoreList()</a>. </td>
</tr>
</table>
<a class="anchor" name="d9e9a2cf3933622ffbd5cfa85f986484"></a><!-- doxytag: member="t3lib_modSettings::$type" ref="d9e9a2cf3933622ffbd5cfa85f986484" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">t3lib_modSettings::$type = 'perm' </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
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.
<p>
Definition at line <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00131">131</a> of file <a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__modsettings_8php-source.html#l00197">setSessionType()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>typo3_src-4.0.1/t3lib/<a class="el" href="class_8t3lib__modsettings_8php-source.html">class.t3lib_modsettings.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>