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

Class: CaptchaValidationPlugin

Source Location: /modules/captcha/classes/CaptchaValidationPlugin.inc

Class CaptchaValidationPlugin

Class Overview

Implement ValidationPlugin to present the HTML for the captcha image and an input box for the user to type in the correct value.

Located in /modules/captcha/classes/CaptchaValidationPlugin.inc [line 38]

GalleryValidationPlugin
   |
   --CaptchaValidationPlugin

Methods

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

Inherited From GalleryValidationPlugin

GalleryValidationPlugin::loadTemplate()
Prepare template for validation.
GalleryValidationPlugin::performValidation()
Perform validation for this request.

[ Top ]
Method Summary
void   loadTemplate()  
void   performValidation()  
array   _shouldValidate()   Determine if captcha validation should be enforced

[ Top ]
Methods
loadTemplate  [line 96]

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

Parameters:
   &$form: 
   $options: 

API Tags:
See:  GalleryValidationPlugin::loadTemplate


Redefinition of:
GalleryValidationPlugin::loadTemplate()
Prepare template for validation.

[ Top ]
performValidation  [line 43]

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

Parameters:
   &$form: 
   $options: 

API Tags:
See:  GalleryValidationPlugin::performValidation


Redefinition of:
GalleryValidationPlugin::performValidation()
Perform validation for this request.

[ Top ]
_shouldValidate  [line 122]

  array _shouldValidate( array $options  )

Determine if captcha validation should be enforced

Parameters:
array   $options: 

API Tags:
Return:  GalleryStatus a status code boolean true to validate int current failure count, if applicable
Access:  private


[ Top ]

Documentation generated on Wed, 16 Dec 2009 04:32:27 -0800 by phpDocumentor 1.3.0RC6