Source for file _class_dataobject.php

Documentation is available at _class_dataobject.php

<?php
/**
* Data Object Base Class
*
* "data objects by fplanque" :P
*
* b2evolution - {@link http://b2evolution.net/}
* Released under GNU GPL License - {@link http://b2evolution.net/about/license.html}
*
* @package evocore
*/
if( !defined('DB_USER') ) die( 'Please, do not access this page directly.' );
/**
* Data Object Base Class
*
* This is typically an abstract class, useful only when derived.
*
* @package evocore
* @version beta
* @abstract
*/
class DataObject
{
/**
* Unique ID of object in database
*
* Please use get/set functions to read or write this param
*
* @var int
* @access protected
*/
var $ID = 0; // This will be the ID in the DB
/**#@+
* @access private
*/
var $dbtablename;
var $dbprefix;
var $dbIDname;
var $dbchanges = array();
/**#@-*/
/**
* Constructor
*
* {@internal DataObject::DataObject(-) }}
*
* @param string Name of table in database
* @param string Prefix of fields in the table
* @param string Name of the ID field (including prefix)
*/
function DataObject( $tablename, $prefix = '', $dbIDname = 'ID' )
{
$this->dbtablename = $tablename;
$this->dbprefix = $prefix;
$this->dbIDname = $dbIDname;
}
/**
* Records a change that will need to be updated in the db
*
* {@internal DataObject::dbchange(-) }}
*
* @access protected
* @param string Name of parameter
* @param string DB field type ('string', 'number', 'date' )
* @param mixed Pointer to value of parameter
*/
function dbchange( $dbfieldname, $dbfieldtype, $valuepointer )
{
$this->dbchanges[$dbfieldname]['type'] = $dbfieldtype;
$this->dbchanges[$dbfieldname]['value'] = $valuepointer ;
}
/*
* DataObject::dbupdate(-)
*
* Update the DB based on previously recorded changes
*/
function dbupdate( )
{
global $DB;
if( $this->ID == 0 ) die( 'New object cannot be updated!' );
if( count( $this->dbchanges ) == 0 )
return; // No changes!
$sql_changes = array();
foreach( $this->dbchanges as $loop_dbfieldname => $loop_dbchange )
{
// Get changed value:
eval('$loop_value = $this->'. $loop_dbchange['value'].';');
// Prepare matching statement:
switch( $loop_dbchange['type'] )
{
case 'string':
$sql_changes[] = $loop_dbfieldname. " = '". $DB->escape( $loop_value ). "' ";
break;
default:
$sql_changes[] = $loop_dbfieldname. " = $loop_value ";
}
}
// Prepare full statement:
$sql = "UPDATE $this->dbtablename SET ". implode( ', ', $sql_changes ). " WHERE $this->dbIDname = $this->ID";
//echo $sql;
$DB->query($sql);
// Reset changes in object:
$this->dbchanges = array();
}
/*
* DataObject::dbinsert(-)
*
* Insert object into DB based on previously recorded changes
*/
function dbinsert( )
{
global $DB;
if( $this->ID != 0 ) die( 'Existing object cannot be inserted!' );
$sql_fields = array();
$sql_values = array();
foreach( $this->dbchanges as $loop_dbfieldname => $loop_dbchange )
{
// Get changed value:
eval('$loop_value = $this->'. $loop_dbchange['value'].';');
// Prepare matching statement:
$sql_fields[] = $loop_dbfieldname;
switch( $loop_dbchange['type'] )
{
case 'string':
$sql_values[] = $DB->quote( $loop_value );
break;
default:
$sql_values[] = $DB->null( $loop_value );
}
}
// Prepare full statement:
$sql = "INSERT INTO {$this->dbtablename} (". implode( ', ', $sql_fields ). ") VALUES (". implode( ', ', $sql_values ). ")";
// echo $sql;
$DB->query($sql);
// store ID for newly created db record
$this->ID = $DB->insert_id;
// Reset changes in object:
$this->dbchanges = array();
}
/*
* DataObject::dbdelete(-)
*
* Delete object from DB
*/
function dbdelete( )
{
global $DB;
if( $this->ID == 0 ) die( 'Non persistant object cannot be deleted!' );
$query = "DELETE FROM $this->dbtablename
WHERE $this->dbIDname = $this->ID";
$DB->query($query);
}
/**
* Get a member param by its name
*
* {@internal DataObject::get(-) }}
*
* @param mixed Name of parameter
* @return mixed Value of parameter
*/
function get( $parname )
{
return $this->$parname;
}
/**
* Get a ready-to-display member param by its name
*
* Same as disp but don't echo
*
* {@internal DataObject::dget(-) }}
*
* @param string Name of parameter
* @param string Output format, see {@link format_to_output()}
*/
function dget( $parname, $format = 'htmlbody' )
{
// Note: we call get again because of derived objects specific handlers !
return format_to_output( $this->get($parname), $format );
}
/**
* Display a member param by its name
*
* {@internal DataObject::disp(-) }}
*
* @param string Name of parameter
* @param string Output format, see {@link format_to_output()}
*/
function disp( $parname, $format = 'htmlbody' )
{
// Note: we call get again because of derived objects specific handlers !
echo format_to_output( $this->get($parname), $format );
}
/**
* Set param value
*
* {@internal DataObject::set_param(-) }}
*
* @param string Name of parameter
* @param string DB field type ('string', 'number', 'date' )
* @param mixed Value of parameter
*/
function set_param( $parname, $fieldtype, $parvalue )
{
// Set value:
$this->$parname = $parvalue;
// Remember change for later db update:
$this->dbchange( $this->dbprefix. $parname , $fieldtype, $parname );
}
/**
* Template function: Displays object ID
*
* {@internal DataObject::ID(-) }}
*/
function ID()
{
echo $this->ID;
}
}

Multilingual multiuser multiblog engine

Source for file _class_dataobject.php

Packages