Source for file Ethna_DB.php

Documentation is available at Ethna_DB.php

  1. <?php
  2. // vim: foldmethod=marker
  3. /**
  4.  *  Ethna_DB.php
  5.  *
  6.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  7.  *  @license    http://www.opensource.org/licenses/bsd-license.php The BSD License
  8.  *  @package    Ethna
  9.  *  @version    $Id$
  10.  */
  11.  
  12. // {{{ Ethna_DB
  13. /**
  14.  *  Ethna用DB抽象クラス
  15.  *
  16.  *  EthnaのフレームワークでDBオブジェクトを扱うための抽象クラス
  17.  *  (のつもり...あぁすばらしきPHP 4)
  18.  *
  19.  *  @author     Masaki Fujimoto <fujimoto@php.net>
  20.  *  @access     public
  21.  *  @package    Ethna
  22.  */
  23. class Ethna_DB
  24. {
  25.     /**#@+
  26.      *  @access private
  27.      */
  28.  
  29.     /** @var    object  DB              DBオブジェクト */
  30.     var $db;
  31.  
  32.     /** @var    array   トランザクション管理スタック */
  33.     var $transaction = array();
  34.  
  35.     /**#@-*/
  36.  
  37.  
  38.     /**
  39.      *  Ethna_DBクラスのコンストラクタ
  40.      *
  41.      *  @access public
  42.      *  @param  object  Ethna_Controller    &$controller    コントローラオブジェクト
  43.      *  @param  string  $dsn                                DSN
  44.      *  @param  bool    $persistent                         持続接続設定
  45.      */
  46.     function Ethna_DB(&$controller, $dsn, $persistent)
  47.     {
  48.         $this->dsn = $dsn;
  49.         $this->persistent = $persistent;
  50.     }
  51.  
  52.     /**
  53.      *  DBに接続する
  54.      *
  55.      *  @access public
  56.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  57.      */
  58.     function connect()
  59.     {
  60.     }
  61.  
  62.     /**
  63.      *  DB接続を切断する
  64.      *
  65.      *  @access public
  66.      */
  67.     function disconnect()
  68.     {
  69.     }
  70.  
  71.     /**
  72.      *  DB接続状態を返す
  73.      *
  74.      *  @access public
  75.      *  @return bool    true:正常(接続済み) false:エラー/未接続
  76.      */
  77.     function isValid()
  78.     {
  79.     }
  80.  
  81.     /**
  82.      *  DBトランザクションを開始する
  83.      *
  84.      *  @access public
  85.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  86.      */
  87.     function begin()
  88.     {
  89.     }
  90.  
  91.     /**
  92.      *  DBトランザクションを中断する
  93.      *
  94.      *  @access public
  95.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  96.      */
  97.     function rollback()
  98.     {
  99.     }
  100.  
  101.     /**
  102.      *  DBトランザクションを終了する
  103.      *
  104.      *  @access public
  105.      *  @return mixed   0:正常終了 Ethna_Error:エラー
  106.      */
  107.     function commit()
  108.     {
  109.     }
  110.  
  111.     /**
  112.      *  テーブル定義情報を取得する
  113.      *
  114.      *  @access public
  115.      *  @return mixed   array: PEAR::DBに準じたメタデータ
  116.      *                   Ethna_Error::エラー
  117.      */
  118.     function getMetaData()
  119.     {
  120.         //   このメソッドはAppObject
  121.         //   との連携に必要。
  122.     }
  123.  
  124.     /**
  125.      *  DSNを取得する
  126.      *
  127.      *  @access public
  128.      *  @return string  DSN
  129.      */
  130.     function getDSN()
  131.     {
  132.         return $this->dsn;
  133.     }
  134. }
  135. // }}}
  136. ?>

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