XOOPS  2.6.0
Xoops\Auth\AuthAbstract Class Reference
Inheritance diagram for Xoops\Auth\AuthAbstract:
Inheritance graph

Public Member Functions

 __construct ($dao)
 
 authenticate ($uname, $pwd=null)
 
 getErrors ()
 
 getHtmlErrors ()
 
 setErrors ($err_no, $err_str)
 

Protected Attributes

 $auth_method
 
 $dao
 
 $errors
 

Detailed Description

Definition at line 25 of file AuthAbstract.php.

Constructor & Destructor Documentation

Xoops\Auth\AuthAbstract::__construct (   $dao)

Authentication Service constructor

Parameters
\Xoops\Core\Database\Connection | null$daodatabase

Definition at line 47 of file AuthAbstract.php.

References Xoops\Auth\AuthAbstract\$dao.

Member Function Documentation

Xoops\Auth\AuthAbstract::authenticate (   $uname,
  $pwd = null 
)
abstract

authenticate a user

Parameters
string$unameuser name
string | null$pwdpassword
Returns
bool true if authenticated, otherwise fales
Xoops\Auth\AuthAbstract::getErrors ( )

return the errors for this object as an array

Returns
array an array of errors

Definition at line 80 of file AuthAbstract.php.

References Xoops\Auth\AuthAbstract\$errors.

Xoops\Auth\AuthAbstract::getHtmlErrors ( )

return the errors for this object as html

Returns
string html listing the errors

Definition at line 90 of file AuthAbstract.php.

References $xoops, XoopsLocaleEn_US\E_INCORRECT_LOGIN, XoopsLocaleEn_US\F_USING_AUTHENTICATION_METHOD, Xoops\getInstance(), and XoopsLocaleEn_US\NONE.

Here is the call graph for this function:

Xoops\Auth\AuthAbstract::setErrors (   $err_no,
  $err_str 
)

setErrors

Parameters
int$err_noerror number
string$err_strerror message
Returns
void

Definition at line 70 of file AuthAbstract.php.

Referenced by Xoops\Auth\Xoops\authenticate(), Xoops\Auth\Ads\authenticate(), Xoops\Auth\Ldap\authenticate(), Xoops\Auth\Ldap\getUserDN(), and Xoops\Auth\Ldap\loadXoopsUser().

Here is the caller graph for this function:

Member Data Documentation

Xoops\Auth\AuthAbstract::$auth_method
protected

Definition at line 40 of file AuthAbstract.php.

Xoops\Auth\AuthAbstract::$dao
protected
Xoops\Auth\AuthAbstract::$errors
protected

Definition at line 35 of file AuthAbstract.php.

Referenced by Xoops\Auth\AuthAbstract\getErrors().


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