Form Class Reference

Builds XForm in PHP This class allows you to build an xform in php. In order to build a form, you can use addInput to add each element of the form, then use buildForm to put everything together. More...

Inherited by GlobalRegistrationForm.

List of all members.

Public Member Functions

__construct ($numYears="")

INSERT BRIEF DESCRIPTION HERE.

add ($input)

Add a form input object that was built and passed in.

addDateChooser ($label, $ref="", $required="", $value="", $appearance="minimal", $description="")

Add a date chooser input to this Form.

addDayChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")

Add a day chooser input to this Form.

addInput ($inputType, $label, $ref="", $validType="", $required="", $value="", $items="", $appearance="", $description="")

Add an input to this Form.

addMonthChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")

Add a month chooser input to this Form.

addText ($label, $description="")

Add a "text" input to this Form.

addTextarea ($label, $ref="", $validType="", $required="", $value="", $items="", $appearance="", $description="")

Add a "textarea" input to this Form.

addYearChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")

Add a year chooser input to this Form.

buildForm ($submitLabel)

Return the XML representation of this Form.

getDays ()

INSERT BRIEF DESCRIPTION HERE.

getMonths ()

INSERT BRIEF DESCRIPTION HERE.

getYears ()

INSERT BRIEF DESCRIPTION HERE.

setTopSubmit ($topSubmit)

Add a submit button at the top of the Form.

setYears ($numYears="", $startYear="")

Set the year range for year chooser inputs.

Protected Member Functions

addSubmit ($label)

beginModel ()

endModel ()

setDays ()

INSERT BRIEF DESCRIPTION HERE.

setMonths ()

Detailed Description

Builds XForm in PHP This class allows you to build an xform in php. In order to build a form, you can use addInput to add each element of the form, then use buildForm to put everything together.

Author:: Valerie Gartland (<valerie@shodor.org>)

Definition at line 11 of file Form.php5.

Constructor & Destructor Documentation

Form::__construct ( $ numYears = "" )

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$numYears

[TYPE]: DESCRIPTION

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 31 of file Form.php5.

References setDays(), setMonths(), and setYears().

Member Function Documentation

Form::addDateChooser	(	$	label,
		$	ref = `""`,
		$	required = `""`,
		$	value = `""`,
		$	appearance = `"minimal"`,
		$	description = `""`
	)

Add a date chooser input to this Form.

This allows you to add an input for choosing a date. If you want to define a default value, it must be of the format YYYY-MM-DD.

Definition at line 103 of file Form.php5.

References addDayChooser(), addInput(), addMonthChooser(), and addYearChooser().

Form::addDayChooser	(	$	label,
		$	ref = `""`,
		$	required = `""`,
		$	value = `""`,
		$	appearance = `""`,
		$	description = `""`
	)

Add a day chooser input to this Form.

This allows you to add an input for choosing a day.

Definition at line 148 of file Form.php5.

References addInput(), and getDays().

Referenced by addDateChooser().

Form::addInput	(	$	inputType,
		$	label,
		$	ref = `""`,
		$	validType = `""`,
		$	required = `""`,
		$	value = `""`,
		$	items = `""`,
		$	appearance = `""`,
		$	description = `""`
	)

Add an input to this Form.

This allows you to add different elements to the form. For every element you add, an entry will be added to the model section of the xform as well as to the control part. A "text" type is the only kind of input that will not have an entry in the model section, since it is only a description and does not require any input.

Parameters:

	$inputType	[string]: the type of input (can be 'input', 'textarea', 'select', 'select1', 'secret', 'title')
	$label	[string]: the label that will be displayed with the input
	$ref	[string]: the reference for the input (used for reading values from the xform)
	$validType	[string]: validation type for this input (from SValidation)
	$required	[bool]: whether or not this input is a required element of the form
	$value	[mixed]: the default value of the input (optional)
	$items	[array]: the list of choices for a dropdown box or set of check boxes
	$appearance	[string]: the appearance of the input (can be 'minimal', 'compact', 'full')
	$description	[string]: a description for the input

Definition at line 55 of file Form.php5.

Referenced by addDateChooser(), addDayChooser(), addMonthChooser(), and addYearChooser().

Form::addMonthChooser	(	$	label,
		$	ref = `""`,
		$	required = `""`,
		$	value = `""`,
		$	appearance = `""`,
		$	description = `""`
	)

Add a month chooser input to this Form.

This allows you to add an input for choosing a month.

Definition at line 137 of file Form.php5.

References addInput(), and getMonths().

Referenced by addDateChooser().

