htmlAuthenticator Class Reference

Inheritance diagram for htmlAuthenticator:

Collaboration diagram for htmlAuthenticator:

Public Member Functions
	checkAuthentication ()
	getAuthSession ()
	checkAuthorization ($opt)
	askAuthentication ($args)
	getAuthUrl (array $extendedArg=array())
	connectTo ($uri)
	getAuthUser ()
	getAuthPw ()
	logout ($redir_uri= '')
	setSessionVar ($name, $value)
	getSessionVar ($name)
	logon ()
Public Member Functions inherited from Authenticator
	__construct ($authtype, $authprovider)
	tryInitializeUser ($username)
	getProviderErrno ()
	getAuthApp ()
	checkAuthentication ()
	checkAuthorization ($opt)
	askAuthentication ($args)
	getAuthUser ()
	getAuthPw ()
	logout ($redir_uri= '')
	setSessionVar ($name, $value)
	getSessionVar ($name)

Data Fields
	$auth_session = null
Data Fields inherited from Authenticator
const	AUTH_OK = 0
const	AUTH_NOK = 1
const	AUTH_ASK = 2
const	nullProvider = "__for_logout__"
	$provider = null

Additional Inherited Members
Static Public Member Functions inherited from Authenticator
static	getAuthParam ($provider="")
static	getAuthTypeParams ()
static	freedomUserExists ($username)

Detailed Description

Definition at line 20 of file Class.htmlAuthenticator.php.

Member Function Documentation

askAuthentication

(

$args

)

Definition at line 101 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

checkAuthentication

(

)

Definition at line 33 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

checkAuthorization

(

$opt

)

Definition at line 86 of file Class.htmlAuthenticator.php.

connectTo

(

$uri

)

ask authentication and redirect

Parameters

string

$uri

uri to redirect after connection

Definition at line 144 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

getAuthPw

(

)

Definition at line 169 of file Class.htmlAuthenticator.php.

getAuthSession

(

)

retrieve authentication session

Returns

Session the session object

Definition at line 68 of file Class.htmlAuthenticator.php.

getAuthUrl

(

array

$extendedArg = array()

)

return url used to connect user

Parameters

array

$extendedArg

Exceptions

Dcp\Exception

Returns

string

Definition at line 121 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

getAuthUser

(

)

Definition at line 155 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

getSessionVar

(

$name

)

Definition at line 212 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

logon

(

)

Definition at line 218 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

logout

(

$redir_uri = ''

)

Definition at line 178 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

setSessionVar	(		$name,
			$value
	)

Definition at line 200 of file Class.htmlAuthenticator.php.

Here is the call graph for this function:

Field Documentation

$auth_session = null

Definition at line 23 of file Class.htmlAuthenticator.php.

---

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

• Class.htmlAuthenticator.php