Structures_DataGrid::dataSourceFactory

Structures_DataGrid::dataSourceFactory() -- Datasource driver Factory

Synopsis

require_once 'Structures/DataGrid.php';

Structures_DataGrid_DataSource|PEAR_Error& Structures_DataGrid::dataSourceFactory ( mixed $source , array $options = array() , string $type = NULL )

Description

A clever method which loads and instantiate data source drivers.

Can be called in various ways:

Detect the source type and load the appropriate driver with default options:


<?php
$driver =& Structures_DataGrid::dataSourceFactory($source);
?>

Detect the source type and load the appropriate driver with custom options:


<?php
$driver =& Structures_DataGrid::dataSourceFactory($source, $options);
?>

Load a driver for an explicit type (faster, bypasses detection routine):


<?php
$driver =& Structures_DataGrid::dataSourceFactory($source, $options, $type);
?>

Parameter

mixed $source: The data source respective to the driver

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

string $type: The data source type constant (of the form DATAGRID_SOURCE_*)

Return value

returns driver object or PEAR_Error on failure

Throws

throws no exceptions thrown

See

see Structures_DataGrid::_detectSourceType()

Note

This function can not be called statically.