Docs For Class Ethna

Description

Ethna用DB抽象クラス

EthnaのフレームワークでDBオブジェクトを扱うための抽象クラス (のつもり...あぁすばらしきPHP 4)

author: Masaki Fujimoto <fujimoto@php.net>
access: public

Direct descendents

Class	Description
Ethna_DB_PEAR	Ethna用DB抽象クラス
Ethna_DB_ADOdb	Ethna_DB_ADOdb

Variable Summary

mixed $db

mixed $transaction

Method Summary

Ethna_DB __construct (object Ethna_Controller $controller, string $dsn, bool $persistent)

mixed begin ()

mixed commit ()

mixed connect ()

void disconnect ()

string getDSN ()

mixed getMetaData ()

bool isValid ()

array parseDSN (string $dsn)

mixed rollback ()

Variables

mixed $db (line 32)

access: public

Redefined in descendants as:

mixed $transaction = array() (line 35)

access: protected

Redefined in descendants as:

Ethna_DB_PEAR::$transaction

Methods

Constructor __construct (line 48)

Ethna_DBクラスのコンストラクタ

access: public

Ethna_DB __construct (object Ethna_Controller $controller, string $dsn, bool $persistent)

object Ethna_Controller $controller: コントローラオブジェクト
string $dsn: DSN
bool $persistent: 持続接続設定

Redefined in descendants as:

Ethna_DB_PEAR::__construct() : Ethna_DB_PEARクラスのコンストラクタ
Ethna_DB_ADOdb::__construct() : コンストラクタ

begin (line 89)

DBトランザクションを開始する

return: 0:正常終了 Ethna_Error:エラー
access: public

mixed begin ()

Redefined in descendants as:

Ethna_DB_PEAR::begin() : DBトランザクションを開始する
Ethna_DB_ADOdb::begin() : DBトランザクションを開始する

commit (line 109)

DBトランザクションを終了する

return: 0:正常終了 Ethna_Error:エラー
access: public

mixed commit ()

Redefined in descendants as:

Ethna_DB_PEAR::commit() : DBトランザクションを終了する
Ethna_DB_ADOdb::commit() : DBトランザクションを終了する

connect (line 60)

DBに接続する

return: 0:正常終了 Ethna_Error:エラー
access: public

mixed connect ()

Redefined in descendants as:

Ethna_DB_PEAR::connect() : DBに接続する
Ethna_DB_ADOdb::connect() : DBに接続する

disconnect (line 69)

DB接続を切断する

access: public

void disconnect ()

Redefined in descendants as:

Ethna_DB_PEAR::disconnect() : DB接続を切断する
Ethna_DB_ADOdb::disconnect() : DB接続を切断する

getDSN (line 132)

DSNを取得する

return: DSN
access: public

string getDSN ()

getMetaData (line 120)

テーブル定義情報を取得する

return: array: PEAR::DBに準じたメタデータ Ethna_Error::エラー
access: public

mixed getMetaData ()

Redefined in descendants as:

Ethna_DB_PEAR::getMetaData() : テーブル定義情報を取得する

isValid (line 79)

DB接続状態を返す

return: true:正常(接続済み) false:エラー/未接続
access: public

bool isValid ()

Redefined in descendants as:

Ethna_DB_PEAR::isValid() : DB接続状態を返す
Ethna_DB_ADOdb::isValid() : DB接続状態を返す

parseDSN (line 172)

Parse a data source name

Additional keys can be added by appending a URI query string to the end of the DSN.

The format of the supplied DSN is in its fullest form:

phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true

Most variations are allowed:

phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
phptype://username:password@hostspec/database_name
phptype://username:password@hostspec
phptype://username@hostspec
phptype://hostspec/database
phptype://hostspec
phptype(dbsyntax)
phptype

return: an associative array with the following keys:
- phptype: Database backend used in PHP (mysql, odbc etc.)
- dbsyntax: Database used with regards to SQL syntax etc.
- protocol: Communication protocol to use (tcp, unix etc.)
- hostspec: Host specification (hostname[:port])
- database: Database to use on the DBMS server
- username: User name for login
- password: Password for login
access: public

array parseDSN (string $dsn)

string $dsn: Data Source Name to be parsed

rollback (line 99)

DBトランザクションを中断する

return: 0:正常終了 Ethna_Error:エラー
access: public

mixed rollback ()

Redefined in descendants as:

Ethna_DB_PEAR::rollback() : DBトランザクションを中断する
Ethna_DB_ADOdb::rollback() : DBトランザクションを中断する