[ Index ]

PHP Cross Reference of Limb3

title

Body

[close]

/tests_runner/lib/simpletest/ -> form.php (summary)

Base include file for SimpleTest.

Version: $Id: form.php 5999 2007-06-18 13:13:08Z pachanga $
File Size: 352 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

SimpleForm:: (20 methods):
  SimpleForm()
  _setEncodingClass()
  setDefaultTarget()
  getMethod()
  _createAction()
  getAction()
  _encode()
  getId()
  addWidget()
  _setWidget()
  _addRadioButton()
  _addCheckbox()
  getValue()
  setField()
  attachLabelBySelector()
  hasSubmit()
  hasImage()
  submitButton()
  submitImage()
  submit()


Class: SimpleForm  - X-Ref

Form tag class to hold widget values.

SimpleForm($tag, $url)   X-Ref
Starts with no held controls/widgets.

param: SimpleTag $tag        Form tag to read.
param: SimpleUrl $url        Location of holding page.

_setEncodingClass($tag)   X-Ref
Creates the request packet to be sent by the form.

param: SimpleTag $tag        Form tag to read.
return: string               Packet class.

setDefaultTarget($frame)   X-Ref
Sets the frame target within a frameset.

param: string $frame        Name of frame.

getMethod()   X-Ref
Accessor for method of form submission.

return: string           Either get or post.

_createAction($action, $base)   X-Ref
Combined action attribute with current location
to get an absolute form target.

param: string $action    Action attribute from form tag.
param: SimpleUrl $base   Page location.
return: SimpleUrl        Absolute form target.

getAction()   X-Ref
Absolute URL of the target.

return: SimpleUrl           URL target.

_encode()   X-Ref
Creates the encoding for the current values in the
form.

return: SimpleFormEncoding    Request to submit.

getId()   X-Ref
ID field of form for unique identification.

return: string           Unique tag ID.

addWidget(&$tag)   X-Ref
Adds a tag contents to the form.

param: SimpleWidget $tag        Input tag to add.

_setWidget(&$tag)   X-Ref
Sets the widget into the form, grouping radio
buttons if any.

param: SimpleWidget $tag   Incoming form control.

_addRadioButton(&$tag)   X-Ref
Adds a radio button, building a group if necessary.

param: SimpleRadioButtonTag $tag   Incoming form control.

_addCheckbox(&$tag)   X-Ref
Adds a checkbox, making it a group on a repeated name.

param: SimpleCheckboxTag $tag   Incoming form control.

getValue($selector)   X-Ref
Extracts current value from form.

param: SimpleSelector $selector   Criteria to apply.
return: string/array              Value(s) as string or null

setField($selector, $value)   X-Ref
Sets a widget value within the form.

param: SimpleSelector $selector   Criteria to apply.
param: string $value              Value to input into the widget.
return: boolean                   True if value is legal, false

attachLabelBySelector($selector, $label)   X-Ref
Used by the page object to set widgets labels to
external label tags.

param: SimpleSelector $selector   Criteria to apply.

hasSubmit($selector)   X-Ref
Test to see if a form has a submit button.

param: SimpleSelector $selector   Criteria to apply.
return: boolean                   True if present.

hasImage($selector)   X-Ref
Test to see if a form has an image control.

param: SimpleSelector $selector   Criteria to apply.
return: boolean                   True if present.

submitButton($selector, $additional = false)   X-Ref
Gets the submit values for a selected button.

param: SimpleSelector $selector   Criteria to apply.
param: hash $additional           Additional data for the form.
return: SimpleEncoding            Submitted values or false

submitImage($selector, $x, $y, $additional = false)   X-Ref
Gets the submit values for an image.

param: SimpleSelector $selector   Criteria to apply.
param: integer $x                 X-coordinate of click.
param: integer $y                 Y-coordinate of click.
param: hash $additional           Additional data for the form.
return: SimpleEncoding            Submitted values or false

submit()   X-Ref
Simply submits the form without the submit button
value. Used when there is only one button or it
is unimportant.

return: hash           Submitted values.



Generated: Sat Nov 22 03:48:54 2008 Cross-referenced by PHPXref 0.7