auFormCheckbox

From auWiki
Jump to: navigation, search

The auFormCheckbox class is part of the auLib package. It is defined in the auForm.php file.

Hierarchy

Usage

This class is used to add a yes/no or true/false input field to a form. Create an object from this class and add it to an auFormContainer object.

Public Functions

new auFormCheckbox

new auFormCheckbox($name, $label, $description, $default)

Creates a new yes/no or true/false input form field.

  • $name = Name to submit the field as.
  • $label = Label to display with the field. Default is blank.
  • $description = Text to display next to the checkbox to explain what it means. Default is none.
  • $default = Default value for this field. Default is blank / unchecked.