File Source for ABSTDatabaseTable.class.php

<?php
/**
* @package databases
*/
/**
* Loading the supirior class on which this class depends.
*/
require_once( CLASSPATH."databases/Database.class.php" );
/**
* @abstract
*
* @package databases
* @version 0.1.85
*
* @author Daniel PlÃ¼cken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2004 Daniel PlÃ¼cken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class ABSTDatabaseTable
{
/**
* The name of the databasetable.
*
* @var string $name
* @access public
*/
var $name;
/*
* Carries the field's objects of this databasetable.
*
* @var array $field
* @access private
*/
// var $field;
/*
* Will be set to true if the fields's information become stored.
*
* @var boolean $field_info_stored
* @access private
*/
// var $field_info_stored = false;
/**
* Carries the fieldnames of this databasetable.
*
* @access public
* @var array $fieldname
*/
var $fieldname = array();
/**
* Will be set to true if the fieldnames become stored.
*
* @access private
* @var boolean $field_names_stored
*/
var $field_names_stored = false;
/**
* Carries the field properties whether they can be NULL.
*
* @access public
* @var array $field_can_be_null
*/
var $field_can_be_null = array();
/**
* Carries the field properties whether they are a member of a primary key.
*
* @access public
* @var array $field_is_primary_member
*/
var $field_is_primary_member = array();
/**
* Carries the field properties whether they have auto increment.
*
* @access public
* @var array $field_has_auto_increment
*/
var $field_has_auto_increment = array();
/**
* Will be set to true if the field flags become stored.
*
* @access private
* @var boolean $field_flags_stored
*/
var $field_flags_stored = false;
/**
* Refers to the database in which this relation lies.
*
* @access private
* @var Database $parent
*/
var $parent;
/**
* Stores the last query made to the underlying database table.
*
* @access public
* @var string $last_query
*/
var $last_query;
/**
* Stores the last insert id of the underlying database table.
*
* @access public
* @var integer $insert_id
*/
var $insert_id = null;
/**
* Holds the field members of the primary key of this table object.
*
* @access private
* @var array $primary_key
*/
var $primary_key = null;
/**
* Holds the fieldname of the auto increment Column.
*
* @access private
* @var string $auto_increment_field
*/
var $auto_increment_field = null;
/**
* Shows whether the fieldnames are overruled.
*
* @access private
* @var boolean $overruled_fieldnames
*/
var $overruled_fieldnames = false;
/**
* Fake-Constructor
*
* @access public
* @version 1.0
* @since 0.1.3
*
* @return void
*/
function ABSTDatabaseTable()
{
echo "<h3>This is an abstract class. "
."You cannot get an instance of it!</h3>";
exit();
}
/**
* Constructor
*
* @access public
* @version 1.2
* @since 0.1.3
*
* @param string $name
* @param string $kind
* @param Database $parent
*
* @return ABSTDatabaseTable
*/
function __contructor( $name = "", $kind, $parent = "" )
{
if ( !empty( $name ) )
{
$this->name = $name;
if (
!function_exists( "is_a" )
&& (
get_class( $parent ) == "database"
|| get_parent_class( $parent ) == "database"
)
)
{ $this->parent =& $parent; }
else
if (
function_exists( "is_a" )
&& (
is_a( $parent, "Database" )
|| @is_subclass_of( $parent, "Database" )
)
)
{ $this->parent =& $parent; }
else
if ( $parent !== "" )
{
echo "<h3>The third parameter is not a reference to an object "
."of a database!</h3>";
if ( function_exists( "debug_backtrace" ) )
{
$debugArr = debug_backtrace();
echo "<b>BACKTRACE DEBUG</b><br />\r\n";
echo "<pre>\r\n";
print_r( $debugArr );
echo "</pre>\r\n";
}
exit();
}
}
else
{
die(
"<h3>You have to give a name to this database table!</h3>"
."<b>Use following Syntax:<b><br><br>\r\n"
."<pre>\r\n"
." \x24dbt = new {$kind}DatabaseTable"
."( \x24name, \x24parent );\r\n"
."</pre>\r\n"
);
}
}
/**
* Sets the name of the databasetable.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $string The name the database table should get.
*
* @return void
*/
function setName( $string )
{ $this->name = $string; }
/**
* Sets the parent of this object.
*
* @access public
* @version 1.1
* @since 0.1.2
*
* @param string $obj_ref Should be a reference of a database object.
*
* @return void
*/
function setParent( &$obj_ref )
{
if (
!function_exists( "is_a" )
&& (
get_class( $obj_ref ) == "database"
|| get_parent_class( $obj_ref ) == "database"
)
)
{ $this->parent = &$obj_ref; }
else
if (
function_exists( "is_a" )
&& (
is_a( $obj_ref, "Database" )
|| @is_subclass_of( $obj_ref, "Database" )
)
)
{ $this->parent = &$obj_ref; }
else
{
die(
"<h3>The given parameter is not a reference "
."of an object of a database!</h3>"
);
}
}
/**
* Adds a join's reference to this object of a database table.
*
* @access public
* @version 1.0
* @since 0.1.4
*
* @param object $obj_ref Should be a reference of a join object.
*
* @return void
*/
function addJoin( &$obj_ref )
{
if (
!function_exists( "is_a" )
&& (
get_class( $obj_ref ) == "join"
|| get_parent_class( $obj_ref ) == "join"
)
)
{ $this->join[] =& $obj_ref; }
else
if (
function_exists( "is_a" )
&& (
is_a( $obj_ref, "Join" )
|| @is_subclass_of( $obj_ref, "Join" )
)
)
{ $this->join[] =& $obj_ref; }
else
{
die(
"<h3>The given parameter is not a reference "
."of an object of a join!</h3>"
);
}
}
/**
* Adds a field's reference to this object of a database table.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @param object $obj_ref
*
* @return void
*/
function addField( &$obj_ref )
{ $this->field[] =& $obj_ref; }
/**
* Adds a field's reference to this object of a database table.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @param string $string
*
* @return void
*/
function addFieldname( $string )
{ $this->fieldname[] = $string; }
/**
* Returns the name of the database table.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @return string
*/
function getName()
{ return $this->name; }
/**
* Returns the table's fieldnames.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @return array
*/
function getFieldnames()
{ return $this->fieldname; }
/**
* Returns the last stored database query.
*
* @access public
* @version 1.0
* @since 0.1.1
*
* @return array
*/
function getLastQuery()
{ return $this->parent->last_query; }
/**
* Returns the parent object of this object.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @return Database
*/
function &getParent ()
{ return $this->parent; }
/**
* Returns the id of the connection resource to the database host.
*
* @access public
* @version 1.0
* @since 0.1.81
*
* @return object
*/
function &getResourceID()
{ return $this->parent->getResourceID(); }
/**
* Returns the last insert id that was made to the underlying database
* table.
*
* @access public
* @version 1.0
* @since 0.1.82
*
* @return integer
*/
function &getInsertID()
{ return $this->insert_id; }
/**
* This method has to be implement in a subclass!
*
* @abstract
*
* @access public
* @version 1.0
* @since 0.1.85
*
* @return void
*/
function getPrimaryKey()
{
die(
"Please implement in subclass - this is an abstract method in "
."ABSTDatabaseTable!"
);
}
} // End of class ABSTDatabaseTable
?>

Source for file ABSTDatabaseTable.class.php