<?php include_once '../doc-typo3-funcs.php'; $doxygen_vars = array( "title" => "TYPO3 4.0.1: t3lib_loadModules Class Reference", "datetime" => "Sat Dec 2 19:26:01 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_loadModules Class Reference</h1><!-- doxytag: class="t3lib_loadModules" --><a href="classt3lib__loadModules-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__loadModules.html#1cc1636a64c56d783f417c29b517796d">load</a> ($modulesArray, $BE_USER='')</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#9003ffc12a98ad77d7cdb3d0c44220d4">checkExtensionModule</a> ($name)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#1523cfeeed47f69dd96062fb0c31e2cb">checkMod</a> ($name, $fullpath)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#8dc082ef6960153b9931edb72bf7824e">checkModAccess</a> ($name, $MCONF)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#8365e7927576bcccd18f711ead607a15">checkModWorkspace</a> ($name, $MCONF)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#29b52bda8edcffa6924c46c50c22608c">parseModulesArray</a> ($arr)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#657bac9c9b947e18e266250af5dc6ed6">cleanName</a> ($str)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#a1110dc989ad6da834c79b9d3ec3d881">getRelativePath</a> ($baseDir, $destDir)</td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd326a313573f746dc78abbc1d4736ad"></a><!-- doxytag: member="t3lib_loadModules::$modules" ref="dd326a313573f746dc78abbc1d4736ad" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#dd326a313573f746dc78abbc1d4736ad">$modules</a> = Array()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47f80d58ae322af29151edd29fd1024b"></a><!-- doxytag: member="t3lib_loadModules::$absPathArray" ref="47f80d58ae322af29151edd29fd1024b" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#47f80d58ae322af29151edd29fd1024b">$absPathArray</a> = array()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b1c033f6c33fd0af40d0ff93c7118b8"></a><!-- doxytag: member="t3lib_loadModules::$modListGroup" ref="5b1c033f6c33fd0af40d0ff93c7118b8" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#5b1c033f6c33fd0af40d0ff93c7118b8">$modListGroup</a> = Array()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2a748fd8537e6d7d5bb8bb2074759989"></a><!-- doxytag: member="t3lib_loadModules::$modListUser" ref="2a748fd8537e6d7d5bb8bb2074759989" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#2a748fd8537e6d7d5bb8bb2074759989">$modListUser</a> = Array()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9eb0f37e3fbc0f5944eddf276914b91e"></a><!-- doxytag: member="t3lib_loadModules::$BE_USER" ref="9eb0f37e3fbc0f5944eddf276914b91e" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#9eb0f37e3fbc0f5944eddf276914b91e">$BE_USER</a> = ''</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a434524adf47edeb713f195030c0331d"></a><!-- doxytag: member="t3lib_loadModules::$observeWorkspaces" ref="a434524adf47edeb713f195030c0331d" args="" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__loadModules.html#a434524adf47edeb713f195030c0331d">$observeWorkspaces</a> = FALSE</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <p> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00079">79</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>.<hr><h2>Member Function Documentation</h2> <a class="anchor" name="9003ffc12a98ad77d7cdb3d0c44220d4"></a><!-- doxytag: member="t3lib_loadModules::checkExtensionModule" ref="9003ffc12a98ad77d7cdb3d0c44220d4" args="($name)" --><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_loadModules::checkExtensionModule </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>name</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> If the module name ($name) is a module from an extension (has path in $this->absPathArray) then that path is returned relative to PATH_site<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>Module name </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string If found, the relative path from PATH_site </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00370">370</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00099">load()</a>. </td> </tr> </table> <a class="anchor" name="1523cfeeed47f69dd96062fb0c31e2cb"></a><!-- doxytag: member="t3lib_loadModules::checkMod" ref="1523cfeeed47f69dd96062fb0c31e2cb" args="($name, $fullpath)" --><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_loadModules::checkMod </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>name</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>fullpath</em></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> Here we check for the module. Return values: 'notFound': If the module was not found in the path (no "conf.php" file) false: If no access to the module (access check failed) array(): Configuration array, in case a valid module where access IS granted exists.<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>Module name </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Absolute path to module </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>mixed See description of function </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00389">389</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> References <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00471">checkModAccess()</a>, <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00495">checkModWorkspace()</a>, <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00559">getRelativePath()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l02665">t3lib_div::resolveBackPath()</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00099">load()</a>. </td> </tr> </table> <a class="anchor" name="8dc082ef6960153b9931edb72bf7824e"></a><!-- doxytag: member="t3lib_loadModules::checkModAccess" ref="8dc082ef6960153b9931edb72bf7824e" args="($name, $MCONF)" --><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_loadModules::checkModAccess </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>name</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>MCONF</em></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 true if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)<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>Module name </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>boolean True if access is granted for $this->BE_USER </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00471">471</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00389">checkMod()</a>. </td> </tr> </table> <a class="anchor" name="8365e7927576bcccd18f711ead607a15"></a><!-- doxytag: member="t3lib_loadModules::checkModWorkspace" ref="8365e7927576bcccd18f711ead607a15" args="($name, $MCONF)" --><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_loadModules::checkModWorkspace </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>name</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>MCONF</em></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> Check if a module is allowed inside the current workspace for be user Processing happens only if $this->observeWorkspaces is TRUE<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>Module name </td></tr> <tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>boolean True if access is granted for $this->BE_USER </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00495">495</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> References <a class="el" href="class_8t3lib__div_8php-source.html#l00835">t3lib_div::inList()</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00389">checkMod()</a>. </td> </tr> </table> <a class="anchor" name="657bac9c9b947e18e266250af5dc6ed6"></a><!-- doxytag: member="t3lib_loadModules::cleanName" ref="657bac9c9b947e18e266250af5dc6ed6" args="($str)" --><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_loadModules::cleanName </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>str</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> The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters<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>String to clean up </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00548">548</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. </td> </tr> </table> <a class="anchor" name="a1110dc989ad6da834c79b9d3ec3d881"></a><!-- doxytag: member="t3lib_loadModules::getRelativePath" ref="a1110dc989ad6da834c79b9d3ec3d881" args="($baseDir, $destDir)" --><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_loadModules::getRelativePath </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>baseDir</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>destDir</em></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> Get relative path for $destDir compared to $baseDir<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>Base directory </td></tr> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Destination directory </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>string The relative path of destination compared to base. </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00559">559</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00389">checkMod()</a>. </td> </tr> </table> <a class="anchor" name="1cc1636a64c56d783f417c29b517796d"></a><!-- doxytag: member="t3lib_loadModules::load" ref="1cc1636a64c56d783f417c29b517796d" args="($modulesArray, $BE_USER='')" --><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_loadModules::load </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname" nowrap> <em>modulesArray</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>BE_USER</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> Init. The outcome of the <a class="el" href="classt3lib__loadModules.html#1cc1636a64c56d783f417c29b517796d">load()</a> function will be a $this->modules array populated with the backend module structure available to the BE_USER Further the global var $LANG will have labels and images for the modules loaded in an internal 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>$modulesArray should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user) </td></tr> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Optional backend user object to use. If not set, the global BE_USER object is used. </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__loadmodules_8php-source.html#l00099">99</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> References <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00086">$BE_USER</a>, <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00370">checkExtensionModule()</a>, <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00389">checkMod()</a>, and <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00519">parseModulesArray()</a>. </td> </tr> </table> <a class="anchor" name="29b52bda8edcffa6924c46c50c22608c"></a><!-- doxytag: member="t3lib_loadModules::parseModulesArray" ref="29b52bda8edcffa6924c46c50c22608c" args="($arr)" --><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_loadModules::parseModulesArray </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">$ </td> <td class="mdname1" valign="top" nowrap> <em>arr</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> Parses the moduleArray ($TBE_MODULES) into a internally useful structure. Returns an array where the keys are names of the module and the values may be true (only module) or an array (of submodules)<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>moduleArray ($TBE_MODULES) </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>array Output structure with available modules </dd></dl> <p> Definition at line <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00519">519</a> of file <a class="el" href="class_8t3lib__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a>. <p> References <a class="el" href="incfile_8php-source.html#l00011">t3lib_div::trimExplode()</a>. <p> Referenced by <a class="el" href="class_8t3lib__loadmodules_8php-source.html#l00099">load()</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__loadmodules_8php-source.html">class.t3lib_loadmodules.php</a></ul> <?php include_once '../doc-typo3-funcs.php'; get_footer(); ?>