Form::addSubmit ( $ label ) [protected]

For internal use only.

Adds a submit button with whatever label you give it.

Definition at line 212 of file Form.php5.

Referenced by buildForm().

Form::addText	(	$	label,
		$	description = `""`
	)

Add a "text" input to this Form.

This allows you to add a "text" input to the form without having to mess with the other parameters that text inputs don't have.

Definition at line 70 of file Form.php5.

Form::addTextarea	(	$	label,
		$	ref = `""`,
		$	validType = `""`,
		$	required = `""`,
		$	value = `""`,
		$	items = `""`,
		$	appearance = `""`,
		$	description = `""`
	)

Add a "textarea" input to this Form.

This allows you to add a "textarea" input to the form.

Definition at line 81 of file Form.php5.

Form::addYearChooser	(	$	label,
		$	ref = `""`,
		$	required = `""`,
		$	value = `""`,
		$	appearance = `""`,
		$	description = `""`
	)

Add a year chooser input to this Form.

This allows you to add an input for choosing a year.

Definition at line 126 of file Form.php5.

References addInput(), and getYears().

Referenced by addDateChooser().

Form::beginModel ( ) [protected]

For internal use only.

This adds the tags at the top of the xform.

Definition at line 189 of file Form.php5.

Referenced by buildForm().

Form::buildForm ( $ submitLabel )

Return the XML representation of this Form.

This function will return a string representing the xform you built. The submission button will have whatever label you pass in.

Returns:: [string]: XML representation of this Form

Definition at line 162 of file Form.php5.

References addSubmit(), beginModel(), and endModel().

Form::endModel ( ) [protected]

For internal use only.

This adds the tags at the bottom of the xform.

Definition at line 199 of file Form.php5.

Referenced by buildForm().

Form::getDays ( )

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 245 of file Form.php5.

Referenced by addDayChooser().

Form::getMonths ( )

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 234 of file Form.php5.

Referenced by addMonthChooser().

Form::getYears ( )

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 223 of file Form.php5.

Referenced by addYearChooser().

Form::setDays ( ) [protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Definition at line 301 of file Form.php5.

Referenced by __construct().

Form::setMonths ( ) [protected]

For internal use only.

Sets the list of months for a month selector.

Definition at line 276 of file Form.php5.

Referenced by __construct().

Form::setTopSubmit ( $ topSubmit )

Add a submit button at the top of the Form.

If you pass in true, there will be a submit button at the top.

Definition at line 317 of file Form.php5.

Form::setYears	(	$	numYears = `""`,
		$	startYear = `""`
	)

Set the year range for year chooser inputs.

Sets the years that will be available in the year chooser. The default is to start with the year before the current year and go through 5 years.

Parameters:

	$numYears	[int]: The number of years displayed by the year chooser inputs
	$startYear	[int]: The starting year for year chooser inputs

Definition at line 258 of file Form.php5.

Referenced by __construct().

The documentation for this class was generated from the following file:

XForms/Form.php5


Public Member Functions
	__construct ($numYears="")
	INSERT BRIEF DESCRIPTION HERE.
	add ($input)
	Add a form input object that was built and passed in.
	addDateChooser ($label, $ref="", $required="", $value="", $appearance="minimal", $description="")
	Add a date chooser input to this Form.
	addDayChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")
	Add a day chooser input to this Form.
	addInput ($inputType, $label, $ref="", $validType="", $required="", $value="", $items="", $appearance="", $description="")
	Add an input to this Form.
	addMonthChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")
	Add a month chooser input to this Form.
	addText ($label, $description="")
	Add a "text" input to this Form.
	addTextarea ($label, $ref="", $validType="", $required="", $value="", $items="", $appearance="", $description="")
	Add a "textarea" input to this Form.
	addYearChooser ($label, $ref="", $required="", $value="", $appearance="", $description="")
	Add a year chooser input to this Form.
	buildForm ($submitLabel)
	Return the XML representation of this Form.
	getDays ()
	INSERT BRIEF DESCRIPTION HERE.
	getMonths ()
	INSERT BRIEF DESCRIPTION HERE.
	getYears ()
	INSERT BRIEF DESCRIPTION HERE.
	setTopSubmit ($topSubmit)
	Add a submit button at the top of the Form.
	setYears ($numYears="", $startYear="")
	Set the year range for year chooser inputs.
Protected Member Functions
	addSubmit ($label)
	beginModel ()
	endModel ()
	setDays ()
	INSERT BRIEF DESCRIPTION HERE.
	setMonths ()