Docs For Class Structures_DataGrid

Structures_DataGrid_Column (Constructor) [line 141]

Structures_DataGrid_Column Structures_DataGrid_Column(
string
$label, [string
$field = null], [string
$orderBy = null], [array
$attributes = array()], [string
$autoFillValue = null], [mixed
$formatter = null], [array
$formatterArgs = array()])

Constructor

Creates default table style settings

See: Structures_DataGrid_Column::setFormatter()
See: Structures_DataGrid::addColumn()
See: http://www.php.net/manual/en/language.pseudo-types.php
Access: public

Parameters:

string	`$label`	—	The label of the column to be printed
string	`$field`	—	The name of the field for the column to be mapped to
string	`$orderBy`	—	The field or expression to order the data by
array	`$attributes`	—	The attributes for the XML or HTML TD tag; form: array(name => value, ...)
string	`$autoFillValue`	—	The value to use for the autoFill
mixed	`$formatter`	—	Formatter callback. See setFormatter()
array	`$formatterArgs`	—	Associative array of arguments passed as second argument to the formatter callback

[ Top ]

format [line 382]

void format(

$type, mixed
$type,...)

Choose a format preset

EXPERIMENTAL: the behaviour of this method may change in future releases.

This method allows to associate an "automatic" predefined formatter to the column, for common needs as formatting dates, numbers, ...

The currently supported predefined formatters are :

dateFromTimestamp: format a UNIX timestamp according to the date()-like format string passed as second argument
dateFromMysql : format a MySQL DATE, DATETIME, or TIMESTAMP MySQL according to the date() like format string passed as second argument
number: format a number, according to the same optional 2nd, 3rd and 4th arguments that the number_format() PHP function accepts.
printf: format using the printf expression passed as 2nd argument.
printfURL: url-encode and format using the printf expression passed as 2nd argument

Access: public
Example: example not found

Parameters:

mixed	`$type,...`	—	Predefined formatter name, followed by formatter-specific parameters
	`$type`	—

[ Top ]

formatter [line 495]

void formatter(

$record, 
$row, 
$col)

Formatter

This method is not meant to be called by user-space code.

Calls a predefined function to develop custom output for the column. The defined function can accept parameters so that each cell in the column can be unique based on the record. The function will also automatically receive the record array as a parameter. All parameters passed into the function will be in one array.

Access: public

Parameters:

	`$record`	—
	`$row`	—
	`$col`	—

[ Top ]

getAttributes [line 266]

array getAttributes(
)

Get the column XML/HTML attributes

Return the attributes applied to all cells in this column. This only makes sense for HTML or XML rendering

Return: Attributes; form: array(name => value, ...)
Access: public

[ Top ]

getAutoFillValue [line 293]

string getAutoFillValue(
)

Get auto fill value

Returns the value to be printed if a cell in the column is null.

Access: public

[ Top ]

getDefaultDirection [line 241]

string getDefaultDirection(

$str)

Return the default direction to order this column by

Return: "ASC" or "DESC"
Access: public

Parameters:

$str —

[ Top ]

getField [line 194]

string getField(
)

Get name of the field for the column to be mapped to

Returns the name of the field for the column to be mapped to

Access: public

[ Top ]

getLabel [line 168]

string getLabel(
)

Get column label

The label is the text rendered into the column header.

Access: public

[ Top ]

getOrderBy [line 219]

string getOrderBy(
)

Get the field name to order the data by

Return: field name
Access: public

[ Top ]

setAttributes [line 280]

void setAttributes(
array
$attributes)

Set the column XML/HTML attributes

Set the attributes to be applied to all cells in this column. This only makes sense for HTML or XML rendering

Access: public

Parameters:

array $attributes — form: array(name => value, ...)

[ Top ]

setAutoFillValue [line 306]

void setAutoFillValue(
string
$str)

Set auto fill value

Defines a value to be printed if a cell in the column is null.

Access: public

Parameters:

string $str — The value to use for the autoFill

[ Top ]

setDefaultDirection [line 252]

void setDefaultDirection(
string
$str)

Set the default direction to order this column by

Access: public

Parameters:

string $str — "ASC" or "DESC"

[ Top ]

setField [line 208]

void setField(
string
$str)

Set name of the field for the column to be mapped to

Defines the name of the field for the column to be mapped to

Access: public

Parameters:

string $str — The name of the field for the column to be mapped to

[ Top ]

setFormatter [line 340]

mixed setFormatter(
mixed
$formatter, [array
$arguments = array()])

Set Formatter Callback

Define a formatting callback function with optional arguments for this column.

The callback function receives the following array as its first argument:

 array(

   'record' => associative array of all fields values for this record,
   'fieldName' => the field name of this column,
   'columnName' => the label (header) of this column,
   'orderBy' => the field name to sort this column by,
   'attribs' => this column's attributes,
   'currRow' => zero-based row index,
   'currCol' => zero-based column index,
 );

If you pass the optional $arguments parameter to setFormatter(), the callback function will receive it as its second argument.

Return: PEAR_Error on failure
See: http://www.php.net/manual/en/language.pseudo-types.php
Access: public

Parameters:

mixed	`$formatter`	—	Callback PHP pseudo-type (Array or String)
array	`$arguments`	—	Associative array of parameters passed to as second argument to the callback function

[ Top ]

setLabel [line 181]

void setLabel(
string
$str)

Set column label

The label is the text rendered into the column header.

Access: public

Parameters:

string $str — Column label

[ Top ]

setOrderBy [line 230]

void setOrderBy(
string
$str)

Set the field name to order the data by

Access: public

Parameters:

string $str — field name

[ Top ]

Class: Structures_DataGrid_Column

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$attribs =

$autoFillValue =

$columnName =

$fieldName =

$id =

$orderBy =

Method Detail

Structures_DataGrid_Column (Constructor) [line 141]

Parameters:

format [line 382]

Parameters:

formatter [line 495]

Parameters:

getAttributes [line 266]

getAutoFillValue [line 293]

getDefaultDirection [line 241]

Parameters:

getField [line 194]

getLabel [line 168]

getOrderBy [line 219]

setAttributes [line 280]

Parameters:

setAutoFillValue [line 306]

Parameters:

setDefaultDirection [line 252]

Parameters:

setField [line 208]

Parameters:

setFormatter [line 340]

Parameters:

setLabel [line 181]

Parameters:

setOrderBy [line 230]

Parameters: