Class: DataObject

Source Location: /blogs/inc/MODEL/dataobjects/_dataobject.class.php

Class DataObject

Class Overview

Data Object Base Class

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

Located in /blogs/inc/MODEL/dataobjects/_dataobject.class.php [line 51]

Author(s):

API Tags:

Abstract:

Information Tags:

Version:

beta

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
Element	User Element
Filetype	Filetype Class
File	Represents a file or folder on disk. Optionnaly stores meta data from DB.
Item	Item Class
ItemType	ItemType Class
Link	Item Link
Group	User Group
User	User Class
Comment	Comment Class
Blog	Blog
GenericElement	User Element

[ Top ]

Property Summary

mixed	$delete_cascades	Relations that will cascade deletion.
mixed	$delete_restrictions	Relations that may restrict deletion.
int	$ID	Unique ID of object in database

[ Top ]

Method Summary

DataObject	DataObject()	Constructor
boolean	check_delete()	Check relations for restrictions before deleting
void	check_relations()	Check relations for restrictions or cascades
void	confirm_delete()	Displays form to confirm deletion of this object
void	dbchange()	Records a change that will need to be updated in the db
boolean	dbdelete()	Delete object from DB.
boolean	dbinsert()	Insert object into DB based on previously recorded changes.
boolean	dbsave()	Inserts or Updates depending on object state.
boolean\|NULL	dbupdate()	Update the DB based on previously recorded changes
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	history_info_icon()	Create icon with dataobject history
void	ID()	Template function: Displays object ID.
boolean	set()	Set param value
boolean	set_from_Request()	Set a parameter from a Request form value.
boolean	set_param()	Set param value.

[ Top ]

Properties

mixed $delete_cascades = array() [line 84]

Relations that will cascade deletion.

[ Top ]

mixed $delete_restrictions = array() [line 79]

Relations that may restrict deletion.

[ Top ]

int $ID = 0 [line 61]

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 98]

DataObject DataObject(
string
$tablename, [string
$prefix = ''], [string
$dbIDname = 'ID'], [string
$datecreated_field = ''], [string
$datemodified_field = ''], [string
$creator_field = ''], [string
$lasteditor_field = ''] 
)

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)
string	$datecreated_field:	datetime field name
string	$datemodified_field:	datetime field name
string	$creator_field:	User ID field name
string	$lasteditor_field:	User ID field name

[ Top ]

check_delete [line 381]

boolean check_delete(
string
$restrict_title, [array
$ignore = array()] 
)

Check relations for restrictions before deleting

Parameters:

string	$restrict_title:
array	$ignore:	list of foreign keys to ignore

API Tags:

Return:

true if no restriction prevents deletion

[ Top ]

check_relations [line 352]

void check_relations(

$what, [
$ignore = array()] 
)

Check relations for restrictions or cascades

Parameters:

	$what:
	$ignore:

[ Top ]

confirm_delete [line 410]

void confirm_delete(
string
$confirm_title, string
$delete_action, array
$hiddens, [string
$cancel_action = NULL] 
)

Displays form to confirm deletion of this object

Parameters:

string	$confirm_title:	Title for confirmation
string	$delete_action:	"action" param value to use (hidden field)
array	$hiddens:	Hidden keys (apart from "action")
string	$cancel_action:	most of the time we don't need a cancel action since we'll want to return to the default display

[ Top ]

dbchange [line 118]

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 303]

boolean dbdelete(
)

Delete object from DB.

API Tags:

Return:

true on success

Redefined in descendants as:

Item::dbdelete() : Trigger event AfterItemDelete after calling parent method.
User::dbdelete() : Delete user and dependencies from database
Comment::dbdelete() : Trigger event AfterCommentDelete after calling parent method.
Blog::dbdelete() : Delete a blog and dependencies from database

[ Top ]

dbinsert [line 201]

boolean dbinsert(
)

Insert object into DB based on previously recorded changes.

API Tags:

Return:	true on success
Usedby:	DataObject::dbsave()

Redefined in descendants as:

File::dbinsert() : Insert object into DB based on previously recorded changes
Item::dbinsert() : Insert object into DB based on previously recorded changes
User::dbinsert() : Insert object into DB based on previously recorded changes
Comment::dbinsert() : Get karma and set it before adding the Comment to DB.
GenericProperty::dbinsert() : Insert object into DB based on previously recorded changes
GenericOrdered::dbinsert() : Insert object into DB based on previously recorded changes

[ Top ]

dbsave [line 283]

boolean dbsave(
)

Inserts or Updates depending on object state.

API Tags:

Return:	true on success, false on failure
Uses:	DataObject::dbupdate()
Uses:	DataObject::dbinsert()

[ Top ]

dbupdate [line 131]

boolean|NULL dbupdate(
)

Update the DB based on previously recorded changes

API Tags:

Return:	true on success, false on failure to update, NULL if no update necessary
Usedby:	DataObject::dbsave()

Redefined in descendants as:

File::dbupdate() : Update the DB based on previously recorded changes
Item::dbupdate() : Update the DB based on previously recorded changes
User::dbupdate() : Update the DB based on previously recorded changes.
Comment::dbupdate() : Trigger event AfterCommentUpdate after calling parent method.
Blog::dbupdate() : Update the DB based on previously recorded changes
GenericProperty::dbupdate() : Update the DB based on previously recorded changes

[ Top ]

dget [line 473]

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 486]

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 459]

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:

Item::get() : Get a member param by its name
User::get() : Get a param
Comment::get() : Get a member param by its name
Blog::get() : Get a param.

[ Top ]

history_info_icon [line 613]

void history_info_icon(
)

Create icon with dataobject history

[ Top ]

ID [line 605]

void ID(
)

Template function: Displays object ID.

[ Top ]

set [line 503]

boolean set(
string
$parname, mixed
$parvalue, [boolean
$make_null = false] 
)

Set param value

By default, all values will be considered strings

Parameters:

string	$parname:	parameter name
mixed	$parvalue:	parameter value
boolean	$make_null:	true to set to NULL if empty value

API Tags:

Return:

true, if a value has been set; false if it has not changed

Redefined in descendants as:

Filetype::set() : Set param value
Item::set() : Set param value
Group::set() : Set param value
User::set() : Set param value
Comment::set() : Set param value
Blog::set() : Set param value
GenericProperty::set() : Set param value
GenericCategory::set() : Set param value
GenericOrdered::set() : Set param value

[ Top ]

set_from_Request [line 589]

boolean set_from_Request(
string
$parname, [string|NULL
$var = NULL], [boolean
$make_null = false] 
)

Set a parameter from a Request form value.

Parameters:

string	$parname:	Dataobject parameter name
string\|NULL	$var:	Request parameter name (NULL means to use Dataobject param name with its prefix)
boolean	$make_null:	true to set to NULL if empty string value

API Tags:

Return:

true, if value has been set/changed, false if not.

[ Top ]

set_param [line 518]

boolean set_param(
string
$parname, string
$fieldtype, mixed
$parvalue, [boolean
$make_null = false] 
)

Set param value.

Parameters:

string	$parname:	Name of parameter
string	$fieldtype:	DB field type ('string', 'number', 'date' )
mixed	$parvalue:	Value of parameter
boolean	$make_null:	true to set to NULL if empty string value

API Tags:

Return:

true, if value has been set/changed, false if not.

[ Top ]

Multilingual multiuser multiblog engine

Class: DataObject

Class DataObject

Packages

Classes

Files