DataSource Class Reference

Inheritance diagram for DataSource:

Object DboSource DboAdodb DboDb2 DboFirebird DboMssql DboMysqlBase DboOdbc DboOracle DboPostgres DboSqlite DboSybase List of all members.

Public Member Functions

 __cacheDescription ($object, $data=null)
 __construct ($config=array())
 __destruct ()
 begin (&$model)
 column ($real)
 commit (&$model)
 create (&$model, $fields=null, $values=null)
 delete (&$model, $id=null)
 describe ($model)
 insertQueryData ($query, $data, $association, $assocData, &$model, &$linkModel, $stack)
 isInterfaceSupported ($interface)
 lastAffected ($source=null)
 lastInsertId ($source=null)
 lastNumRows ($source=null)
 listSources ($data=null)
 read (&$model, $queryData=array())
 resolveKey ($model, $key)
 rollback (&$model)
 setConfig ($config=array())
 sources ($reset=false)
 update (&$model, $fields=null, $values=null)

Public Attributes

 $__descriptions = array()
 $_baseConfig = array()
 $_queriesCnt = 0
 $_queriesLog = array()
 $_queriesLogMax = 200
 $_queriesTime = null
 $_queryCache = array()
 $_result = null
 $_sources = null
 $_transactionStarted = false
 $affected = null
 $cacheSources = true
 $config = array()
 $configKeyName = null
 $connected = false
 $connection = null
 $endQuote = null
 $error = null
 $fullDebug = false
 $numRows = null
 $startQuote = null
 $took = null

Detailed Description

Definition at line 35 of file datasource.php.

Constructor & Destructor Documentation

DataSource::__construct ( $  config = array()  ) 

Constructor.

Definition at line 193 of file datasource.php.

References $config, __construct(), and setConfig().

DataSource::__destruct (  ) 

Closes the current datasource.

Definition at line 500 of file datasource.php.

References close(), and rollback().

Member Function Documentation

DataSource::__cacheDescription ( $  object,
$  data = null 
)

Cache the DataSource description

Parameters:
string $object The name of the object (model) to cache
mixed $data The description of the model, usually a string or array

Definition at line 387 of file datasource.php.

References ConnectionManager::getSourceName(), Cache::read(), and Cache::write().

Referenced by DboSybase::describe(), DboSqlite::describe(), DboOracle::describe(), DboOdbc::describe(), DboMysqli::describe(), DboMysql::describe(), DboMssql::describe(), DboFirebird::describe(), DboDb2::describe(), DboAdodb::describe(), and describe().

DataSource::begin ( &$  model  ) 

Begin a transaction

Returns:
boolean Returns true if a transaction is not in progress

Reimplemented in DboAdodb, DboDb2, DboSybase, and DboSource.

Definition at line 261 of file datasource.php.

DataSource::column ( $  real  ) 

Converts column types to basic types

Parameters:
string $real Real column type (i.e. "varchar(255)")
Returns:
string Abstract column type (i.e. "string")

Reimplemented in DboAdodb, DboDb2, DboFirebird, DboMssql, DboMysql, DboMysqli, DboOdbc, DboOracle, DboPostgres, DboSqlite, and DboSybase.

Definition at line 286 of file datasource.php.

Referenced by DboMysqlBase::_alterIndexes(), DboMysql::describe(), and DboMysqlBase::index().

DataSource::commit ( &$  model  ) 

Commit a transaction

Returns:
boolean Returns true if a transaction is in progress

Reimplemented in DboAdodb, DboDb2, DboSybase, and DboSource.

Definition at line 269 of file datasource.php.

DataSource::create ( &$  model,
$  fields = null,
$  values = null 
)

To-be-overridden in subclasses.

Parameters:
unknown_type $model
unknown_type $fields
unknown_type $values
Returns:
unknown

Reimplemented in DboMssql, and DboSource.

Definition at line 297 of file datasource.php.

DataSource::delete ( &$  model,
$  id = null 
)

To-be-overridden in subclasses.

Parameters:
unknown_type $model
unknown_type $id

Reimplemented in DboMysqlBase, and DboSource.

Definition at line 327 of file datasource.php.

References $id.

DataSource::describe ( $  model  ) 

Returns a Model description (metadata) or null if none found.

Parameters:
Model $model
Returns:
mixed

Definition at line 240 of file datasource.php.

References __cacheDescription().

DataSource::insertQueryData ( $  query,
$  data,
$  association,
$  assocData,
&$  model,
&$  linkModel,
$  stack 
)

Enter description here...

Parameters:
unknown_type $query
unknown_type $data
unknown_type $association
unknown_type $assocData
Model $model
Model $linkModel
array $stack
Returns:
unknown

Definition at line 418 of file datasource.php.

References $id.

Referenced by DboSource::queryAssociation(), and DboOracle::queryAssociation().

DataSource::isInterfaceSupported ( $  interface  ) 

Returns true if the DataSource supports the given interface (method)

Parameters:
string $interface The name of the interface (method)
Returns:
boolean True on success

Definition at line 365 of file datasource.php.

DataSource::lastAffected ( $  source = null  ) 

Returns the ID generated from the previous INSERT operation.

Parameters:
unknown_type $source
Returns:
in

Definition at line 356 of file datasource.php.

Referenced by DboSource::execute().

