phpDocumentor GalleryCore
UserInterface
[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]

Class: UserLoginController

Source Location: /modules/core/UserLogin.inc

Class UserLoginController

Class Overview

This controller will handle a user logging in to Gallery

Located in /modules/core/UserLogin.inc [line 33]

GalleryController
   |
   --UserLoginController

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryController

GalleryController::assertIsGenuineRequest()
Verifies the genuineness of the request
GalleryController::getItem()
Return the current item, as specified in the itemId request variable.
GalleryController::handleRequest()
Take the appropriate action based on the user input provided.
GalleryController::isAllowedInEmbedOnly()
Does this controller allow direct access even in embed-only mode?
GalleryController::isAllowedInMaintenance()
Does this controller allow access to non-admins when site is in maintenance mode?
GalleryController::loadController()
Load a controller
GalleryController::omitAuthTokenCheck()
Whether the controller opts-out from the framework's auth token check.
GalleryController::permissionCheck()
GalleryController::shouldSaveSession()
Should session be saved and session cookie sent when this controller is used?

[ Top ]
Property Summary
array   $_pluginInstances   ValidationPlugin instances to use when handling this request. Only used by test code.

[ Top ]
Method Summary
void   handleRequest()  
void   isAllowedInMaintenance()  
void   setPluginInstances()   Tests can use this method to hardwire a specific set of plugin instances to use.

[ Top ]
Properties
array   $_pluginInstances [line 41]

ValidationPlugin instances to use when handling this request. Only used by test code.

API Tags:
Access:  private


[ Top ]
Methods
handleRequest  [line 64]

  void handleRequest( $form  )

Parameters:
   $form: 

API Tags:
See:  GalleryController::handleRequest


Redefinition of:
GalleryController::handleRequest()
Take the appropriate action based on the user input provided.

[ Top ]
isAllowedInMaintenance  [line 57]

  void isAllowedInMaintenance( )


API Tags:
See:  GalleryController::isAllowedInMaintenance


Redefinition of:
GalleryController::isAllowedInMaintenance()
Does this controller allow access to non-admins when site is in maintenance mode?

[ Top ]
setPluginInstances  [line 50]

  void setPluginInstances( array $pluginInstances  )

Tests can use this method to hardwire a specific set of plugin instances to use.

This avoids situations where some of the option instances will do unpredictable things and derail the tests.

Parameters:
array   $pluginInstances:  of GalleryValidationPlugin


[ Top ]

Documentation generated on Fri, 08 Oct 2010 06:04:05 -0700 by phpDocumentor 1.3.0RC6