XoopsObjectGenericHandler Class Reference

Inheritance diagram for XoopsObjectGenericHandler:

Public Member Functions
	__construct (&$db)
&	create ($isNew=true)
&	get ($id)
&	getObjects ($criteria=null, $limit=null, $start=null, $id_as_key=false)
	getIdList ($criteria=null, $limit=null, $start=null)
	getCount ($criteria=null)
	_getCount ($sql=null)
	insert (&$obj, $force=false)
	_insert (&$obj)
	_update (&$obj)
	_makeVars4sql (&$obj)
	_makeCriteria4sql ($criteria)
	_makeCriteriaElement4sql ($criteria, &$obj)
	_escapeValue ($value, $type)
	delete (&$obj, $force=false)
	deleteAll ($criteria, $force=false)
	getDirname ()
	getDataname ()
	_callDelegate ( $type, &$obj)
Public Member Functions inherited from XoopsObjectHandler
&	create ()
	insert (&$object)
	delete (&$object)

Data Fields
	$mTable = null
	$mPrimary = null
	$mClass = null
	$mDirname = null
	$mDataname = null
	$_mDummyObj = null
Data Fields inherited from XoopsObjectHandler
	$db

Detailed Description

NOTE: This class has only one primary key and one table.

Definition at line 19 of file handler.php.

Constructor & Destructor Documentation

__construct()

__construct

(

&

$db

)

called from child classes only

Parameters

object

$db

reference to the XoopsDatabase object @access protected

Reimplemented from XoopsObjectHandler.

Reimplemented in LegacyCommentHandler, MessageInboxHandler, and MessageOutboxHandler.

Definition at line 32 of file handler.php.

Member Function Documentation

_callDelegate()

_callDelegate	(		$type,
		&	$obj )

_callDelegate

Parameters

string	$type
XoopsSimpleObject	&$obj

Returns

string

Parameters

$type	* string **
$obj	* XoopsSimpleObject **

Definition at line 496 of file handler.php.

_escapeValue()

_escapeValue	(		$value,
			$type )

Definition at line 402 of file handler.php.

_getCount()

_getCount

(

$sql = null

)

@access private

Parameters

null

$sql

Returns

bool

Definition at line 226 of file handler.php.

_insert()

_insert

(

&

$obj

)

@access private

Parameters

$obj

Returns

string

Definition at line 275 of file handler.php.

_makeCriteria4sql()

_makeCriteria4sql

(

$criteria

)

Definition at line 345 of file handler.php.

_makeCriteriaElement4sql()

_makeCriteriaElement4sql	(		$criteria,
		&	$obj )

Parameters

CriteriaElement	$criteria
XoopsSimpleObject	$obj

Returns

string|null

Definition at line 359 of file handler.php.

_makeVars4sql()

_makeVars4sql

(

&

$obj

)

SQL generation helper

Parameters

xoopsObject

$obj

Returns

Array

Definition at line 323 of file handler.php.

_update()

_update

(

&

$obj

)

@access private

Parameters

$obj

Returns

string

Reimplemented in UserAvatar_user_linkHandler, and UserMailjob_linkHandler.

Definition at line 298 of file handler.php.

create()

& create

(

$isNew = true

)

Definition at line 45 of file handler.php.

delete()

delete	(	&	$obj,
			$force = false )

Delete $obj.

Parameters

	$obj
bool	$force

Returns

bool

Reimplemented in Legacy_AbstractClientObjectHandler, LegacyCommentHandler, LegacyImagecategoryHandler, LegacyImageHandler, LegacyNewblocksHandler, LegacyRenderBannerclientHandler, LegacyRenderTplfileHandler, LegacyRenderTplsetHandler, LegacySmilesHandler, Profile_DefinitionsHandler, UserAvatar_user_linkHandler, UserAvatarHandler, UserMailjob_linkHandler, and UserRanksHandler.

Definition at line 424 of file handler.php.

deleteAll()

deleteAll	(		$criteria,
			$force = false )

Delete plural objects by $criteria. If the sub-class want to override the procedure of delete, delete() is better. This member function fetches objects by $criteria and casts these objects into delete() inside.

Parameters

Criteria	$criteria
bool	$force

Returns

bool

Reimplemented in UserUsers_searchHandler.

Definition at line 451 of file handler.php.

get()

& get

(

$int_id

)

gets a value object

Parameters

int

$int_id

@abstract

Reimplemented from XoopsObjectHandler.

Reimplemented in UserAvatar_user_linkHandler, and UserUsersHandler.

Definition at line 58 of file handler.php.

getCount()

getCount

(

$criteria = null

)

Definition at line 206 of file handler.php.

getDataname()

getDataname

(

)

getDataname

Parameters

void

Returns

string[]

Definition at line 483 of file handler.php.

getDirname()

getDirname

(

)

getDirname

Parameters

void

Returns

string

Definition at line 471 of file handler.php.

getIdList()

getIdList	(		$criteria = null,
			$limit = null,
			$start = null )

Return array of primary id with $criteria.

Parameters

CriteriaElement	$criteria
int	$limit
int	$start

Returns

array

Definition at line 155 of file handler.php.

getObjects()

& getObjects	(		$criteria = null,
			$limit = null,
			$start = null,
			$id_as_key = false )

Return array of object with $criteria.

@access public

Parameters

CriteriaElement	$criteria
int	$limit
int	$start
bool	$id_as_key

Returns

array

Reimplemented in Profile_DefinitionsHandler, UserUsers_searchHandler, and UserUsersHandler.

Definition at line 83 of file handler.php.

insert()

insert	(	&	$obj,
			$force = false )

Reimplemented in Legacy_AbstractClientObjectHandler, and Profile_DefinitionsHandler.

Definition at line 239 of file handler.php.

Field Documentation

$_mDummyObj

$_mDummyObj = null

A instance of xoops simple object to get type information.

Definition at line 30 of file handler.php.

$mClass

$mClass = null

Definition at line 23 of file handler.php.

$mDataname

$mDataname = null

Definition at line 25 of file handler.php.

$mDirname

$mDirname = null

Definition at line 24 of file handler.php.

$mPrimary

$mPrimary = null

Definition at line 22 of file handler.php.

$mTable

$mTable = null

Definition at line 21 of file handler.php.

---

The documentation for this class was generated from the following file:

• html/modules/legacy/kernel/handler.php