Xnyo - Sources for file plugins/class/interfaces.php in version 4.0 Beta 1

Sources for file plugins/class/interfaces.php in version 4.0 Beta 1

Click on a comment to hide it. Click here to show all comments.


/**
 * Project:     Xnyo 4: Bubbles
 * File:        plugins/class/interfaces.php
 *
 * Version:     4.0-dev
 * SVN Id:      $Id: interfaces.php 5 2007-05-18 03:49:07Z bok $
 * SVN URL:     $HeadURL:
http://svn.syd.wholesalebroadband.com.au/xnyo/trunk/plugins/class/interfaces.php $
 * Authors:     Robert Amos <bok[at]odynia.org>
 *
 * Copyright (c) 2001-2007 Robert Amos <bok[at]odynia.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
**/

/**
 * This file contains all the interfaces used in Xnyo. This should show exactly what
 * you need to implement in order to build replacement objects for anything in Xnyo.
**/
define('XNYO_INTERFACES_LOADED', true);

/**
 * Auth Plugins
**/
interface XnyoAuthPlugin
{
    public function login ($username, $password, $domain);
}

/**
 * Cache Plugins
**/
interface XnyoCachePlugin
{
}

/**
 * Class Plugins
**/
interface XnyoClassPlugin
{
}

/**
 * Database Plugins
**/
interface XnyoDatabasePlugin
{
    public function __construct ($db_info, PDO $pdo);
    public function getColumns($table);
    public function translateColType ($type);
    public function beginTransaction ();
    public function commit ();
    public function errorCode ();
    public function errorInfo();
    public function exec ($sql);
    public function getAttribute ($attr);
    public function getAvailableDrivers ();
    public function lastInsertId ($table);
    public function prepare ($sql);                        // optional: $opt=null
    public function query ($sql);
    public function quote ($sql);                         // optional: $p=null
    public function rollBack ();
    public function setAttribute ($attr, $value);
    public function bindColumn ($column, $param);        // optional: $type=null
    public function bindParam ($param, $var);            // optional: $type=null, $length=null, $opt=null
    public function bindValue ($param, $value);            // optional:  $type=null
    public function closeCursor ();
    public function columnCount ();
    public function errorCodeStatement();
    public function errorInfoStatement ();
    public function execute ();                            // optional: $input=null
    public function fetch ();                            // optional: $style=null, $ori=null, $offset=null
    public function fetchAll ();                        // optional: $style=null, $index=null
    public function fetchColumn ();                        // optional: $col=null
    public function fetchObject ();                        // optional: $class=null, $const_args=null
    public function getAttributeStatement ($attr);
    public function getColumnMeta ();                    // optional: $col=null
    public function nextRowset ();
    public function rowCount ();
    public function setAttributeStatement ($attr, $value);
    public function setFetchMode ();
}

/**
 * Database Connection Plugin
**/
interface XnyoDatabaseConnect
{
    public function __construct($table_info);
    public function connect();
}

/**
 * Database Spec Plugin
**/
interface XnyoDbSpecPlugin
{
    
}

/**
 * Error Plugins
**/
interface XnyoErrorPlugin
{
    public function raise ($exception);
    public function get ();
}

/**
 * Logout Handler
**/
interface XnyoLogoutInterface
{
    
}