Class Xyster_Controller_Plugin_Auth

Description
Description | Vars (details) | Methods (details)

Authentication plugin

  • copyright: Copyright (c) 2007-2008 Irrational Logic (http://irrationallogic.net)
  • license: New BSD License

Located in /Controller/Plugin/Auth.php (line 34) 

Zend_Controller_Plugin_Abstract
   |
   --Xyster_Controller_Plugin_Auth
Variable Summary
Description | Vars (details) | Methods (details)
Zend_Acl $_acl
Zend_Auth_Adapter_Interface $_adapter
string $_failAction
string $_failController
string $_failModule
Xyster_Acl_Role_Provider_Interface $_provider
Zend_Acl_Role_Interface $_role
boolean $_started
string $_successAction
string $_successController
string $_successModule
Method Summary
Description | Vars (details) | Methods (details)
Zend_Acl getAcl ()
string getFailAction ()
string getFailController ()
string getFailModule ()
Zend_Acl_Role_Interface getRole ()
Xyster_Acl_Role_Provider_Interface getRoleProvider ()
string getSuccessAction ()
string getSuccessController ()
string getSuccessModule ()
void routeStartup ( $request)
Xyster_Controller_Plugin_Auth setAcl ( $acl)
Xyster_Controller_Plugin_Auth setAuthAdapter ( $adapter)
Xyster_Controller_Plugin_Auth setFailure (string $module, string $controller, string $action)
Xyster_Controller_Plugin_Auth setRoleProvider ( $provider)
Xyster_Controller_Plugin_Auth setSuccess (string $module, string $controller, string $action)
void _authenticate ()
Variables
Description | Vars (details) | Methods (details)
Zend_Acl $_acl (line 41)

The acl

  • access: protected
Zend_Auth_Adapter_Interface $_adapter (line 48)

The Auth adapter

  • access: protected
string $_failAction = 'index' (line 55)

The dispatch action for authentication failure

  • access: protected
string $_failController = 'login' (line 62)

The dispatch controller for authentication failure

  • access: protected
string $_failModule (line 69)

The dispatch module for authentication failure

  • access: protected
Xyster_Acl_Role_Provider_Interface $_provider (line 76)

The role provider

  • access: protected
Zend_Acl_Role_Interface $_role (line 83)

The current authenticated role

  • access: protected
boolean $_started = false (line 90)

Whether the 'routeStartup' method has already been called

  • access: protected
string $_successAction = 'success' (line 97)

The dispatch action for authentication success

  • access: protected
string $_successController = 'login' (line 104)

The dispatch controller for authentication success

  • access: protected
string $_successModule (line 111)

The dispatch module for authentication success

  • access: protected
Methods
Description | Vars (details) Methods (details)
getAcl (line 130)

Gets the ACL assigned to the plugin

  • access: public
Zend_Acl getAcl ()
getFailAction (line 140)

Gets the dispatch action for authentication failure

  • access: public
string getFailAction ()
getFailController (line 150)

Gets the dispatch controller for authentication failure

  • access: public
string getFailController ()
getFailModule (line 160)

Gets the dispatch module for authentication failure

  • access: public
string getFailModule ()
getRole (line 174)

Gets the authenticated role

  • access: public
Zend_Acl_Role_Interface getRole ()
getRoleProvider (line 190)

Gets the role provider used to translate the identity into a role

  • access: public
Xyster_Acl_Role_Provider_Interface getRoleProvider ()
getSuccessAction (line 204)

Gets the dispatch action for authentication success

  • access: public
string getSuccessAction ()
getSuccessController (line 214)

Gets the dispatch controller for authentication success

  • access: public
string getSuccessController ()
getSuccessModule (line 224)

Gets the dispatch module for authentication success

  • access: public
string getSuccessModule ()
routeStartup (line 118)

Called before Zend_Controller_Front determines the dispatch route

  • access: public
void routeStartup ( $request)
  • Zend_Controller_Request_Abstract $request
setAcl (line 239)

Sets the ACL to which the authenticated role will be added

  • return: provides a fluent interface
  • access: public
Xyster_Controller_Plugin_Auth setAcl ( $acl)
  • Zend_Acl $acl
setAuthAdapter (line 251)

Sets the authentication adapter

  • return: provides a fluent interface
  • access: public
Xyster_Controller_Plugin_Auth setAuthAdapter ( $adapter)
  • Zend_Auth_Adapter_Interface $adapter
setFailure (line 269)

Sets the dispatch location for a failed authentication

  • return: provides a fluent interface
  • access: public
Xyster_Controller_Plugin_Auth setFailure (string $module, string $controller, string $action)
  • string $module: The dispatch module
  • string $controller: The dispatch controller
  • string $action: The dispatch action
setRoleProvider (line 284)

Sets the role provider used to translate the identity into a role

  • return: provides a fluent interface
  • access: public
Xyster_Controller_Plugin_Auth setRoleProvider ( $provider)
setSuccess (line 298)

Sets the dispatch location for a successful authentication

  • return: provides a fluent interface
  • access: public
Xyster_Controller_Plugin_Auth setSuccess (string $module, string $controller, string $action)
  • string $module: The dispatch module
  • string $controller: The dispatch controller
  • string $action: The dispatch action
_authenticate (line 311)

Does the actual auth work

  • access: protected
void _authenticate ()

Documentation generated on Mon, 19 May 2008 17:06:59 -0400 by phpDocumentor 1.4.2