phpPoA2
[ class tree: phpPoA2 ] [ index: phpPoA2 ] [ all elements ]

Class: AuthenticationEngine

Source Location: /lib/authn/AuthenticationEngine.php

Class Overview

GenericEngine
   |
   --AuthenticationEngine

Abstract authentication engine.


Author(s):

Variables

Methods


Child classes:

PAPIAuthnEngine
Authentication engine for the PAPI 1.5 protocol.
simpleSAMLphpAuthnEngine
Authentication engine for the PAPI 1.5 protocol.

Inherited Variables

Inherited Methods

Class: GenericEngine

GenericEngine::__construct()
Main constructor for the engine.
GenericEngine::addHook()
Adds a function to the specified hook, which will be executed at some point of the code.
GenericEngine::clean()
Unregister error and exception handlers. Use it only for methods not declared in the interface that previously called registerHandler() method.
GenericEngine::configure()
Configure the engine.
GenericEngine::registerHandler()
Register error and exception handlers for logging. Use it only for methods not declared in the interface that could trigger errors.
GenericEngine::removeHook()
Removes a function fromt he specified hook.
GenericEngine::runHooks()
Run all hooks attached to an specific action.
GenericEngine::setHandler()
Set the event handler to the one specified.

Class Details

[line 31]
Abstract authentication engine.



Tags:

abstract:  


[ Top ]


Class Variables

$engine_type =  "Authn"

[line 33]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]



Class Methods


method authenticate [line 41]

boolean authenticate( )

Trigger the authentication of the user in the current context. May perform HTTP redirections or any other procedure to gather the authentication status if the user, so don't expect it to return control once called.



Tags:

return:  AUTHN_SUCCESS (true) or AUTHN_FAILED (false).
abstract:  
access:  public


Overridden in child classes as:

PAPIAuthnEngine::authenticate()
simpleSAMLphpAuthnEngine::authenticate()

[ Top ]

method getAttribute [line 65]

string|array getAttribute( name $name, [namespace $namespace = ""])

Get an specific attribute for the current user, by specifying its name and namespace. May trigger some attribute query procedure.



Tags:

return:  the value or an array of values for the required attribute, or false if anything went wrong.
abstract:  
access:  public


Overridden in child classes as:

PAPIAuthnEngine::getAttribute()
simpleSAMLphpAuthnEngine::getAttribute()

Parameters:

name   $name   The name of the attribute.
namespace   $namespace   The namespace of the attribute.

[ Top ]

method getAttributes [line 55]

array getAttributes( )

Get an associative array with the set of common attributes for the current user. May trigger some attribute recollection.



Tags:

return:  An associative array with all the attributes gathered by default.
abstract:  
access:  public


Overridden in child classes as:

PAPIAuthnEngine::getAttributes()
simpleSAMLphpAuthnEngine::getAttributes()

[ Top ]

method isAuthenticated [line 48]

boolean isAuthenticated( )

Check the current authentication status withing this context. Does not trigger any authentication procedure.



Tags:

return:  AUTHN_SUCCESS (true) or AUTHN_FAILED (false).
abstract:  
access:  public


Overridden in child classes as:

PAPIAuthnEngine::isAuthenticated()
simpleSAMLphpAuthnEngine::isAuthenticated()

[ Top ]

method logout [line 72]

void logout( [slo $slo = false])

Perform a logout (locally or global).



Tags:

abstract:  
access:  public


Overridden in child classes as:

PAPIAuthnEngine::logout()
simpleSAMLphpAuthnEngine::logout()

Parameters:

slo   $slo   Whether to perform the logout globally (Single Log Out) or not. Defaults to local.

[ Top ]


Documentation generated on Wed, 13 Oct 2010 15:06:14 +0200 by phpDocumentor 1.4.3