Class: XoopsAuth

Source Location: /class/auth/auth.php

Class XoopsAuth

Class Overview

Authentification base class

Located in /class/auth/auth.php [line 29]



		
				Author(s):
		
		
		

Information Tags:
Copyright:  copyright (c) 2000-2003 XOOPS.org

Properties

Methods

[ Top ]
Descendants
Child Class Description
XoopsAuthLdap Authentification base class
XoopsAuthOpenid Authentification base class
XoopsAuthXoops Authentification class for Native XOOPS

[ Top ]
Property Summary
mixed   $_dao  
mixed   $_errors  

[ Top ]
Method Summary
XoopsAuth   XoopsAuth()   Authentication Service constructor
bool   authenticate()   authenticate
array   getErrors()   return the errors for this object as an array
string   getHtmlErrors()   return the errors for this object as html
void   setErrors()   add an error

[ Top ]
Properties
mixed   $_dao [line 31]

[ Top ]
mixed   $_errors [line 33]

[ Top ]
Methods
Constructor XoopsAuth  [line 39]

  XoopsAuth XoopsAuth( &$dao  )

Authentication Service constructor

Parameters:
   &$dao: 


[ Top ]
authenticate  [line 49]

  bool authenticate( )

authenticate


API Tags:
Return:  whether user is authenticated
Abstract:  need to be write in the derived class


Redefined in descendants as:

[ Top ]
getErrors  [line 72]

  array getErrors( )

return the errors for this object as an array


API Tags:
Return:  an array of errors
Access:  public


[ Top ]
getHtmlErrors  [line 83]

  string getHtmlErrors( )

return the errors for this object as html


API Tags:
Return:  html listing the errors
Access:  public


[ Top ]
setErrors  [line 61]

  void setErrors( $err_no, $err_str, string $value  )

add an error

Parameters:
string   $value:  error to add
   $err_no: 
   $err_str: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Sat, 12 Dec 2009 21:10:21 -0600 by phpDocumentor 1.4.1