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

Class: AttributeFilterAuthzEngine

Source Location: /lib/authz/AttributeFilterAuthzEngine.php

Class Overview

GenericEngine
   |
   --AuthorizationEngine
      |
      --AttributeFilterAuthzEngine

Authorization engine that works by checking the attributes of the user. The first match of an attribute against one of the filters will trigger the authorization result, no matter if it's positive or negative.


Author(s):

Version:

  • 2.0

Copyright:

  • Copyright 2005-2010 RedIRIS, http://www.rediris.es/

    This file is part of phpPoA2.

    phpPoA2 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

    phpPoA2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along with phpPoA2. If not, see <http://www.gnu.org/licenses/>.

Variables

Methods


Inherited Variables

Inherited Methods

Class: AuthorizationEngine

AuthorizationEngine::authorize()
AuthorizationEngine::getAuthorizedList()
AuthorizationEngine::isAuthorized()
Check authorization for the specified user.
AuthorizationEngine::revoke()

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 46]
Authorization engine that works by checking the attributes of the user. The first match of an attribute against one of the filters will trigger the authorization result, no matter if it's positive or negative.



Tags:

author:  Jaime Perez <jaime.perez@rediris.es>
version:  2.0
copyright:  

Copyright 2005-2010 RedIRIS, http://www.rediris.es/

This file is part of phpPoA2.

phpPoA2 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

phpPoA2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with phpPoA2. If not, see <http://www.gnu.org/licenses/>.



[ Top ]


Class Variables

$valid_hooks = array(ATTRIBUTE_BEFORE_FILTERS)

[line 48]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]



Class Methods


method authorize [line 90]

void authorize( $user, $attrs, $ref, [ $expires = 0])



Tags:

access:  public


Overrides AuthorizationEngine::authorize() (parent method not documented)

Parameters:

   $user  
   $attrs  
   $ref  
   $expires  

[ Top ]

method getAuthorizedList [line 86]

void getAuthorizedList( )



Tags:

access:  public


Overrides AuthorizationEngine::getAuthorizedList() (parent method not documented)

[ Top ]

method isAuthorized [line 50]

void isAuthorized( $user, $attrs)



Tags:

access:  public


Overrides AuthorizationEngine::isAuthorized() (Check authorization for the specified user.)

Parameters:

   $user  
   $attrs  

[ Top ]

method revoke [line 94]

void revoke( $mail)



Tags:

access:  public


Overrides AuthorizationEngine::revoke() (parent method not documented)

Parameters:

   $mail  

[ Top ]


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