Class reference：RisoluteDb Class(risoluto_db.php)

Outline

Class reference：RisoluteDb Class(risoluto_db.php)

Abstruction of the Class

It is a wrapper class of PEAR::MDB2. It enables various operations toward DB. It is not only just a wrapper method, but also has methods to ease processes related to DB and often used for DB processing.

How to create class instance

 require_once( RISOLUTO_FUNC . 'risoluto_db.php' );
 
 $instance = new RisoluteDb();

What this class depends on

PEAR::MDB2
PEAR::MDB2_Drivers_*

Contents of class

Class variable

$obj_instance

Scope	private(static)
Type	object
Purpose	It keeps the instance itself for singleton pattern.

$obj_db

Scope	private(static)
Type	object
Purpose	Keeping information of MDB2_Driver_Common.

Class method

__construct()

Scope	private
Parameter	N/A
Return value	N/A
Purpose	Constructor for this present class (prosesses nothing).

__clone()

Scope	private
Parameter	N/A
Return value	N/A
Type of Return value	N/A
Purpose	Clone method of this present class (prosesses nothing).

singleton()

Scope	public(static)
Parameter	N/A
Return value	N/A
Type of Return value	N/A
Purpose	Creates and returns this present instance with singleton pattern.

dbConnect()

Scope	public
Parameter	string $dsnid DSN
Return value	Result for execution of function (true: normal end / false: abnormal end)
Type of Return value	boolean
Purpose	Connect to DB with using DNS given as a parameter.

 $result = $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 
 var_dump( $result );

dbDisConnect()

Scope	public
Parameter	N/A
Return value	Result for execution of function (true: normal end / false: abnormal end)
Type of Return value	boolean
Purpose	Close connection to DB.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->dbDisConnect();
 
 var_dump( $result );

dbCommit()

Scope	public
Parameter	N/A
Return value	Result for execution of function (true: normal end / false: abnormal end)
Type of Return value	boolean
Purpose	Commits transaction.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $instance->dbBeginTransaction();
 $result = $instance->dbCommit();
 $instance->dbDisConnect();
 
 var_dump( $result );

dbRollback()

Scope	public
Parameter	N/A
Return value	Result for execution of function (true: normal end / false: abnormal end)
Type of Return value	boolean
Purpose	Rolls back transaction.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $instance->dbBeginTransaction();
 $result = $instance->dbRollback();
 $instance->dbDisConnect();
 
 var_dump( $result );

dbBeginTransaction()

Scope	public
Parameter	N/A
Return value\|Result for execution of function (true: normal end / false: abnormal end)
Type of Return value	boolean
Purpose	Starts transaction.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->dbBeginTransaction();
 $instance->dbRollback();
 $instance->dbDisConnect();
 
 var_dump( $result );

dbSetOptions()

Scope	public
Parameter	N/A
Return value	always true
Type of Return value	boolean
Purpose	Sets up options of MDB2. Setting values are hard-coded, and it's automatically called when connection by dbConnect() succeeds.

dbGetErrMsg()

Scope	public
Parameter	object $obj_err MDB:ERROR object (can be omitted)
Return value	Acquired error message
Type of Return value	string
Purpose	Acquires error messages from MDB::ERROR in case it's assigned, if not, acquires from class variable ($obj_db).

 $result = $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 if ( PEAR::isError( $result ) )
 {
   var_dump( $instance->dbGetErrMsg( $result ) );
 }

dbGetAll()

Scope	public
Parameter	string $query SQL query to execute ('?' in query is a place holder)/Arrayed SQL to store a replacing value of string $param place holder
Return value	Result of query execution (for error happens, DB:ERROR object)
Type of Return value	array
Purpose	Executes query assigned by Parameter, then acquires result as array.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->dbGetAll( 'select col1,col2 from table where key = ?', array( 'key' ) );

And an example of aquired result is as follows:

  [0] = array(
            array(
              'col1' => 'value1'
             ,'col2' => 'value2'
            )
        )
 ,[1] = array(
            array(
              'col1' => 'value1'
             ,'col2' => 'value2'
            )
        )

dbGetRow()

Scope	public
Parameter	string $param SQL query to execute ('?' in query is a place holder)/Arrayed SQL to store a replacing value of string $param place holder
Return value	Result of query execution (for error happens, DB:ERROR object)
Type of Return value	array
Purpose	Executes query assigned by Parameter, then acquires result as array.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->dbGetRow( 'select col1,col2 from table where key = ?', array( 'key' ) );
 
 var_dump( $result );

And the acquisition result is as follows:

 array(
   'col1' => 'value1'
  ,'col2' => 'value2'
 )

dbExecSQL()

Scope	public
Parameter	string $param SQL query to execute ('?' in query is a place holder)/Arrayed SQL to store a replacing value of string $param place holder
Return value	Result of query execution (for error happens, DB:ERROR object)
Type of Return value	mixed
Purpose	Executes query assigned by Parameter. Mainly used to publish SQL except for SELECT such as INSERT/UPDATE/DELETE.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->dbExecSQL( 'insert into table( col1,col2 ) values ( ?, ? )', array( 'value1','value2' ) );
 
 var_dump( $result );

fileSQLExec()

Scope	public
Parameter	string $path File includes SQL to execute
Return value	Result of execution (true: all executed normally/false: some or all failed)
Type of Return value	boolean
Purpose	Executes SQL in the file assigned by Parameter. Each SQL in the file should be delimitted by ';', though line feed or space can be written freely.

 $instance->dbConnect( 'phptype://username:password@hostspec/database' );
 $result = $instance->fileSQLExec( '/tmp/sql.txt' );
 
 var_dump( $result );

Return

risoluto (1.3.1)	2011-09-27 15:41
risoluto-upgrade (1.3.0 to 1.3.1)	2011-10-24 15:51
simpleblog (1.4.0)	2011-10-19 14:50
simpleblog-upgrade (1.2.0 to 1.3.0)	2011-07-21 23:13
simplepage (1.3.0)	2011-10-19 14:45
simplepage-upgrade (1.1.0 to 1.2.0)	2011-07-21 23:15

ご注意ください

最近の更新

2012-10-11

2012-04-05

2012-03-27

最新リリース情報

Wikiガイド

サイドバー