DataSource::lastInsertId ( $  source = null  ) 

Returns the ID generated from the previous INSERT operation.

Parameters:
unknown_type $source
Returns:
in

Reimplemented in DboDb2, DboMssql, DboMysql, DboMysqli, DboOdbc, DboOracle, and DboSybase.

Definition at line 338 of file datasource.php.

Referenced by DboSource::create().

DataSource::lastNumRows ( $  source = null  ) 

Returns the ID generated from the previous INSERT operation.

Parameters:
unknown_type $source
Returns:
in

Definition at line 347 of file datasource.php.

Referenced by DboSource::execute().

DataSource::listSources ( $  data = null  ) 

Caches/returns cached results for child instances

Returns:
array

Definition at line 202 of file datasource.php.

References config(), ConnectionManager::getSourceName(), Cache::read(), and Cache::write().

Referenced by sources().

DataSource::read ( &$  model,
$  queryData = array() 
)

To-be-overridden in subclasses.

Parameters:
unknown_type $model
unknown_type $queryData
Returns:
unknown

Definition at line 307 of file datasource.php.

DataSource::resolveKey ( $  model,
$  key 
)

To-be-overridden in subclasses.

Parameters:
unknown_type $model
unknown_type $key
Returns:
unknown

Definition at line 493 of file datasource.php.

DataSource::rollback ( &$  model  ) 

Rollback a transaction

Returns:
boolean Returns true if a transaction is in progress

Reimplemented in DboAdodb, DboDb2, DboSybase, and DboSource.

Definition at line 277 of file datasource.php.

Referenced by __destruct().

DataSource::setConfig ( $  config = array()  ) 

Sets the configuration for the DataSource

Parameters:
array $config The configuration array
Returns:
void

Definition at line 378 of file datasource.php.

References $config, and config().

Referenced by __construct(), and DboSource::reconnect().

DataSource::sources ( $  reset = false  ) 

Convenience method for DboSource::listSources(). Returns source names in lowercase.

Returns:
array

Definition at line 228 of file datasource.php.

References listSources().

DataSource::update ( &$  model,
$  fields = null,
$  values = null 
)

To-be-overridden in subclasses.

Parameters:
unknown_type $model
unknown_type $fields
unknown_type $values
Returns:
unknown

Reimplemented in DboDb2, and DboFirebird.

Definition at line 318 of file datasource.php.

Member Data Documentation

DataSource::$__descriptions = array()

Definition at line 147 of file datasource.php.

DataSource::$_baseConfig = array()

Reimplemented in DboDb2, DboFirebird, DboMssql, DboMysql, DboMysqli, DboOdbc, DboOracle, DboPostgres, DboSqlite, and DboSybase.

Definition at line 140 of file datasource.php.

DataSource::$_queriesCnt = 0

Definition at line 103 of file datasource.php.

DataSource::$_queriesLog = array()

Definition at line 117 of file datasource.php.

DataSource::$_queriesLogMax = 200

Definition at line 126 of file datasource.php.

DataSource::$_queriesTime = null

Definition at line 110 of file datasource.php.

DataSource::$_queryCache = array()

Definition at line 133 of file datasource.php.

DataSource::$_result = null

Definition at line 96 of file datasource.php.

DataSource::$_sources = null

Definition at line 154 of file datasource.php.

DataSource::$_transactionStarted = false

Definition at line 182 of file datasource.php.

DataSource::$affected = null

Definition at line 63 of file datasource.php.

DataSource::$cacheSources = true

Definition at line 189 of file datasource.php.

DataSource::$config = array()

Reimplemented in DboOracle.

Definition at line 168 of file datasource.php.

Referenced by DboSource::__construct(), DboMssql::__construct(), __construct(), DboSybase::connect(), DboSqlite::connect(), DboPostgres::connect(), DboOdbc::connect(), DboMysqli::connect(), DboMysql::connect(), DboMssql::connect(), DboFirebird::connect(), DboDb2::connect(), DboAdodb::connect(), DboSource::reconnect(), and setConfig().

DataSource::$configKeyName = null

Definition at line 175 of file datasource.php.

DataSource::$connected = false

Definition at line 42 of file datasource.php.

DataSource::$connection = null

Reimplemented in DboOracle.

Definition at line 161 of file datasource.php.

DataSource::$endQuote = null

Reimplemented in DboDb2, DboFirebird, DboMssql, DboMysqlBase, DboOdbc, DboPostgres, DboSqlite, and DboSybase.

Definition at line 89 of file datasource.php.

DataSource::$error = null

Definition at line 56 of file datasource.php.

Referenced by DboSqlite::lastError(), DboOdbc::lastError(), DboFirebird::lastError(), and DboSource::showQuery().

DataSource::$fullDebug = false

Definition at line 49 of file datasource.php.

DataSource::$numRows = null

Definition at line 70 of file datasource.php.

DataSource::$startQuote = null

Reimplemented in DboDb2, DboFirebird, DboMssql, DboMysqlBase, DboOdbc, DboPostgres, DboSqlite, and DboSybase.

Definition at line 83 of file datasource.php.

DataSource::$took = null

Definition at line 77 of file datasource.php.

The documentation for this class was generated from the following file:
Generated on Sun Nov 22 00:30:55 2009 for CakePHP 1.2.x.x (v1.2.4.8284) by doxygen 1.4.7