File Source for DB.php

<?php
// vim: foldmethod=marker
/**
* DB.php
*
* @author Masaki Fujimoto <fujimoto@php.net>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @package Ethna
* @version $Id: bc26055c2e52c8ef683e4a50b33b3fa9dd41a345 $
*/
/**
* Ethna用DB抽象クラス
*
* EthnaのフレームワークでDBオブジェクトを扱うための抽象クラス
* (のつもり...あぁすばらしきPHP 4)
*
* @author Masaki Fujimoto <fujimoto@php.net>
* @access public
* @package Ethna
*/
class Ethna_DB
{
/**#@+
* @access private
*/
/**
* @XXX stay public because of B.C.
* @protected object DB DBオブジェクト
*/
public $db;
/** @protected array トランザクション管理スタック */
protected $transaction = array();
/**#@-*/
/**
* Ethna_DBクラスのコンストラクタ
*
* @access public
* @param object Ethna_Controller $controller コントローラオブジェクト
* @param string $dsn DSN
* @param bool $persistent 持続接続設定
*/
public function __construct($controller, $dsn, $persistent)
{
$this->dsn = $dsn;
$this->persistent = $persistent;
}
/**
* DBに接続する
*
* @access public
* @return mixed 0:正常終了 Ethna_Error:エラー
*/
public function connect()
{
}
/**
* DB接続を切断する
*
* @access public
*/
public function disconnect()
{
}
/**
* DB接続状態を返す
*
* @access public
* @return bool true:正常(接続済み) false:エラー/未接続
*/
public function isValid()
{
}
/**
* DBトランザクションを開始する
*
* @access public
* @return mixed 0:正常終了 Ethna_Error:エラー
*/
public function begin()
{
}
/**
* DBトランザクションを中断する
*
* @access public
* @return mixed 0:正常終了 Ethna_Error:エラー
*/
public function rollback()
{
}
/**
* DBトランザクションを終了する
*
* @access public
* @return mixed 0:正常終了 Ethna_Error:エラー
*/
public function commit()
{
}
/**
* テーブル定義情報を取得する
*
* @access public
* @return mixed array: PEAR::DBに準じたメタデータ
* Ethna_Error::エラー
*/
public function getMetaData()
{
// このメソッドはAppObject
// との連携に必要。
}
/**
* DSNを取得する
*
* @access public
* @return string DSN
*/
public function getDSN()
{
return $this->dsn;
}
// {{{ parseDSN()
/**
* 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:
* <code>
* phptype(dbsyntax)://username:password@protocol+hostspec/database?option=8&another=true
* </code>
*
* Most variations are allowed:
* <code>
* 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
* </code>
*
* @param string $dsn Data Source Name to be parsed
*
* @return array 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
*/
public function parseDSN($dsn)
{
$parsed = array(
'phptype' => false,
'dbsyntax' => false,
'username' => false,
'password' => false,
'protocol' => false,
'hostspec' => false,
'port' => false,
'socket' => false,
'database' => false,
);
if (is_array($dsn)) {
$dsn = array_merge($parsed, $dsn);
if (!$dsn['dbsyntax']) {
$dsn['dbsyntax'] = $dsn['phptype'];
}
return $dsn;
}
// Find phptype and dbsyntax
if (($pos = strpos($dsn, '://')) !== false) {
$str = substr($dsn, 0, $pos);
$dsn = substr($dsn, $pos + 3);
} else {
$str = $dsn;
$dsn = null;
}
// Get phptype and dbsyntax
// $str => phptype(dbsyntax)
if (preg_match('|^(.+?)$(.*?)$$|', $str, $arr)) {
$parsed['phptype'] = $arr[1];
$parsed['dbsyntax'] = !$arr[2] ? $arr[1] : $arr[2];
} else {
$parsed['phptype'] = $str;
$parsed['dbsyntax'] = $str;
}
if (!count($dsn)) {
return $parsed;
}
// Get (if found): username and password
// $dsn => username:password@protocol+hostspec/database
if (($at = strrpos($dsn, '@')) !== false) {
$str = substr($dsn, 0, $at);
$dsn = substr($dsn, $at + 1);
if (($pos = strpos($str, ':')) !== false) {
$parsed['username'] = rawurldecode(substr($str, 0, $pos));
$parsed['password'] = rawurldecode(substr($str, $pos + 1));
} else {
$parsed['username'] = rawurldecode($str);
}
}
// Find protocol and hostspec
if (preg_match('|^([^(]+)$(.*?)$/?(.*?)$|', $dsn, $match)) {
// $dsn => proto(proto_opts)/database
$proto = $match[1];
$proto_opts = $match[2] ? $match[2] : false;
$dsn = $match[3];
} else {
// $dsn => protocol+hostspec/database (old format)
if (strpos($dsn, '+') !== false) {
list($proto, $dsn) = explode('+', $dsn, 2);
}
if (strpos($dsn, '/') !== false) {
list($proto_opts, $dsn) = explode('/', $dsn, 2);
} else {
$proto_opts = $dsn;
$dsn = null;
}
}
// process the different protocol options
$parsed['protocol'] = (!empty($proto)) ? $proto : 'tcp';
$proto_opts = rawurldecode($proto_opts);
if ($parsed['protocol'] == 'tcp') {
if (strpos($proto_opts, ':') !== false) {
list($parsed['hostspec'], $parsed['port']) = explode(':', $proto_opts);
} else {
$parsed['hostspec'] = $proto_opts;
}
} elseif ($parsed['protocol'] == 'unix') {
$parsed['socket'] = $proto_opts;
}
// Get dabase if any
// $dsn => database
if ($dsn) {
if (($pos = strpos($dsn, '?')) === false) {
// /database
$parsed['database'] = rawurldecode($dsn);
} else {
// /database?param1=value1&param2=value2
$parsed['database'] = rawurldecode(substr($dsn, 0, $pos));
$dsn = substr($dsn, $pos + 1);
if (strpos($dsn, '&') !== false) {
$opts = explode('&', $dsn);
} else { // database?param1=value1
$opts = array($dsn);
}
foreach ($opts as $opt) {
list($key, $value) = explode('=', $opt);
if (!isset($parsed[$key])) {
// don't allow params overwrite
$parsed[$key] = rawurldecode($value);
}
}
}
}
return $parsed;
}
// }}}
}

Documentation generated on Fri, 11 Nov 2011 03:57:57 +0900 by phpDocumentor 1.4.3

Source for file DB.php