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

Class: GalleryValidationPlugin

Source Location: /modules/core/classes/GalleryValidationPlugin.class

Class GalleryValidationPlugin

Class Overview

This is an interface for security/validation plugins that will be used in multiple places across the codebase. Most notably, UserLogin and the register module.

Located in /modules/core/classes/GalleryValidationPlugin.class [line 40]



		
				Author(s):
		
API Tags:
Abstract:  

Methods

[ Top ]
Direct descendents
Child Class Description
UserSelfRegistrationControllerTestPlugin Mock ValidationPlugin
AddEcardTestValidation
PasswordEntryControllerTestPlugin Mock ValidationPlugin
UserRecoverPasswordControllerTestPlugin Mock ValidationPlugin
UserLoginControllerTestPlugin Mock ValidationPlugin
AddCommentTestValidation
CaptchaValidationPlugin Implement ValidationPlugin to present the HTML for the captcha image and an input box for the user to type in the correct value.

[ Top ]
Method Summary
array   loadTemplate()   Prepare template for validation.
array   performValidation()   Perform validation for this request.

[ Top ]
Methods
loadTemplate  [line 69]

  array loadTemplate( &$form, [array $options = array()], array $form  )

Prepare template for validation.

Parameters:
array   $form:  the form values
array   $options:  (optional) validation options 'level' => HIGH or MEDIUM or LOW (defaults to HIGH) 'key' => (string) unique identifier for this validation request (for MEDIUM)
   &$form: 

API Tags:
Return:  GalleryStatus a status code string the path to a template file to include or null string localization domain for the template file or null


Redefined in descendants as:

[ Top ]
performValidation  [line 54]

  array performValidation( &$form, [array $options = array()], array $form  )

Perform validation for this request.

Parameters:
array   $form:  the form values
array   $options:  (optional) validation options 'level' => HIGH or MEDIUM or LOW (defaults to HIGH) 'key' => (string) unique identifier for this validation request (for MEDIUM) 'pass' => (boolean) false to increment failure count (for MEDIUM/LOW)
   &$form: 

API Tags:
Return:  GalleryStatus a status code array of error keys boolean true/false should we continue processing this request?


Redefined in descendants as:

[ Top ]

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