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

Class: SimpleSAMLphpAuthnEngine

Source Location: /lib/authn/SimpleSAMLphpAuthnEngine.php

Class Overview

GenericEngine
   |
   --AuthenticationEngine
      |
      --SimpleSAMLphpAuthnEngine

Authentication engine for the PAPI 1.5 protocol.


Variables

Methods


Inherited Variables

Inherited Methods

Class: AuthenticationEngine

AuthenticationEngine::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.
AuthenticationEngine::getAttribute()
Get an specific attribute for the current user, by specifying its name and namespace. May trigger some attribute query procedure.
AuthenticationEngine::getAttributes()
Get an associative array with the set of common attributes for the current user. May trigger some attribute recollection.
AuthenticationEngine::isAuthenticated()
Check the current authentication status withing this context. Does not trigger any authentication procedure.
AuthenticationEngine::logout()
Perform a logout (locally or global).

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 38]
Authentication engine for the PAPI 1.5 protocol.

PLEASE NOTE THAT THIS ENGINE WORKS ONLY FOR WEB-BASED APPLICATIONS.




[ Top ]


Class Variables

$attributes =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]

$simplesaml =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$status =

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method authenticate [line 55]

void authenticate( )



Tags:

access:  public


Overrides AuthenticationEngine::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.)

[ Top ]

method configure [line 44]

void configure( $file, $site)



Tags:

access:  public


Overrides GenericEngine::configure() (Configure the engine.)

Parameters:

   $file  
   $site  

[ Top ]

method getAttribute [line 75]

void getAttribute( $name, [ $namespace = NS_SAML2_PROTOCOL])



Tags:

access:  public


Overrides AuthenticationEngine::getAttribute() (Get an specific attribute for the current user, by specifying its name and namespace. May trigger some attribute query procedure.)

Parameters:

   $name  
   $namespace  

[ Top ]

method getAttributes [line 71]

void getAttributes( )



Tags:

access:  public


Overrides AuthenticationEngine::getAttributes() (Get an associative array with the set of common attributes for the current user. May trigger some attribute recollection.)

[ Top ]

method isAuthenticated [line 67]

void isAuthenticated( )



Tags:

access:  public


Overrides AuthenticationEngine::isAuthenticated() (Check the current authentication status withing this context. Does not trigger any authentication procedure.)

[ Top ]

method logout [line 83]

void logout( [ $slo = false])



Tags:

access:  public


Overrides AuthenticationEngine::logout() (Perform a logout (locally or global).)

Parameters:

   $slo  

[ Top ]


Documentation generated on Fri, 11 Feb 2011 10:58:06 +0100 by phpDocumentor 1.4.3