Ticket #1597: BaseDAO.php

<?php
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
// | Copyright (c) 2008, Demian Turner                                      |
// | All rights reserved.                                                      |
// |                                                                           |
// | Redistribution and use in source and binary forms, with or without        |
// | modification, are permitted provided that the following conditions        |
// | are met:                                                                  |
// |                                                                           |
// | o Redistributions of source code must retain the above copyright          |
// |   notice, this list of conditions and the following disclaimer.           |
// | o Redistributions in binary form must reproduce the above copyright       |
// |   notice, this list of conditions and the following disclaimer in the     |
// |   documentation and/or other materials provided with the distribution.    |
// | o The names of the authors may not be used to endorse or promote          |
// |   products derived from this software without specific prior written      |
// |   permission.                                                             |
// |                                                                           |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT         |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR     |
// | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT      |
// | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,     |
// | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT          |
// | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     |
// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     |
// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       |
// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE     |
// | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.      |
// |                                                                           |
// +---------------------------------------------------------------------------+
// | Seagull 0.6                                                               |
// +---------------------------------------------------------------------------+
// | BaseDAO.php                                                               |
// +---------------------------------------------------------------------------+
// | Author:   Michael K. Alber <malber@interactdigitalmedia.com>              |
// +---------------------------------------------------------------------------+
// $Id: $

/**
 * based on http://article.gmane.org/gmane.comp.php.seagull.general/8035/match=base+dao
 * by Dmitri Lakachauskis <lakiboy83@gmail.com>
 * @category   Library
 * @package    SGL
 * @author     Michael K. Alber <malber@interactdigitalmedia.com>
 * @copyright  Copyright (c) 2008, Demian Turner
 * @version    SVN: $Id: $
 * @since      Wed Mar 19 22:16:18 PDT 2008 22:16:18
 */
/* Reminder: always indent with 4 spaces (no tabs). */

class SGL_BaseDAO
{
    public $conf = array();
    public $dbh = null;

    /**
     * Constructor.
     *
     * @access  public
     * @return  void
     */

    function SGL_BaseDAO()
    {
        $moduleName = str_replace('dao', '', strtolower(get_class($this)));
        $c = &SGL_Config::singleton();
        $this->conf = $c->ensureModuleConfigLoaded($moduleName);
        $this->dbh = &$this->_getDb();
    }

    /**
     * @access  public
     * @static
     * @return  DAO class reference to DAO object
     */
    function &singleton()
    {
        static $instance;

        // If the instance is not there, create one
        if (!isset($instance)) {
            $class = __CLASS__;
            $instance = new $class();
        }
        return $instance;
    }

    /**
     * Enter description here...
     *
     * @return unknown
     */
    function &_getDb()
    {
        $locator = &SGL_ServiceLocator::singleton();
        $dbh = $locator->get('DB');
        if (!$dbh) {
            $dbh = &SGL_DB::singleton();
            $locator->register('DB', $dbh);
        }
        return $dbh;
    }

    function getConfig()
    {
        $c = &SGL_Config::singleton();
        return $c;
    }
}
?>