Structures_DataGrid_DataSource

PEAR Manual

Structures_DataGrid_DataSource_DB -- PEAR::DB Data Source Driver

Description

This class is a data source driver for the PEAR::DB::DB_Result object

This driver supports the following operation modes:

Table 58-1. Supported operations modes of this driver

Mode	Supported?
Multiple field sorting	no
Insert, update and delete records	no

This driver accepts the following options:

Table 58-2. Options for this driver

Option	Type	Description	Default Value
fields	array	Which data fields to fetch from the datasource. An empty array means: all fields. Form: array(field1, field2, ...)	array()
generate_columns	bool	Generate Structures_DataGrid_Column objects with labels. See the 'labels' option. DEPRECATED: use Structures_DataGrid::generateColumns() instead	false
labels	array	Data field to column label mapping. Only used when 'generate_columns' is true. Form: array(field => label, ...) DEPRECATED: use Structures_DataGrid::generateColumns() instead	array()
natsort	boolean	Whether the array should be sorted naturally (e.g. example1, Example2, test1, Test2) or not (e.g. Example2, Test2, example1, test1; i.e. capital letters will come first).	false
primaryKey	array	Name(s), or numerical index(es) of the field(s) which contain a unique record identifier (only use several fields in case of a multiple-fields primary key)	null