<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "TYPO3 4.0.1: tx_sv_auth Class Reference",
"datetime" => "Sat Dec 2 19:27:24 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>tx_sv_auth Class Reference</h1><!-- doxytag: class="tx_sv_auth" --><!-- doxytag: inherits="tx_sv_authbase" -->Inheritance diagram for tx_sv_auth:<p><center><img src="classtx__sv__auth__inherit__graph.png" border="0" usemap="#tx__sv__auth__inherit__map" alt="Inheritance graph"></center>
<map name="tx__sv__auth__inherit__map">
<area href="classtx__sv__authbase.html" shape="rect" coords="5,7,144,228" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for tx_sv_auth:<p><center><img src="classtx__sv__auth__coll__graph.png" border="0" usemap="#tx__sv__auth__coll__map" alt="Collaboration graph"></center>
<map name="tx__sv__auth__coll__map">
<area href="classtx__sv__authbase.html" shape="rect" coords="5,7,144,228" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classtx__sv__auth-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="classtx__sv__auth.html#4550c596fded23d3cacc4b222e612155">getUser</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__auth.html#4b497698e0fa894bf54469262f520fb6">authUser</a> ($user)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__auth.html#41f8024e52408155547623a24c356828">getGroups</a> ($user, $knownGroups)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__auth.html#b71e3e1746af41540373baf8bf5cf7cd">getSubGroups</a> ($grList, $idList='', &$groups)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8tx__sv__auth_8php-source.html#l00056">56</a> of file <a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4b497698e0fa894bf54469262f520fb6"></a><!-- doxytag: member="tx_sv_auth::authUser" ref="4b497698e0fa894bf54469262f520fb6" args="($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">tx_sv_auth::authUser </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname1" valign="top" nowrap> <em>user</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>
Authenticate a user (Check various conditions for the user that might invalidate its authentication, eg. password match, domain, IP, 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>array</em> </td><td>Data of user. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>boolean </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__auth_8php-source.html#l00089">89</a> of file <a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a>.
<p>
References <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00110">tx_sv_authbase::compareUident()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, and <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00129">tx_sv_authbase::writelog()</a>. </td>
</tr>
</table>
<a class="anchor" name="41f8024e52408155547623a24c356828"></a><!-- doxytag: member="tx_sv_auth::getGroups" ref="41f8024e52408155547623a24c356828" args="($user, $knownGroups)" --><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">tx_sv_auth::getGroups </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>user</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>knownGroups</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>
Find usergroup records, currently only for frontend<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>Data of user. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Group data array of already known groups. This is handy if you want select other related groups. Keys in this array are unique IDs of those groups. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>mixed Groups array, keys = uid which must be unique </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__auth_8php-source.html#l00129">129</a> of file <a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l00610">t3lib_div::cmpIP()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, and <a class="el" href="class_8tx__sv__auth_8php-source.html#l00186">getSubGroups()</a>. </td>
</tr>
</table>
<a class="anchor" name="b71e3e1746af41540373baf8bf5cf7cd"></a><!-- doxytag: member="tx_sv_auth::getSubGroups" ref="b71e3e1746af41540373baf8bf5cf7cd" args="($grList, $idList='', &$groups)" --><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">tx_sv_auth::getSubGroups </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>grList</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>idList</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>groups</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>
Fetches subgroups of groups. Function is called recursively for each subgroup. Function was previously copied from t3lib_userAuthGroup->fetchGroups and has been slightly modified.<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>Commalist of fe_groups uid numbers </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>List of already processed fe_groups-uids so the function will not fall into a eternal recursion. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>array private </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__auth_8php-source.html#l00186">186</a> of file <a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l00835">t3lib_div::inList()</a>, and <a class="el" href="class_8t3lib__div_8php-source.html#l01413">t3lib_div::intExplode()</a>.
<p>
Referenced by <a class="el" href="class_8tx__sv__auth_8php-source.html#l00129">getGroups()</a>. </td>
</tr>
</table>
<a class="anchor" name="4550c596fded23d3cacc4b222e612155"></a><!-- doxytag: member="tx_sv_auth::getUser" ref="4550c596fded23d3cacc4b222e612155" 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">tx_sv_auth::getUser </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>
Find a user (eg. look up the user record in database when a login is sent)<p>
<dl compact><dt><b>Returns:</b></dt><dd>mixed user array or false </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__auth_8php-source.html#l00064">64</a> of file <a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a>.
<p>
References <a class="el" href="class_8t3lib__div_8php-source.html#l04461">t3lib_div::arrayToLogString()</a>, <a class="el" href="class_8t3lib__div_8php-source.html#l04440">t3lib_div::devLog()</a>, <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00158">tx_sv_authbase::fetchUserRecord()</a>, and <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00129">tx_sv_authbase::writelog()</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>typo3_src-4.0.1/typo3/sysext/sv/<a class="el" href="class_8tx__sv__auth_8php-source.html">class.tx_sv_auth.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>