Class: Structures_DataGrid_Renderer_HTMLSortForm

Source Location: /Structures_DataGrid_Renderer_HTMLSortForm-0.1.3/DataGrid/Renderer/HTMLSortForm.php

Class Overview

Structures_DataGrid_Renderer
   |
   --Structures_DataGrid_Renderer_HTMLSortForm

Multiple fields sorting form rendering driver

Author(s):

Olivier Guilyardi <olivier at samalyse.com>

Version:

$Revision: 1.16 $

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 86]
Multiple fields sorting form rendering driver

This driver renders a form (using HTML_QuickForm) so that the user can select several fields and directions to sort the datagrid by.

SUPPORTED OPTIONS:

sortFieldsNum: (int) How many fields the user will be able to sort by. This has no effect if the backend does not support sorting by multiple fields.
directionStyle: (string) Whether to render the direction form elements as 'select' or 'radio' elements
textChoose: (string) What to display in the select box when no field is selected (first option)
textAscending: (string) Label for the ASC direction
textDescending: (string) Label for the DESC direction
textSortBy: (string) Label for the first field
textThenBy: (string) Label for the second and following fields
textSubmit: (string) Label for the submit button
columnAttributes: (-) IGNORED

SUPPORTED OPERATION MODES:

Container Support: yes
Output Buffering: yes
Direct Rendering: no
Streaming: no
Object Preserving: no

Author: Olivier Guilyardi <olivier@samalyse.com>
Version: $Revision: 1.16 $
Access: public
Example: example not found

[ Top ]

Class Variables

$_form =

[line 94]

Rendering container

Var: object
Access: protected

Type:

object HTML_QuickForm

[ Top ]

$_isUserContainer =

[line 101]

Whether the container was provided by the user

Access: protected

Type:

bool

[ Top ]

Method Detail

Structures_DataGrid_Renderer_HTMLSortForm (Constructor) [line 110]

Structures_DataGrid_Renderer_HTMLSortForm Structures_DataGrid_Renderer_HTMLSortForm(
)

Constructor

Build default values

Access: public

[ Top ]

buildBody [line 197]

void buildBody(
array
$columns)

Build form elements

Access: protected

Parameters:

array $columns — Columns' fields names and labels

[ Top ]

flatten [line 277]

mixed flatten(
)

Retrieve output from the container object

Return: Output
Access: protected

[ Top ]

getContainer [line 151]

object HTML_QuickForm &getContainer(
)

Return the currently used HTML_QuickForm object

Return: (reference to) or PEAR_Error
Access: public

[ Top ]

init [line 162]

void init(
)

Instantiate the HTML_QuickForm container if needed, and set it up

Access: protected

[ Top ]

setContainer [line 139]

mixed setContainer(

&$form)

Attach an already instantiated HTML_QuickForm object

Var: object
Return: True or PEAR_Error
Access: public

Parameters:

&$form —

[ Top ]