XoopsObjectGenericHandler Class Reference

Inherited by LegacyBlock_module_linkHandler, LegacyCommentHandler, LegacyGroup_permissionHandler, LegacyImagebodyHandler, LegacyImagecategoryHandler, LegacyImageHandler, LegacyNewblocksHandler, LegacyRenderBannerclientHandler, LegacyRenderBannerfinishHandler, LegacyRenderBannerHandler, LegacyRenderThemeHandler, LegacyRenderTplfileHandler, LegacyRenderTplsetHandler, LegacyRenderTplsourceHandler, LegacySmilesHandler, PmPriv_msgsHandler, UserAvatar_user_linkHandler, UserAvatarHandler, UserGroups_users_linkHandler, UserGroupsHandler, UserMailjob_linkHandler, UserMailjobHandler, UserOnlineHandler, UserRanksHandler, and UserUsersHandler.

List of all members.

Public Member Functions

getObjects ($criteria=null, $limit=null, $start=null, $id_as_key=false)
 _getCount ($sql=null)
 _insert (&$obj)
 _update (&$obj)
 _makeVars4sql (&$obj)
 _makeCriteriaElement4sql ($criteria, &$obj)
 delete (&$obj, $force=false)
 deleteAll ($criteria, $force=false)
createCriteria ()

Public Attributes

 $_mDummyObj = null


Detailed Description

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


Member Function Documentation

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

Return array of object with $criteria.

public

Parameters:
CriteriaElement $criteria
int $limit
int $start
bool $id_as_key
Returns:
array

XoopsObjectGenericHandler::_getCount ( sql = null  ) 

private

XoopsObjectGenericHandler::_insert ( &$  obj  ) 

private

XoopsObjectGenericHandler::_update ( &$  obj  ) 

private

XoopsObjectGenericHandler::_makeVars4sql ( &$  obj  ) 

SQL generation helper

Parameters:
$obj xoopsObject
Returns:
Array

XoopsObjectGenericHandler::_makeCriteriaElement4sql ( criteria,
&$  obj 
)

Parameters:
$criteria CriteriaElement
$obj XoopsSimpleObject

XoopsObjectGenericHandler::delete ( &$  obj,
force = false 
)

Delete $obj.

Returns:
bool

XoopsObjectGenericHandler::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

& XoopsObjectGenericHandler::createCriteria (  ) 

Create criteria object for this handler, and return it.

public

Returns:
Object Legacy_Criteria


Member Data Documentation

XoopsObjectGenericHandler::$_mDummyObj = null

A instance of xoops simple object to get type information.


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:26 2006 for XOOPS Cube Legacy by  doxygen 1.5.1