<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "TYPO3 4.0.1: t3lib_arrayBrowser Class Reference",
"datetime" => "Sat Dec 2 19:25:43 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_arrayBrowser Class Reference</h1><!-- doxytag: class="t3lib_arrayBrowser" --><a href="classt3lib__arrayBrowser-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__arrayBrowser.html#714a3c6d4dacbd22307d48da99d62967">tree</a> ($arr, $depth_in, $depthData)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#edfa302d0b8f2bd68f37a8749a3a2297">wrapValue</a> ($theValue, $depth)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#fc127256ada8fdcee2780024bc62b234">wrapArrayKey</a> ($label, $depth, $theValue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#9db35c9c58b12b6a38d61bd657d2ed95">getSearchKeys</a> ($keyArr, $depth_in, $searchString, $keyArray)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#f2c7a492e0b8a6f73fab91129f1c591e">fixed_lgd</a> ($string, $chars)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#851ca13c796032a10d57c4f8684bcde6">depthKeys</a> ($arr, $settings)</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="c528cbf40ad05160d0bb1a781c7d9e0b"></a><!-- doxytag: member="t3lib_arrayBrowser::$expAll" ref="c528cbf40ad05160d0bb1a781c7d9e0b" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#c528cbf40ad05160d0bb1a781c7d9e0b">$expAll</a> = FALSE</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c9e7d69f7ef05d22579f4bb6849feb2"></a><!-- doxytag: member="t3lib_arrayBrowser::$dontLinkVar" ref="2c9e7d69f7ef05d22579f4bb6849feb2" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#2c9e7d69f7ef05d22579f4bb6849feb2">$dontLinkVar</a> = FALSE</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="723f3c2a2dcae4efd82cb258751c6ca1"></a><!-- doxytag: member="t3lib_arrayBrowser::$depthKeys" ref="723f3c2a2dcae4efd82cb258751c6ca1" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#723f3c2a2dcae4efd82cb258751c6ca1">$depthKeys</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b936c85529362fbe74014a7beda1a5e6"></a><!-- doxytag: member="t3lib_arrayBrowser::$searchKeys" ref="b936c85529362fbe74014a7beda1a5e6" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#b936c85529362fbe74014a7beda1a5e6">$searchKeys</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3881ffde18574e815c1299c7aea16ab1"></a><!-- doxytag: member="t3lib_arrayBrowser::$fixedLgd" ref="3881ffde18574e815c1299c7aea16ab1" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#3881ffde18574e815c1299c7aea16ab1">$fixedLgd</a> = 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f74fe1165170ef4b56ab4d4f24452e7"></a><!-- doxytag: member="t3lib_arrayBrowser::$regexMode" ref="7f74fe1165170ef4b56ab4d4f24452e7" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#7f74fe1165170ef4b56ab4d4f24452e7">$regexMode</a> = 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb4f6dfc979c5c5f23ecad3e6482d30b"></a><!-- doxytag: member="t3lib_arrayBrowser::$varName" ref="fb4f6dfc979c5c5f23ecad3e6482d30b" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classt3lib__arrayBrowser.html#fb4f6dfc979c5c5f23ecad3e6482d30b">$varName</a> = ''</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00077">77</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="851ca13c796032a10d57c4f8684bcde6"></a><!-- doxytag: member="t3lib_arrayBrowser::depthKeys" ref="851ca13c796032a10d57c4f8684bcde6" args="($arr, $settings)" --><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_arrayBrowser::depthKeys </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>arr</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>settings</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>
Function modifying the depthKey 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>Array with instructions to open/close nodes. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Input depth_key array </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array Output depth_key array with entries added/removed based on $arr </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classSC__mod__tools__config__index.html#f8cd3dc8fe12fefcdbcbe9f14a26153e">SC_mod_tools_config_index::main()</a> </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00245">245</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00096">tree()</a>. </td>
</tr>
</table>
<a class="anchor" name="f2c7a492e0b8a6f73fab91129f1c591e"></a><!-- doxytag: member="t3lib_arrayBrowser::fixed_lgd" ref="f2c7a492e0b8a6f73fab91129f1c591e" args="($string, $chars)" --><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_arrayBrowser::fixed_lgd </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>string</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>chars</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>
Fixed length function<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 process </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>Max number of chars </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Processed string </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00228">228</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00096">tree()</a>. </td>
</tr>
</table>
<a class="anchor" name="9db35c9c58b12b6a38d61bd657d2ed95"></a><!-- doxytag: member="t3lib_arrayBrowser::getSearchKeys" ref="9db35c9c58b12b6a38d61bd657d2ed95" args="($keyArr, $depth_in, $searchString, $keyArray)" --><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_arrayBrowser::getSearchKeys </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>keyArr</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>depth_in</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>searchString</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>keyArray</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>
Creates an array with "depthKeys" which will expand the array to show the search results<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>The array to search for the value </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Depth string - blank for first call (will build up during recursive calling creating an id of the position: [key1].[key2].[key3] </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The string to search for </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Key array, for first call pass empty array </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00196">196</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>. </td>
</tr>
</table>
<a class="anchor" name="714a3c6d4dacbd22307d48da99d62967"></a><!-- doxytag: member="t3lib_arrayBrowser::tree" ref="714a3c6d4dacbd22307d48da99d62967" args="($arr, $depth_in, $depthData)" --><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_arrayBrowser::tree </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>arr</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>depth_in</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>depthData</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>
Make browsable tree Before calling this function you may want to set some of the internal vars like depthKeys, regexMode and fixedLgd. For examples see <a class="el" href="classSC__mod__tools__config__index.html#f8cd3dc8fe12fefcdbcbe9f14a26153e">SC_mod_tools_config_index::main()</a><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>The array to display </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Key-position id. Build up during recursive calls - [key1].[key2].[key3] - an so on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Depth-data - basically a prefix for the icons. For calling this function from outside, let it stay blank. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string HTML for the tree </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classSC__mod__tools__config__index.html#f8cd3dc8fe12fefcdbcbe9f14a26153e">SC_mod_tools_config_index::main()</a> </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00096">96</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>.
<p>
References <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00245">depthKeys()</a>, <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00228">fixed_lgd()</a>, <a class="el" href="class_8t3lib__iconworks_8php-source.html#l00264">t3lib_iconWorks::skinImg()</a>, and <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00172">wrapArrayKey()</a>. </td>
</tr>
</table>
<a class="anchor" name="fc127256ada8fdcee2780024bc62b234"></a><!-- doxytag: member="t3lib_arrayBrowser::wrapArrayKey" ref="fc127256ada8fdcee2780024bc62b234" args="($label, $depth, $theValue)" --><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_arrayBrowser::wrapArrayKey </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>label</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>depth</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>theValue</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>
Wrapping the value in bold tags etc.<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>The title string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Depth path </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>The value for the array entry. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Title string, htmlspecialchars()'ed </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00172">172</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l01120">t3lib_div::testInt()</a>.
<p>
Referenced by <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00096">tree()</a>. </td>
</tr>
</table>
<a class="anchor" name="edfa302d0b8f2bd68f37a8749a3a2297"></a><!-- doxytag: member="t3lib_arrayBrowser::wrapValue" ref="edfa302d0b8f2bd68f37a8749a3a2297" args="($theValue, $depth)" --><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_arrayBrowser::wrapValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>theValue</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>depth</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>
Wrapping the value in bold tags etc.<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>The title string </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>Depth path </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string Title string, htmlspecialchars()'ed </dd></dl>
<p>
Definition at line <a class="el" href="class_8t3lib__arraybrowser_8php-source.html#l00160">160</a> of file <a class="el" href="class_8t3lib__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</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__arraybrowser_8php-source.html">class.t3lib_arraybrowser.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>