<?php
include_once '../doc-typo3-funcs.php';
$doxygen_vars = array( "title" => "TYPO3 4.0.1: tx_sv_authbase Class Reference",
"datetime" => "Sat Dec 2 19:27:25 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_authbase Class Reference</h1><!-- doxytag: class="tx_sv_authbase" --><!-- doxytag: inherits="t3lib_svbase" -->Inheritance diagram for tx_sv_authbase:<p><center><img src="classtx__sv__authbase__inherit__graph.png" border="0" usemap="#tx__sv__authbase__inherit__map" alt="Inheritance graph"></center>
<map name="tx__sv__authbase__inherit__map">
<area href="classtx__sv__auth.html" shape="rect" coords="15,944,140,1064" alt="">
<area href="classt3lib__svbase.html" shape="rect" coords="6,5,150,624" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for tx_sv_authbase:<p><center><img src="classtx__sv__authbase__coll__graph.png" border="0" usemap="#tx__sv__authbase__coll__map" alt="Collaboration graph"></center>
<map name="tx__sv__authbase__coll__map">
<area href="classt3lib__svbase.html" shape="rect" coords="6,5,150,624" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classtx__sv__authbase-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__authbase.html#c266a04dc8a1d4b6c27b9083fc6009ba">initAuth</a> ($mode, $loginData, $authInfo, &$pObj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#222558e7b64ad559536f5665d854d516">compareUident</a> ($user, $loginData, $security_level='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#2ab0cc3540e6e4aa9898da69a3403e95">writelog</a> ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='')</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#492c2c6b4d1f0b0bff4e40ea067f1504">fetchUserRecord</a> ($username, $extraWhere='', $dbUserSetup='')</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="1e752d2fae20e035c00f746a5760f769"></a><!-- doxytag: member="tx_sv_authbase::$pObj" ref="1e752d2fae20e035c00f746a5760f769" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#1e752d2fae20e035c00f746a5760f769">$pObj</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fc84e8c2ed54c86c44b6d24ddec252a8"></a><!-- doxytag: member="tx_sv_authbase::$mode" ref="fc84e8c2ed54c86c44b6d24ddec252a8" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#fc84e8c2ed54c86c44b6d24ddec252a8">$mode</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="208dce0306ce2c2ee23ebd4008f65736"></a><!-- doxytag: member="tx_sv_authbase::$login" ref="208dce0306ce2c2ee23ebd4008f65736" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#208dce0306ce2c2ee23ebd4008f65736">$login</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="87d517670a76c3351085db2705ffb489"></a><!-- doxytag: member="tx_sv_authbase::$authInfo" ref="87d517670a76c3351085db2705ffb489" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#87d517670a76c3351085db2705ffb489">$authInfo</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="455cdb95e2c66666d791b63fd50c956f"></a><!-- doxytag: member="tx_sv_authbase::$db_user" ref="455cdb95e2c66666d791b63fd50c956f" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#455cdb95e2c66666d791b63fd50c956f">$db_user</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b29d3fd88488cff0ff2bbb2540a7eabb"></a><!-- doxytag: member="tx_sv_authbase::$db_groups" ref="b29d3fd88488cff0ff2bbb2540a7eabb" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#b29d3fd88488cff0ff2bbb2540a7eabb">$db_groups</a> = array()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e105a839c4818db912937934746035ef"></a><!-- doxytag: member="tx_sv_authbase::$writeAttemptLog" ref="e105a839c4818db912937934746035ef" args="" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#e105a839c4818db912937934746035ef">$writeAttemptLog</a> = false</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtx__sv__authbase.html#cd8d0b4cf4c0cf8730e3383ab78477c4">$writeDevLog</a> = false</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<p>
<p>
Definition at line <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00062">62</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="222558e7b64ad559536f5665d854d516"></a><!-- doxytag: member="tx_sv_authbase::compareUident" ref="222558e7b64ad559536f5665d854d516" args="($user, $loginData, $security_level='')" --><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_authbase::compareUident </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>loginData</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>security_level</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>
Check the login data with the user record data for builtin login methods<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>user data array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>login data array </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>security_level </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>boolean true if login data matched </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00110">110</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</a>.
<p>
Referenced by <a class="el" href="class_8tx__sv__auth_8php-source.html#l00089">tx_sv_auth::authUser()</a>. </td>
</tr>
</table>
<a class="anchor" name="492c2c6b4d1f0b0bff4e40ea067f1504"></a><!-- doxytag: member="tx_sv_authbase::fetchUserRecord" ref="492c2c6b4d1f0b0bff4e40ea067f1504" args="($username, $extraWhere='', $dbUserSetup='')" --><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_authbase::fetchUserRecord </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>username</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>extraWhere</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>dbUserSetup</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>
Get a user from <a class="el" href="classDB.html">DB</a> by username<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>user name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>additional WHERE clause: " AND ... </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>User db table definition: $this->db_user </td></tr>
</table>
</dl>
<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__authbase_8php-source.html#l00158">158</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</a>.
<p>
Referenced by <a class="el" href="class_8tx__sv__auth_8php-source.html#l00064">tx_sv_auth::getUser()</a>. </td>
</tr>
</table>
<a class="anchor" name="c266a04dc8a1d4b6c27b9083fc6009ba"></a><!-- doxytag: member="tx_sv_authbase::initAuth" ref="c266a04dc8a1d4b6c27b9083fc6009ba" args="($mode, $loginData, $authInfo, &$pObj)" --><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_authbase::initAuth </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>mode</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>loginData</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>authInfo</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>pObj</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>
Initialize authentication service<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>Subtype of the service which is used to call the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Submitted login form data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>Information array. Holds submitted form data etc. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>Parent object </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00087">87</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</a>.
<p>
References <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00069">$authInfo</a>, <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00066">$mode</a>, <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00064">$pObj</a>, and <a class="el" href="class_8t3lib__svbase_8php-source.html#l00224">t3lib_svbase::getServiceOption()</a>. </td>
</tr>
</table>
<a class="anchor" name="2ab0cc3540e6e4aa9898da69a3403e95"></a><!-- doxytag: member="tx_sv_authbase::writelog" ref="2ab0cc3540e6e4aa9898da69a3403e95" args="($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='')" --><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_authbase::writelog </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">$ </td>
<td class="mdname" nowrap> <em>type</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>action</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>error</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>details_nr</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>details</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>data</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>tablename</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>recuid</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>recpid</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>
Writes to log database table in pObj<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>integer</em> </td><td>$type: denotes which module that has submitted the entry. This is the current list: 1=tce_db; 2=tce_file; 3=system (eg. sys_history save); 4=modules; 254=Personal settings changed; 255=login / out action: 1=login, 2=logout, 3=failed login (+ errorcode 3), 4=failure_warning_email sent </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td><dl compact><dt><b>action</b></dt><dd>denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each </dd></dl>
type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td>$error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td><dl compact><dt><b>details_nr</b></dt><dd>The message number. Specific for each </dd></dl>
type and $action. in the future this will make it possible to translate errormessages to other languages </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>$details: Default text that follows the message </td></tr>
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>$data: Data that follows the log. Might be used to carry special information. If an array the first 5 entries (0-4) will be sprintf'ed the details-text... </td></tr>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td><dl compact><dt><b>tablename</b></dt><dd>Special field used by tce_main.php. These (</dd></dl>
tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td><dl compact><dt><b>recuid</b></dt><dd>Special field used by tce_main.php. These (</dd></dl>
tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>integer</em> </td><td><dl compact><dt><b>recpid</b></dt><dd>Special field used by tce_main.php. These (</dd></dl>
tablename, $recuid, $recpid) holds the reference to the record which the log-entry is about. (Was used in attic status.php to update the interface.) </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>t3lib_userauthgroup::writelog() </dd></dl>
<p>
Definition at line <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00129">129</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</a>.
<p>
References <a class="el" href="class_8t3lib__svbase_8php-source.html#l00135">t3lib_svbase::$error</a>.
<p>
Referenced by <a class="el" href="class_8tx__sv__auth_8php-source.html#l00089">tx_sv_auth::authUser()</a>, and <a class="el" href="class_8tx__sv__auth_8php-source.html#l00064">tx_sv_auth::getUser()</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="cd8d0b4cf4c0cf8730e3383ab78477c4"></a><!-- doxytag: member="tx_sv_authbase::$writeDevLog" ref="cd8d0b4cf4c0cf8730e3383ab78477c4" 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_authbase::$writeDevLog = false </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Defines if debug messages should be written with <a class="el" href="classt3lib__div.html#a717061737ecec3ccfd8d32b9b1c2478">t3lib_div::devLog</a>
<p>
Reimplemented from <a class="el" href="classt3lib__svbase.html#e60e9948c373dfc45f7cf2d0d20cf829">t3lib_svbase</a>.
<p>
Definition at line <a class="el" href="class_8tx__sv__authbase_8php-source.html#l00075">75</a> of file <a class="el" href="class_8tx__sv__authbase_8php-source.html">class.tx_sv_authbase.php</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__authbase_8php-source.html">class.tx_sv_authbase.php</a></ul>
<?php
include_once '../doc-typo3-funcs.php';
get_footer();
?>