apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
HTML_QuickForm_ElementGrid


Classes:
HTML_QuickForm_ElementGrid
   HTML_QuickForm_ElementGrid

Class: HTML_QuickForm_ElementGrid

Source Location: /HTML_QuickForm_ElementGrid-0.1.2/HTML/QuickForm/ElementGrid.php

Class Overview

HTML_QuickForm_element
   |
   --HTML_QuickForm_ElementGrid

An HTML_QuickForm element which holds any number of other elements in a grid.

Methods

Inherited Variables

Inherited Methods

Class Details

[line 23]
An HTML_QuickForm element which holds any number of other elements in a grid.

Used in DB_DataObject_FormBuilder for tripleLinks and crossLinks when there are crossLinkExtraFields. This element type makes these grids of elements behave the same as normal elements in the form. i.e. they will freeze correctly and get values (defaults) set correctly.



[ Top ]

Method Detail

HTML_QuickForm_ElementGrid (Constructor)   [line 73]

HTML_QuickForm_ElementGrid HTML_QuickForm_ElementGrid( [string $name = null], [string $label = null], [ $options = null])

Constructor

Parameters:

string   $name   —  name for the element
string   $label   —  label for the element
   $options   — 

[ Top ]

addColumnName   [line 122]

void addColumnName( string $columnName)

Adds a column name

Parameters:

string   $columnName   —  name of the column

[ Top ]

addRow   [line 155]

void addRow( array &$row, [string $rowName = null])

Adds a row to the grid

Parameters:

array   &$row   —  array of HTML_QuickForm elements
string   $rowName   —  name of the row

[ Top ]

addRowName   [line 179]

void addRowName( string $rowName)

Adds a row name

Parameters:

string   $rowName   —  name of the row

[ Top ]

exportValue   [line 285]

mixed exportValue( array &$submitValues, bool $assoc)

Returns a 'safe' element's value
  • Access: public

Parameters:

array   &$submitValues   —  array of submitted values to search
bool   $assoc   —  whether to return the value as associative array

[ Top ]

freeze   [line 187]

void freeze( )

Freezes all elements in the grid

[ Top ]

getName   [line 102]

string getName( )

Gets this element's name
  • Return: name

[ Top ]

getValue   [line 316]

mixed getValue( )

Returns the value of the form element
  • Since: 1.0
  • Access: public

[ Top ]

onQuickFormEvent   [line 256]

bool onQuickFormEvent( string $event, mixed $arg, object calling &$caller)

Called by HTML_QuickForm whenever form event is made on this element
  • Return: true
  • Access: public

Parameters:

string   $event   —  Name of event
mixed   $arg   —  event arguments
object calling   &$caller   —  object

[ Top ]

setColumnNames   [line 112]

void setColumnNames( array $columnNames)

Sets the column names

Parameters:

array   $columnNames   —  array of column names (strings)

[ Top ]

setName   [line 92]

void setName( string $name)

Sets this element's name

Parameters:

string   $name   —  name

[ Top ]

setRowNames   [line 132]

void setRowNames( array $rowNames)

Set the row names

Parameters:

array   $rowNames   —  array of row names (strings)

[ Top ]

setRows   [line 142]

void setRows( array &$rows)

Sets the rows

Parameters:

array   &$rows   —  array of HTML_QuickForm elements

[ Top ]

toHtml   [line 203]

string toHtml( )

Returns Html for the element
  • Access: public

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:47:40 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.