Home | Classes | Modules | Annotated | Hierarchy | Functions | Files

Creole.php

Go to the documentation of this file.

<?php
/*
 *  $Id: Creole.php,v 1.5 2004/03/20 04:16:49 hlellelid Exp $
 *
 * 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://creole.phpdb.org>.
 */

include_once 'creole/SQLException.php';
include_once 'creole/Connection.php';

// static:
// track errors is used by drivers to get better error messages
// make sure it's set.

@ini_set('track_errors', true);

class Creole {    

    const PERSISTENT = 1;
    
    const NO_ASSOC_LOWER = 16;            
    
    private static $driverMap = array(  'mysql' => 'creole.drivers.mysql.MySQLConnection',
                                        'pgsql' => 'creole.drivers.pgsql.PgSQLConnection',
                                        'sqlite' => 'creole.drivers.sqlite.SQLiteConnection',
                                        'oracle' => 'creole.drivers.oracle.OCI8Connection',
                                        'mssql' => 'creole.drivers.mssql.MSSQLConnection',
                                       );        
    
    public static function registerDriver($phptype, $dotpath)
    {
        self::$driverMap[$phptype] = $dotpath;
    }
    
    public static function deregisterDriver($phptype)
    {
        unset(self::$driverMap[$phptype]);
    }
    
    public static function getDriver($phptype)
    {
        if (isset(self::$driverMap[$phptype])) {
            return self::$driverMap[$phptype];
        } else {
            return null;
        }
    }
    
    public static function getConnection($dsn, $flags = 0)
    {
        if (is_array($dsn)) {
            $dsninfo = $dsn;
        } else {
            $dsninfo = self::parseDSN($dsn);
        }
        
        // support "catchall" drivers which will themselves handle the details of connecting
        // using the proper RDBMS driver.
        if (isset(self::$driverMap['*'])) {
            $type = '*';
        } else {
            $type = $dsninfo['phptype'];
            if (!isset(self::$driverMap[$type])) {
                throw new SQLException("No driver has been registered to handle connection type: $type");
            }
        }
        
        // may need to make this more complex if we add support
        // for 'dbsyntax'
        $clazz = self::import(self::$driverMap[$type]);                
        $obj = new $clazz();

        if (!($obj instanceof Connection)) {
            throw new SQLException("Class does not implement creole.Connection interface: $clazz");
        }
        
        try {
            $obj->connect($dsninfo, $flags);
        } catch(SQLException $sqle) {
            $sqle->setUserInfo($dsninfo);
            throw $sqle;        
        }
        
        return $obj;
    }

    public static function parseDSN($dsn)
    {
        if (is_array($dsn)) {
            return $dsn;
        }

        $parsed = array(
            'phptype'  => null,
            'username' => null,
            'password' => null,
            'protocol' => null,
            'hostspec' => null,
            'port'     => null,
            'socket'   => null,
            'database' => null
        );
        
        $info = parse_url($dsn);
        
        if (count($info) === 1) { // if there's only one element in result, then it must be the phptype
            $parsed['phptype'] = array_pop($info);
            return $parsed;
        }
        
        // some values can be copied directly
        $parsed['phptype'] = @$info['scheme'];
        $parsed['username'] = @$info['user'];
        $parsed['password'] = @$info['pass'];
        $parsed['port'] = @$info['port'];
        
        $host = @$info['host'];
        if (false !== ($pluspos = strpos($host, '+'))) {
            $parsed['protocol'] = substr($host,0,$pluspos);
            if ($parsed['protocol'] === 'unix') {
                $parsed['socket'] = substr($host,$pluspos+1);
            } else {
                $parsed['hostspec'] = substr($host,$pluspos+1);
            }
        } else {
            $parsed['hostspec'] = $host;
        }
        
        if (isset($info['path'])) {
            $parsed['database'] = substr($info['path'], 1); // remove first char, which is '/'
        }        
        
        if (isset($info['query'])) {
                $opts = explode('&', $info['query']);               
                foreach ($opts as $opt) {
                    list($key, $value) = explode('=', $opt);
                    if (!isset($parsed[$key])) { // don't allow params overwrite
                        $parsed[$key] = urldecode($value);
                    }
                }                
        }        

        return $parsed;
    }
    
    public static function import($class) {
        if (!class_exists($class)) {
            $path = strtr($class, '.', DIRECTORY_SEPARATOR) . '.php';
            $ret = include_once($path);
            if ($ret === false) {
                throw new SQLException("Unable to load driver class: " . $class);
            }
            // get just classname ('path.to.ClassName' -> 'ClassName')
            $pos = strrpos($class, '.');
            if ($pos !== false) {
                $class = substr($class, $pos + 1);
            }
            if (!class_exists($class)) {
                throw new SQLException("Unable to find loaded class: $class (Hint: make sure classname matches filename)");
            }
        }
        return $class;
    }
    
}

---

This file is part of the Creole[php5] library.