"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); ?>

tx_sv_authbase Class Reference

Inheritance diagram for tx_sv_authbase:

Inheritance graph
[legend]
Collaboration diagram for tx_sv_authbase:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 initAuth ($mode, $loginData, $authInfo, &$pObj)
 compareUident ($user, $loginData, $security_level='')
 writelog ($type, $action, $error, $details_nr, $details, $data, $tablename='', $recuid='', $recpid='')
 fetchUserRecord ($username, $extraWhere='', $dbUserSetup='')

Public Attributes

 $pObj
 $mode
 $login = array()
 $authInfo = array()
 $db_user = array()
 $db_groups = array()
 $writeAttemptLog = false
 $writeDevLog = false

Detailed Description

Definition at line 62 of file class.tx_sv_authbase.php.

Member Function Documentation

tx_sv_authbase::compareUident (  $  user,
$  loginData,
$  security_level = ''
) 
 

Check the login data with the user record data for builtin login methods

Parameters:
array user data array
array login data array
string security_level
Returns:
boolean true if login data matched

Definition at line 110 of file class.tx_sv_authbase.php.

Referenced by tx_sv_auth::authUser().

tx_sv_authbase::fetchUserRecord (  $  username,
$  extraWhere = '',
$  dbUserSetup = ''
) 
 

Get a user from DB by username

Parameters:
string user name
string additional WHERE clause: " AND ...
array User db table definition: $this->db_user
Returns:
mixed user array or false

Definition at line 158 of file class.tx_sv_authbase.php.

Referenced by tx_sv_auth::getUser().

tx_sv_authbase::initAuth (  $  mode,
$  loginData,
$  authInfo,
&$  pObj
) 
 

Initialize authentication service

Parameters:
string Subtype of the service which is used to call the service.
array Submitted login form data
array Information array. Holds submitted form data etc.
object Parent object
Returns:
void

Definition at line 87 of file class.tx_sv_authbase.php.

References $authInfo, $mode, $pObj, and t3lib_svbase::getServiceOption().

tx_sv_authbase::writelog (  $  type,
$  action,
$  error,
$  details_nr,
$  details,
$  data,
$  tablename = '',
$  recuid = '',
$  recpid = ''
) 
 

Writes to log database table in pObj

Parameters:
integer $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
integer 
action
denotes which specific operation that wrote the entry (eg. 'delete', 'upload', 'update' and so on...). Specific for each
type. Also used to trigger update of the interface. (see the log-module for the meaning of each number !!)
integer $error: flag. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
integer 
details_nr
The message number. Specific for each
type and $action. in the future this will make it possible to translate errormessages to other languages
string $details: Default text that follows the message
array $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...
string 
tablename
Special field used by tce_main.php. These (
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.)
integer 
recuid
Special field used by tce_main.php. These (
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.)
integer 
recpid
Special field used by tce_main.php. These (
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.)
Returns:
void
See also:
t3lib_userauthgroup::writelog()

Definition at line 129 of file class.tx_sv_authbase.php.

References t3lib_svbase::$error.

Referenced by tx_sv_auth::authUser(), and tx_sv_auth::getUser().

Member Data Documentation

tx_sv_authbase::$writeDevLog = false
 

Defines if debug messages should be written with t3lib_div::devLog

Reimplemented from t3lib_svbase.

Definition at line 75 of file class.tx_sv_authbase.php.

The documentation for this class was generated from the following file: