File Source for DatabaseEntity.class.php

<?php
/**
* @package data_structures
*/
/**
*
*/
require_once CLASSPATH."data_structures/ABSTObject.class.php";
/**
* Class to generate objects from database tables. It makes most sense to use
* this class as an abstract type.
* For example:
*
* <code>
* class Article extends DatabaseEntity
* {
* function Article( $int_id = null )
* {
* parent::DatabaseEntity( $GLOBALS["dbt_article"] );
*
* if ( $int_id != null && is_numeric( $int_id ) )
* { parent::initiateObjectFromTuple("id_article = '{$int_id}'"); }
* }
* } // end of class Article
* </code>
*
* @package data_structures
* @version 0.1.42
* @since 0.9.1.5
*
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (C) 2006 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 DatabaseEntity extends ABSTObject
{
/**
* Stores the reference to an object of a database entity.
*
* @access public
* @var DatabaseEntity $____parent_obj
*/
var $____parent_obj = null;
/**
* Stores the reference to an object of a database table.
*
* @access public
* @var ABSTDatabaseTable $____dbt
*/
var $____dbt = null;
/**
* Stores the where-clause to generate the data of this entity.
*
* @access public
* @var array $____str_where
*/
var $____str_where = "";
/**
* Stores the key fieldnames.
*
* @access public
* @var array $____key_arr
*/
var $____key_arr = array();
/**
* Stores the references to the objects of the key database tables.
*
* @access public
* @var array $____key_table_arr
*/
var $____key_table_arr = array();
/**
* Stores the references to the objects of the key entities.
*
* @access public
* @var array $____key_object_arr
*/
var $____key_object_arr = array();
/**
* Stores the references to other entities.
*
* @access public
* @var array $____entity_arr
*/
var $____entity_arr = array();
/**
* Stores the references to other entities. But with a relation name as key
* in the first array dimension.
*
* @access public
* @var array $____relation_arr
*/
var $____relation_arr = array();
/**
* Constructor
* Put in a reference to an object which is a subtype of the type
* ABSTDatabaseTable or a reference to an object which is a subtype of the
* type ABSTView.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param ABSTDatabaseTable $dbt_obj
*
* @return DatabaseEntity
*/
function DatabaseEntity( &$dbt_obj )
{ $this->____dbt =& $dbt_obj; }
/**
* Initiates this object by using the data of a tuple from a database result.
* The database table is managed by an object of the GilliGan-Framework. See
* in package databases for further information. The database tables object
* will be stored in the Field $____dbt of this object. The original
* fieldnames from the database table will be used for the fieldnames of this
* entity object.
* Beware, only the first found tuple will used for the initiation,
* therefore you better should use the primary key to grab the data from
* the underlying database table.
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $str_where
*
* @return void
*/
function initiateObjectFromTuple( $str_where )
{
$res_arr = $this->____dbt->getSingleDataset( $str_where );
if ( is_array( $res_arr ) )
foreach ( $res_arr as $fieldname => $value )
if ( !is_int( $fieldname ) && !empty( $fieldname ) )
{ $this->$fieldname = $value; }
}
/**
* Adds a keytable to this object.
*
* @version 1.1
* @since 0.1.1
* @author Daniel Plücken <daniel@debakel.net>
* @access public
* @param string $key Fieldname that refers to the key table.
* @param ABSTDatabaseTable $dbt_obj Reference to the key table.
* @return void
*/
function addKeyTable( $key, &$dbt_obj )
{
$pkey_arr = $dbt_obj->getPrimaryKey();
$this->____key_table_arr[$key] =& $dbt_obj;
$tmp_obj =& new DatabaseEntity( $dbt_obj );
$tmp_obj->initiateObjectFromTuple( $pkey_arr[0]." = '".$this->$key."'" );
$this->____key_object_arr[$key] = $tmp_obj;
$this->____key_arr[] = $key;
}
/**
* Adds a weak entity.
*
* @access public
* @version 1.1
* @since 0.1.1
*
* @param DatabaseEntity $dbe
* @param string $named_relation For example is_in_category ...
*
* @return void
*/
function addEntity( &$dbe, $named_relation = "" )
{
$dbe->____parent_obj =& $this;
if ( empty( $named_relation ) )
{ $this->____entity_arr[] =& $dbe;}
else
{ $this->____relation_arr[$named_relation][] =& $dbe; }
}
/**
* Describes an "n to m"-Relation to this object.
*
* @access public
* @version 1.14
* @since 0.1.1
*
* @param ABSTDatabaseTable $dbt Reference to the key table.
* @param string $str_key Fieldname that refers to the key
* table.
* @param string $str_additional_where
* @param string $named_relation For example is_in_category ...
*
* @return void
*/
function addMultipleEntities(
&$dbt, $str_key, $str_additional_where = "",
$named_relation = ""
)
{
$pkey_arr = $this->____dbt->getPrimaryKey();
$str_where_entity = $str_key." = '".$this->$pkey_arr[0]."'";
if ( !empty( $str_additional_where ) )
{ $str_where_entity .= " AND ".$str_additional_where; }
$res_arr = $dbt->getDatasets(
$str_where_entity, "",
MYSQL_OUTPUT_ASSOC
);
if ( is_array( $res_arr ) )
for ( $i = 0; $i < count( $res_arr ); $i++ )
{
$tmp_obj =& new DatabaseEntity( $dbt );
foreach ( $res_arr[$i] as $fieldname => $value )
{ $tmp_obj->$fieldname = $value; }
$this->addEntity( $tmp_obj, $named_relation );
}
}
/**
* Returns an array of this object. The objects are generated from a hurd of
* tuples collected from a result of a database query.
*
* @static
*
* @access public
* @version 1.22
* @since 0.1.1
*
* @author Daniel Plücken <daniel@debakel.net>
* @author Daniel Dornhardt <daniel@dornhardt.com>
*
* @param ABSTDatabaseTable $dbt_obj Reference to the table from which
* the Tuple should read.
* @param string $str_where Where-clause to fetch the tuple.
* @param string $classname if used for subclasses of
* DatabaseEntity, class $classname is
* used for the construction objects so
* members / methods of subclass can be
* used
* @param boolean $primary_key_as_array_keys If this is set to true, the
* keys of the output array will
* be the same like the primary
* key value for the matching
* tuple. THIS DOESN'T MAKE SENSE
* FOR ABSTView-OBJECTS!
* @return array
*/
function createEntitiesFromMultiTuple(
&$dbt_obj,
$str_where,
$classname = __CLASS__,
$primary_key_as_array_keys = false
)
{
$res_arr = $dbt_obj->getDatasets( $str_where, "", MYSQL_OUTPUT_ASSOC );
if (
is_a( $dbt_obj, "ABSTView" )
|| is_subclass_of( $dbt_obj, "ABSTView" )
)
{
$tmp_arr = array();
if ( is_array( $res_arr ) )
for ( $i = 0; $i < count( $res_arr ); $i++ )
{
$tmp_arr[] =& new $classname( $dbt_obj );
foreach ( $res_arr[$i] as $fieldname => $value )
{
$fieldname = substr( strstr( $fieldname, "_" ), 1 );
if ( empty( $tmp_arr[count($tmp_arr)-1]->$fieldname ) )
{ $tmp_arr[count($tmp_arr)-1]->$fieldname = $value; }
}
}
}
else
{
$tmp_arr = array();
if ( is_array( $res_arr ) )
{
if (
!$primary_key_as_array_keys
|| !($pk_arr = $dbt_obj->getPrimaryKey())
)
{
for ( $i = 0; $i < count( $res_arr ); $i++ )
{
$tmp_arr[] =& new $classname( $dbt_obj );
foreach ( $res_arr[$i] as $fieldname => $value )
{ $tmp_arr[count($tmp_arr)-1]->$fieldname = $value; }
}
}
else
{
for ( $i = 0; $i < count( $res_arr ); $i++ )
{
$str_pk_impl = "";
foreach ( $pk_arr as $key_name )
{ $str_pk_impl .= $res_arr[$i][$key_name]; }
$tmp_arr[$str_pk_impl] =& new $classname( $dbt_obj );
foreach ( $res_arr[$i] as $fieldname => $value )
{ $tmp_arr[$str_pk_impl]->$fieldname = $value; }
}
}
}
}
return $tmp_arr;
}
/**
* Trys to delete a dataset in the database table with values from the
* primary key.
*
* @access public
* @version 1.0
* @since 0.1.42
*
* @return boolean
*/
function delete()
{
$p_arr = $this->____dbt->getPrimaryKey();
$str_where = "";
if ( !$p_arr )
{ return false; }
else
{
$str_name = array_pop( $p_arr );
$str_where = $str_name." = '{$this->$str_name}'";
foreach ( $p_arr as $str_name )
{ $str_where .= " AND {$str_name} = '{$this->$str_name}'"; }
return $this->____dbt->delete( $str_where );
}
}
/**
* Replaces this object in the database table.
*
* @access public
* @version 0.12
* @since 0.1.21
*
* @author Daniel Dornhardt <daniel@dornhardt.com>
* @author Daniel Plücken <daniel@debakel.net> (auto_increment-handle)
*
* @return boolean
*/
function replace()
{
$keys = $this->____dbt->getFieldnames();
$values = array();
foreach ( $keys as $fieldname )
{ $values[] = $this->$fieldname; }
$auto_increment_field = $this->____dbt->getAutoIncrementField();
// It is an update or there is no auto increment field!
if (
empty( $auto_increment_field )
|| !empty( $this->$auto_increment_field )
)
{ return $this->____dbt->replace( $keys, $values ); }
// It is an insert and an auto increment field exists!
else
{
$bool_ret = $this->____dbt->replace( $keys, $values );
if ( $bool_ret )
{ $this->$auto_increment_field = $GLOBALS["insert_id"]; }
}
return $bool_ret;
}
/**
* Puts the values of the passed kind of request variables into the fields
* of this object. This is useful to update a dataset with entered form data
* before writing it back to the database table were it come from. Use the
* method "replace" to to so.
*
* @access public
* @version 1.0
* @since 0.1.4
*
* @param array $request_type_arr
*
* @return boolean
*/
function putRequestValuesIntoObjectFields(
$request_type_arr = array( "GET", "POST", "REQUEST" )
)
{
if ( is_string( $request_type_arr ) )
{ $request_type_arr = array( $request_type_arr ); }
$field_arr = $this->____dbt->getRealFieldnames();
if ( !is_array( $field_arr ) )
{ return false; }
if ( get_magic_quotes_gpc() )
{
if ( in_array( "GET", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_GET[ $field_name ] ) )
{ $this->$field_name = stripslashes( $_GET[ $field_name ] ); }
if ( in_array( "POST", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_POST[ $field_name ] ) )
{ $this->$field_name = stripslashes( $_POST[ $field_name ] ); }
if ( in_array( "REQUEST", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_REQUEST[ $field_name ] ) )
{ $this->$field_name = stripslashes( $_REQUEST[ $field_name ] ); }
}
else
{
if ( in_array( "GET", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_GET[ $field_name ] ) )
{ $this->$field_name = $_GET[ $field_name ]; }
if ( in_array( "POST", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_POST[ $field_name ] ) )
{ $this->$field_name = $_POST[ $field_name ]; }
if ( in_array( "REQUEST", $request_type_arr ) )
foreach ( $field_arr as $field_name )
if ( isset( $_REQUEST[ $field_name ] ) )
{ $this->$field_name = $_REQUEST[ $field_name ]; }
}
return true;
}
/**
* Puts the fields of this Object, that correspond with the fields of
* database table, into the $_POST-Array.
*
* @access public
* @version 1.0
*
* @return void
*/
function putDatabaseFieldsIntoPostVars()
{
if ( method_exists ( $this->____dbt, "getFieldnames" ) )
{
$tmp_arr = $this->____dbt->getFieldnames();
foreach ( $tmp_arr as $value )
{
$_POST[$value] = $this->$value;
$_REQUEST[$value] = $this->$value;
}
}
}
/**
* Puts the fields of this Object, that correspond with the fields of
* database table, into the $_GET-Array.
*
* @access public
* @version 1.0
*
* @return void
*/
function putDatabaseFieldsIntoGetVars()
{
if ( method_exists ( $this->____dbt, "getFieldnames" ) )
{
$tmp_arr = $this->____dbt->getFieldnames();
foreach ( $tmp_arr as $value )
{
$_GET[$value] = $this->$value;
$_REQUEST[$value] = $this->$value;
}
}
}
/**
* Prints out the Structure of this Object without the management data.
*
* @require PHP 4
* @version 1.0
* @since 0.1.37
* @access public
*
* @return void
*
* @author Daniel Plücken <daniel.pluecken@wfp2.com>
*/
function printStructure()
{ parent::printStructure( "!^\_\_\_\_!" ); }
} // End of class DatabaseEntity
?>

Source for file DatabaseEntity.class.php