org.seanmonahan
[ class tree: org.seanmonahan ] [ index: org.seanmonahan ] [ all elements ]
Packages:
org.seanmonahan


Files:
Form.class.php
FormCaptcha.class.php
FormField.class.php
FormInput.class.php
FormSelect.class.php
FormSeparator.class.php
FormTextArea.class.php
MediaWikiManager.php

Classes:
Form
FormCaptcha
FormField
FormInput
FormSelect
FormSeparator
FormTextArea
MediaWikiManager

Class: FormCaptcha

Source Location: /FormCaptcha.class.php

Class Overview

FormField
   |
   --FormCaptcha

The FormField class.


Author(s):

  • Sean Monahan

Version:

  • 1.0

Copyright:

  • 2008 Sean Monahan

Methods

Inherited Methods

Class: FormField

FormField::__construct()
This is the base class for all HTML form fields.
FormField::addClassName()
Adds a class name to the existing list of classes.
FormField::addEventListener()
Adds an event listeners to the field.
FormField::className()
Getter for $_action.
FormField::eventListeners()
Getter for $_eventListeners.
FormField::fieldType()
Getter for $_fieldType;
FormField::isDisabled()
Getter for $_isDisabled.
FormField::label()
Getter for $_method.
FormField::name()
Getter for $_name.
FormField::setClassName()
Setter for $_className.
FormField::setFieldType()
Setter for $_fieldType.
FormField::setIsDisabled()
Setter for $_isDisabled.
FormField::setLabel()
Setter for $_label.
FormField::setName()
Setter for $_name
FormField::setSize()
Setter for $_size.
FormField::size()
Getter for $_size.
FormField::type()
Getter for $_type.

Class Details

[line 20]
The FormField class.

PHP Version 5

LICENSE: This source file is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License. http://creativecommons.org/licenses/by-sa/3.0/us/




Tags:

author:  Sean Monahan
version:  1.0
copyright:  2008 Sean Monahan


[ Top ]

Class Methods

constructor __construct [line 117]

FormCaptcha __construct( [string $src = ""], [string $showReload = true], [string $label = ""], [string $imageName = "captchaimage"], [string $inputName = "captchacode"], [string $reloadName = "captchareload"], [string $reloadImage = ""], [string $reloadText = "Try a different image."], [string $reloadLocation = "BeforeImage"], [string $className = ""], [int $maxLength = 6], [bool $stylePad = false])

This class builds an HTML <input>.



Tags:

access:  public


Overrides FormField::__construct() (This is the base class for all HTML form fields.)

Parameters:

string   $src   The location of the captcha script.
string   $showReload   Show the captcha reload button?
string   $label   The text for the CAPTCHA label.
string   $imageName   The name and ID for the image.
string   $inputName   The name and ID for the input.
string   $reloadName   The name and ID for the reload button/link.
string   $reloadImage   The image to use for the reload button.
string   $reloadText   The text to display for the reload link and alt for image.
string   $reloadLocation   The location to place the reload link/button.
string   $className   The CSS class for the captcha.
int   $maxLength   The max length for the captcha.
bool   $stylePad   Add <div>'s so the <input> can be styled with fancy rounded edges and such.

[ Top ]

method className [line 233]

string className( )

Getter for $_className.



Tags:

return:  The CSS class name for the CAPTCHA.
access:  public


Overrides FormField::className() (Getter for $_action.)

[ Top ]

method imageName [line 163]

string imageName( )

Getter for $_imageName.



Tags:

return:  The name of the CAPTCHA image.
access:  public


[ Top ]

method inputName [line 173]

string inputName( )

Getter for $_inputName.



Tags:

return:  The name for the CAPTCHA input field.
access:  public


[ Top ]

method maxLength [line 223]

int maxLength( )

Getter for $_maxLength.



Tags:

return:  The maximum length of the CAPTCHA code.
access:  public


[ Top ]

method reloadImage [line 193]

string reloadImage( )

Getter for $_reloadImage.



Tags:

return:  The image to use for the reload button.
access:  public


[ Top ]

method reloadLocation [line 213]

string reloadLocation( )

Getter for $_reloadLocation.



Tags:

return:  The placement for the reload button.
access:  public


[ Top ]

method reloadName [line 183]

string reloadName( )

Getter for $_reloadName.



Tags:

return:  The name for the reload button.
access:  public


[ Top ]

method reloadText [line 203]

string reloadText( )

Getter for $_reloadText.



Tags:

return:  The text to use for the reload link.
access:  public


[ Top ]

method setClassName [line 354]

void setClassName( string $value)

Setter for $_className.



Tags:

access:  public


Overrides FormField::setClassName() (Setter for $_className.)

Parameters:

string   $value   The name for the CSS class.

[ Top ]

method setImageName [line 276]

void setImageName( string $value)

Setter for $_imageName.



Tags:

access:  public


Parameters:

string   $value   The name and ID for the image.

[ Top ]

method setInputName [line 286]

void setInputName( string $value)

Setter for $_inputName.



Tags:

access:  public


Parameters:

string   $value   The name and ID for the input.

[ Top ]

method setMaxLength [line 340]

void setMaxLength( int $value)

Setter for $_maxLength.



Tags:

access:  public


Parameters:

int   $value   The length allowed for the input field.

[ Top ]

method setReloadImage [line 306]

void setReloadImage( string $value)

Setter for $_reloadImage.



Tags:

access:  public


Parameters:

string   $value   The image location for the reload button.

[ Top ]

method setReloadLocation [line 326]

void setReloadLocation( string $value)

Setter for $_reloadLocation.



Tags:

access:  public


Parameters:

string   $value   The location for the reload button.

[ Top ]

method setReloadName [line 296]

void setReloadName( string $value)

Setter for $_reloadName.



Tags:

access:  public


Parameters:

string   $value   The name and ID for the reload button.

[ Top ]

method setReloadText [line 316]

void setReloadText( string $value)

Setter for $_reloadText.



Tags:

access:  public


Parameters:

string   $value   The text for the reload button.

[ Top ]

method setShowReload [line 263]

void setShowReload( string $value)

Setter for $_showReload.



Tags:

access:  public


Parameters:

string   $value   Set the reload button to be displayed or not.

[ Top ]

method setSrc [line 253]

void setSrc( string $value)

Setter for $_src;



Tags:

access:  public


Parameters:

string   $value   The contents for $_src.

[ Top ]

method setStylePad [line 364]

void setStylePad( bool $value)

Setter for $_stylePad.



Tags:

access:  public


Parameters:

bool   $value   The value for style pad.

[ Top ]

method showReload [line 153]

bool showReload( )

Getter for $_showReload.



Tags:

return:  Whether or not to show the reload button.
access:  public


[ Top ]

method src [line 143]

string src( )

Getter for $_src.



Tags:

return:  The location of the CAPTCHA script.
access:  public


[ Top ]

method stylePad [line 243]

bool stylePad( )

Getter for $_stylePad.



Tags:

return:  Whether or not to add style padding.
access:  public


[ Top ]

Documentation generated on Mon, 15 Dec 2008 21:14:23 -0700 by phpDocumentor 1.4.1