Class: Checkbox

Source Location: /_includes/lib_forms.php

Class Overview

Field
   |
   --Checkbox

Describes a checkbox.

Author(s):

Andreas Launila

Methods

Inherited Variables

Class: Field

Field::$attributes
Field::$hasUserValue
Field::$id
Field::$name
Field::$required
Field::$value

Inherited Methods

Class: Field

Field::__construct(): Constructor for Field.
Field::formatAddition(): Formats any additional data that should be appended to the field. Any '%id' entities in the formatted string are replaced with the field's id. Any '%name' entities in the formatted string are replaced with the field's name.
Field::getAsHtml(): Returns the (X)HTML representation of the field. This function should be concidered as an abstract function, any subclasses should override this.
Field::getAttributes(): Gets the (X)HTML information containing all base information.
Field::getError()
Field::getId(): Gets the field's id.
Field::getName(): Gets the name of the field.
Field::getValue(): Gets the value of the field.
Field::hasUserValue(): Checks if the field has a non empty value that has been supplied by a user.
Field::hasValue(): Checks if the field has a non empty value.
Field::isValid()
Field::setAttribute(): Sets one of the firleds attributes. If the attribute does not exist then it is created. The attributes 'id', 'name' and 'value' can not be modified throught this function.
Field::setId(): Sets the field's id.
Field::setValue(): Sets the value of the field.

Class Details

[line 304]
Describes a checkbox.

Tags:

author:

Andreas Launila

[ Top ]

Class Methods

constructor __construct [line 309]

Checkbox __construct(
string
$name)

Constructor for Checkbox.

Tags:

access:

public

Overrides Field::__construct() (Constructor for Field.)

Parameters:

string

$name

The name of the checkbox.

[ Top ]

method getAsHtml [line 316]

void getAsHtml(
)

Tags:

access:	public
see:	Field.getAsHtml()

Overrides Field::getAsHtml() (Returns the (X)HTML representation of the field. This function should be concidered as an abstract function, any subclasses should override this.)

[ Top ]

Documentation generated on Tue, 10 Jan 2006 17:06:30 +0100 by phpDocumentor 1.3.0RC4