default
[ class tree: default ] [ index: default ] [ all elements ]

Class: MysqlDatasource

Source Location: /datasource/database/MysqlDatasource.class.php

Class Overview

Datasource
   |
   --MysqlDatasource

DatabaseDatasource serves as a base for database connections


Author(s):

  • Tyler Tompkins (ttompkins@mojavi.org)

Variables

Methods


Inherited Variables

Inherited Methods

Class: Datasource

Datasource::close()
Close the datasource
Datasource::getContents()
Retrieve the contents of the datasource
Datasource::getParameters()
Retrieve the parameters that were used to initialize the datasource
Datasource::getResource()
Retrieve the datasource resource or link
Datasource::isOpen()
Determine if the datasource is open or not
Datasource::open()
Open the datasource

Class Details

[line 19]
DatabaseDatasource serves as a base for database connections



Tags:

since:  4.0.0 $Id$
author:  Tyler Tompkins (ttompkins@mojavi.org)


[ Top ]


Class Variables

$dsn =  null

[line 26]

DsnHelper object



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 39]

void __construct( ServiceLocator $sl)

Construct the datasource



Tags:

access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)
throws:  If the Service Locator does not contain a DsnHelper


Parameters:

ServiceLocator   $sl  

[ Top ]

method close [line 68]

bool close( )

Close the datasource



Tags:

return:  True on success, false otherwise
access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overrides Datasource::close() (Close the datasource)

[ Top ]

method getContents [line 110]

mixed &getContents( )

Retrieve the contents of the datasource



Tags:

return:  String contents on success, false otherwise
access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overrides Datasource::getContents() (Retrieve the contents of the datasource)

[ Top ]

method getParameters [line 195]

array &getParameters( )

Retrieve the parameters that were used to initialize the datasource



Tags:

return:  Initialization parameters
access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overrides Datasource::getParameters() (Retrieve the parameters that were used to initialize the datasource)

[ Top ]

method getResource [line 93]

mixed &getResource( )

Retrieve the datasource resource or link



Tags:

return:  Resource contents on success, false otherwise
access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)


Overrides Datasource::getResource() (Retrieve the datasource resource or link)

[ Top ]

method open [line 131]

bool open( [array &$parameters = array()])

Open the datasource



Tags:

return:  True on success
access:  public
since:  4.0.0
author:  Tyler Tompkins (ttompkins@mojavi.org)
throws:  InitializationException if opening fails


Overrides Datasource::open() (Open the datasource)

Parameters:

array   &$parameters   Parameters array

[ Top ]


Documentation generated on Tue, 21 Feb 2006 02:29:55 +0900 by phpDocumentor 1.3.0RC5