Docs For Class Structures_DataGrid

Structures_DataGrid_DataSource Structures_DataGrid_DataSource(
)

Constructor

[ Top ]

object PEAR_Error bind(
mixed
$container, [array
$options = array()])

Datasource binding method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. When overloaded this method must return true on success or a PEAR_Error object on failure.

Return: with message "No data source driver loaded"
Abstract:
Access: public

Overridden in child classes as:

Structures_DataGrid_DataSource_SQLQuery::bind(): Bind

Parameters:

mixed	`$container`	—	The datasource container
array	`$options`	—	Binding options

[ Top ]

object PEAR_Error count(
)

Counting method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. Note: must be called before fetch()

When overloaded, this method must return the total number or records or a PEAR_Error object on failure

Return: with message "No data source driver loaded"
Abstract:
Access: public

Overridden in child classes as:

Structures_DataGrid_DataSource_SQLQuery::count(): Count

[ Top ]

object PEAR_Error delete(
array
$key)

Record deletion method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. Drivers that support the "writeMode" feature must implement this method.

When overloaded this method must return true on success or a PEAR_Error object on failure.

Return: with message "No data source driver loaded or write mode not supported by the current driver"
Abstract:
Access: public

Parameters:

array $key — Unique record identifier

[ Top ]

string dump(
[integer
$offset = 0], [integer
$len = null], [string
$sortField = null], [string
$sortDir = 'ASC'])

Dump the data as returned by fetch().

This method is meant for debugging purposes. It returns what fetch() would return to its DataGrid host as a nicely formatted console-style table.

Return: The table string, ready to be printed
Access: public
Uses: Structures_DataGrid_DataSource::fetch()

Parameters:

integer	`$offset`	—	Limit offset (starting from 0)
integer	`$len`	—	Limit length
string	`$sortField`	—	Field to sort by
string	`$sortDir`	—	Sort direction: 'ASC' or 'DESC'

[ Top ]

object PEAR_Error fetch(
[integer
$offset = 0], [integer
$len = null])

Fetching method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. When overloaded this method must return an array of records. Each record can be either an associative array of field name/value pairs, or an object carrying fields as properties.

This method must return a PEAR_Error object on failure.

Return: with message "No data source driver loaded"
Abstract:
Access: public
Usedby: Structures_DataGrid_DataSource::dump()

Overridden in child classes as:

Structures_DataGrid_DataSource_SQLQuery::fetch(): Fetch

Parameters:

integer	`$offset`	—	Limit offset (starting from 0)
integer	`$len`	—	Limit length

[ Top ]

void free(
)

Resources cleanup method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. This is where drivers should close sql connections, files, etc... if needed.

Abstract:
Access: public

Overridden in child classes as:

Structures_DataGrid_DataSource_SQLQuery::free(): Disconnect from the database, if needed

[ Top ]

array getColumns(
)

Generate columns if options are properly set

Note: must be called after fetch()

Return: Array of Column objects. Empty array if irrelevant.
Deprecated: This method relates to the deprecated "generate_columns" option.
Access: public

[ Top ]

array getFeatures(
)

List special driver features

Return: Of the form: array(feature => true|false, etc...)
Access: public

[ Top ]

array getPrimaryKey(
)

Return the primary key specification

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. This method always returns an array containing:

either one field name or index in case of a single-field key
or several field names or indexes in case of a multiple-fields key

Drivers that support the "writeMode" feature should overload this method if the key can be detected. However, the detection must not override the "primaryKey" option.

Return: Field(s) name(s) or numerical index(es)
Access: protected

[ Top ]

bool hasFeature(
string
$name)

Tell if the driver as a specific feature

Access: public

Parameters:

string $name — Feature name

[ Top ]

object PEAR_Error insert(
array
$data)

Record insertion method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. Drivers that support the "writeMode" feature must implement this method.

When overloaded this method must return true on success or a PEAR_Error object on failure.

Return: with message "No data source driver loaded or write mode not supported by the current driver"
Abstract:
Access: public

Parameters:

array $data — Associative array of the form: array(field => value, ..)

[ Top ]

void setOption(
string
$name, mixed
$value)

Set a single option

Access: public

Parameters:

string	`$name`	—	Option name
mixed	`$value`	—	Option value

[ Top ]

void setOptions(
mixed
$options)

Set options

Access: protected

Parameters:

mixed $options — An associative array of the form: array("option_name" => "option_value",...)

[ Top ]

object PEAR_Error sort(
string
$sortSpec, [string
$sortDir = null])

Sorting method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. When overloaded this method must return true on success or a PEAR_Error object on failure.

Note: must be called before fetch()

Return: with message "No data source driver loaded"
Abstract:
Access: public

Overridden in child classes as:

Structures_DataGrid_DataSource_SQLQuery::sort(): This can only be called prior to the fetch method.

Parameters:

string	`$sortSpec`	—	If the driver supports the "multiSort" feature this can be either a single field (string), or a sort specification array of the form: array(field => direction, ...) If "multiSort" is not supported, then this can only be a string.
string	`$sortDir`	—	Sort direction: 'ASC' or 'DESC'

[ Top ]

object PEAR_Error update(
array
$key, array
$data)

Record updating method prototype

This method is public, but please note that it is not intended to be called by user-space code. It is meant to be called by the main Structures_DataGrid class.

It is an abstract method, part of the DataGrid Datasource driver interface, and must/may be overloaded by drivers. Drivers that support the "writeMode" feature must implement this method.

When overloaded this method must return true on success or a PEAR_Error object on failure.

Return: with message "No data source driver loaded or write mode not supported by the current driver"
Abstract:
Access: public

Parameters:

array	`$key`	—	Unique record identifier
array	`$data`	—	Associative array of the form: array(field => value, ..)

[ Top ]

void _addDefaultOptions(
array
$options)

Adds some default options.

This method is meant to be called by drivers. It allows adding some default options.

See: Structures_DataGrid_DataSource::_setOption
Access: protected

Parameters:

array $options — An associative array of the form: array(optionName => optionValue, ...)

[ Top ]

void _setFeatures(
array
$features)

Add special driver features

This method is meant to be called by drivers. It allows specifying the special features that are supported by the current driver.

Access: protected

Parameters:

array $features — An associative array of the form: array(feature => true|false, ...)

[ Top ]

Class: Structures_DataGrid_DataSource

Class Overview

Author(s):

Version:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$_features = array()

$_options = array()

Method Detail

Structures_DataGrid_DataSource (Constructor) [line 100]

bind [line 287]

Parameters:

count [line 244]

delete [line 371]

Parameters:

dump [line 433]

Parameters:

fetch [line 226]

Parameters:

free [line 387]

getColumns [line 180]

getFeatures [line 401]

getPrimaryKey [line 328]

hasFeature [line 413]

Parameters:

insert [line 308]

Parameters:

setOption [line 166]

Parameters:

setOptions [line 154]

Parameters:

sort [line 269]

Parameters:

update [line 350]

Parameters:

_addDefaultOptions [line 126]

Parameters:

_setFeatures [line 142]

Parameters: