Docs For Class DataObject

Class Overview

Data Object Base Class

This is typically an abstract class, useful only when derived.

Located in /blogs/b2evocore/_class_dataobject.php [line 24]

Author(s):

API Tags:

Abstract:

Information Tags:

Version:

beta

Properties

$ID

Methods

[ Top ]

Direct descendents

Child Class	Description
Blog	Blog
Group	User Group
Item	Item Class
User	User Class
Comment	Comment Class

[ Top ]

Property Summary

int

$ID

Unique ID of object in database

[ Top ]

Method Summary

DataObject	DataObject()	Constructor
void	dbchange()	Records a change that will need to be updated in the db
void	dbdelete()
void	dbinsert()
void	dbupdate()
void	dget()	Get a ready-to-display member param by its name
void	disp()	Display a member param by its name
mixed	get()	Get a member param by its name
void	ID()	Template function: Displays object ID
void	set_param()	Set param value

[ Top ]

Properties

int $ID = 0 [line 34]

Unique ID of object in database

Please use get/set functions to read or write this param

API Tags:

Access:

protected

[ Top ]

Methods

Constructor DataObject [line 54]

DataObject DataObject(
string
$tablename, [string
$prefix = ''], [string
$dbIDname = 'ID'] 
)

Constructor

Parameters:

string	$tablename:	Name of table in database
string	$prefix:	Prefix of fields in the table
string	$dbIDname:	Name of the ID field (including prefix)

[ Top ]

dbchange [line 71]

void dbchange(
string
$dbfieldname, string
$dbfieldtype, mixed
$valuepointer 
)

Records a change that will need to be updated in the db

Parameters:

string	$dbfieldname:	Name of parameter
string	$dbfieldtype:	DB field type ('string', 'number', 'date' )
mixed	$valuepointer:	Pointer to value of parameter

API Tags:

Access:

protected

[ Top ]

dbdelete [line 169]

void dbdelete(
)

Redefined in descendants as:

Blog::dbdelete() : Delete a blog and dependencies from database
User::dbdelete() : Delete user and dependencies from database

[ Top ]

dbinsert [line 125]

void dbinsert(
)

[ Top ]

dbupdate [line 83]

void dbupdate(
)

[ Top ]

dget [line 205]

void dget(
string
$parname, [string
$format = 'htmlbody'] 
)

Get a ready-to-display member param by its name

Same as disp but don't echo

Parameters:

string	$parname:	Name of parameter
string	$format:	Output format, see format_to_output()

[ Top ]

disp [line 220]

void disp(
string
$parname, [string
$format = 'htmlbody'] 
)

Display a member param by its name

Parameters:

string	$parname:	Name of parameter
string	$format:	Output format, see format_to_output()

[ Top ]

get [line 189]

mixed get(
mixed
$parname 
)

Get a member param by its name

Parameters:

mixed

$parname:

Name of parameter

API Tags:

Return:

Value of parameter

Redefined in descendants as:

Blog::get() : Get a param
User::get() : Get a param

[ Top ]

ID [line 248]

void ID(
)

Template function: Displays object ID

[ Top ]

set_param [line 235]

void set_param(
string
$parname, string
$fieldtype, mixed
$parvalue 
)

Set param value

Parameters:

string	$parname:	Name of parameter
string	$fieldtype:	DB field type ('string', 'number', 'date' )
mixed	$parvalue:	Value of parameter

[ Top ]

Multilingual multiuser multiblog engine

Class: DataObject

Class DataObject

Packages

Classes

Files