\CodeLapse\DatabaseConnection

データベースコネクション抽象化クラス

Summary

Methods

Properties

Constants

connect()
__construct()
getRawConnection()
errorMessage()
errorCode()
useDB()
setCharset()
query()
startTransaction()
commit()
rollback()
inTransaction()
lastInsertId()
quote()
quoteIdentifier()

No public properties found

TYPE_PDO
TYPE_MYSQL

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

abstract

File: Database/Connection.php
Package: \CodeLapse\Database
Class hierarchy: \CodeLapse\Database\Connection

Constants

TYPE_PDO

TYPE_PDO

TYPE_MYSQL

TYPE_MYSQL

Methods

connect()

connect(string $host, string $user, string|null $password, integer|null $driver)

コネクションを生成します。

適切なドライバを自動で選択し、そのドライバのインスタンスを返します。

Parameters

string	$host	ホスト名
string	$user	ユーザー名
string\|null	$password	(optional) パスワード
integer\|null	$driver	(optional) ドライバの種類。 `指定することで利用するドライバを選択できます。`

Throws

\CodeLapse\Database\DB_Exception: データベースへの接続に失敗した時にスローされます。

__construct()

__construct(string $host, string $user, string|null $password)

データベースコネクションを生成します。

Parameters

string	$host	ホスト名
string	$user	ユーザー名
string\|null	$password	(optional) パスワード

getRawConnection()

getRawConnection() : resource|\CodeLapse\Database\PDO

オブジェクトが内包している、コネクションオブジェクトを取得します。

返り値の型はドライバにより変わるため、一定ではありません。

Returns

resource|\CodeLapse\Database\PDO

errorMessage()

errorMessage() : string

直近に実行したクエリのエラーメッセージを取得します。

エラーが発生していない時は空文字を返します。

Returns

string

errorCode()

errorCode() : integer

直近に実行したクエリで発生したエラーのコードを取得します。

エラーが発生しなかった場合は、0を返します。

Returns

integer

useDB()

useDB( $dbname) : boolean

使用するデータベースを指定します。

Parameters

$dbname

Returns

boolean

setCharset()

setCharset(string $charset) : boolean

コネクションで使用する文字コードを設定します。

Parameters

string

$charset

文字コード

Returns

boolean

query()

query(string $sql, array|null $params) : \CodeLapse\Database\DB_Resultset|boolean

クエリーを実行します。

Parameters

string	$sql	クエリ。"?"、":name"を埋め込み、パラメータを後から指定することが可能です。
array\|null	$params	クエリに埋め込むパラメータ

Returns

\CodeLapse\Database\DB_Resultset|boolean

startTransaction()

startTransaction() : boolean

トランザクションを開始します。

Returns

boolean

commit()

commit() : boolean

トランザクションを終了し、実行結果をコミットします。

Returns

boolean

rollback()

rollback() : boolean

トランザクションを中止し、トランザクション中に行った処理をすべて無効化します。

トランザクション中でない時、DB_Exceptionをスローします。

Throws

\CodeLapse\Database\DB_Exception

Returns

boolean

inTransaction()

inTransaction() : boolean

コネクションがトランザクション中か調べます。

Returns

boolean

lastInsertId()

lastInsertId(string $name)

最後に挿入された行のID、もしくはシーケンス値を返します。

Parameters

string

$name

(optional) シーケンスオブジェクト名

quote()

quote(string $string) : string

入力文字列内のシングルクオートをエスケープし、前後に引用符をつけた文字列を返します。

Parameters

string

$string

文字列

Returns

string —

SQLの値として適切な形式に整形された文字列

quoteIdentifier()

quoteIdentifier(string $string) : string

入力文字列のバッククオートをエスケープし、バッククオートで囲ったをつけた文字列を返します。

Parameters

string

$string

文字列

Returns

string —

SQLの値として適切な形式に整形された文字列