SystemBlockHandler Class Reference

Inheritance diagram for SystemBlockHandler:

Public Member Functions
	__construct ($db)
	countSimilarBlocks ($moduleId, $funcNum, $showFunc=null)
	getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby="b.weight,b.bid", $isactive=1)
	getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)
	getBlockByPerm ($groupid)
	getNonGroupedBlocks ($module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)
	getObjects ($criteria=null, $id_as_key=false)
	insert ($obj)
Public Member Functions inherited from XoopsPersistableObjectHandler
	__construct ($db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
	__call ($name, $args)
	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')
	convertResultSet ($result, $id_as_key=false, $as_object=true)
&	create ($isNew=true)
	delete (&$object, $force=false)
	deleteAll ($criteria=null, $force=true, $asObject=false)
	deleteByLink ($criteria=null)
&	get ($id=null, $fields=null)
&	getAll ($criteria=null, $fields=null, $asObject=true, $id_as_key=true)
&	getByLimit ($limit=0, $start=0, $criteria=null, $fields=null, $asObject=true)
&	getByLink ($criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCount ($criteria=null)
	getCountByLink ($criteria=null)
	getCounts ($criteria=null)
	getCountsByLink ($criteria=null)
&	getIds ($criteria=null)
	getList ($criteria=null, $limit=0, $start=0)
&	getObjects ($criteria=null, $id_as_key=false, $as_object=true)
	insert (&$object, $force=true)
	loadHandler ($name, $args=null)
	setHandler ($handler=null, $args=null, $path=null)
	synchronization ()
	updateAll ($fieldname, $fieldvalue, $criteria=null, $force=false)
	updateByLink ($data, $criteria=null)
	XoopsPersistableObjectHandler ($db=null, $table= '', $className= '', $keyName= '', $identifierName= '')
Public Member Functions inherited from XoopsObjectHandler
&	create ()
	delete (&$object)
&	get ($int_id)
	insert (&$object)
	XoopsObjectHandler (&$db)

Additional Inherited Members
Public Attributes inherited from XoopsPersistableObjectHandler
	$className
	$handler
	$handlers = array('read' => null , 'stats' => null , 'joint' => null , 'write' => null , 'sync' => null)
	$identifierName
	$keyName
	$table

Detailed Description

Definition at line 281 of file block.php.

Constructor & Destructor Documentation

SystemBlockHandler::__construct

(

$db

)

Definition at line 283 of file block.php.

References XoopsObjectHandler\$db.

Member Function Documentation

SystemBlockHandler::countSimilarBlocks	(		$moduleId,
			$funcNum,
			$showFunc = null
	)

XoopsBlock::countSimilarBlocks()

Parameters

mixed	$moduleId
mixed	$funcNum
mixed	$showFunc

Returns

Definition at line 536 of file block.php.

References XoopsObjectHandler\$db, $result, $sql, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

SystemBlockHandler::getAllBlocksByGroup	(		$groupid,
			$asobject = true,
			$side = null,
			$visible = null,
			$orderby = "b.weight,b.bid",
			$isactive = 1
	)

get all the blocks that match the supplied parameters

Parameters

$side	0: sideblock - left 1: sideblock - right 2: sideblock - left and right 3: centerblock - left 4: centerblock - right 5: centerblock - center 6: centerblock - left, right, center
$groupid	groupid (can be an array)
$visible	0: not visible 1: visible
$orderby	order of the blocks

Returns

array of block objects

Definition at line 345 of file block.php.

References XoopsObjectHandler\$db, $i, $result, $ret, $sql, XoopsDatabaseFactory\getDatabaseConnection(), XOOPS_CENTERBLOCK_ALL, and XOOPS_SIDEBLOCK_BOTH.

Here is the call graph for this function:

SystemBlockHandler::getAllByGroupModule	(		$groupid,
			$module_id = 0,
			$toponlyblock = false,
			$visible = null,
			$orderby = 'b.weight,
		m.block_id'	,
			$isactive = 1
	)

Definition at line 422 of file block.php.

References XoopsObjectHandler\$db, $GLOBALS, $module_id, $result, $ret, and $sql.

SystemBlockHandler::getBlockByPerm

(

$groupid

)

Definition at line 398 of file block.php.

References $result, $ret, and $sql.

SystemBlockHandler::getNonGroupedBlocks	(		$module_id = 0,
			$toponlyblock = false,
			$visible = null,
			$orderby = 'b.weight,
		m.block_id'	,
			$isactive = 1
	)

Definition at line 477 of file block.php.

References XoopsObjectHandler\$db, $GLOBALS, $module_id, $result, $ret, and $sql.

SystemBlockHandler::getObjects	(		$criteria = null,
			$id_as_key = false
	)

retrieve array of XoopsBlocks meeting certain conditions

Parameters

object	$criteria	CriteriaElement with conditions for the blocks
bool	$id_as_key	should the blocks' bid be the key for the returned array?

Returns

array XoopsBlocks matching the conditions

Definition at line 301 of file block.php.

References $criteria, $limit, $result, $ret, $sql, and $start.

SystemBlockHandler::insert

(

$obj

)

Definition at line 288 of file block.php.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/modules/system/class/block.php