XoopsBlockHandler Class Reference

Inheritance diagram for XoopsBlockHandler:

Public Member Functions
	assignBlocks ()
&	create ($isNew=true)
	delete (&$block)
&	get ($id)
	getAdminBlocks ($groupid, $orderby='i.weight, i.instanceid')
	getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby= 'i.weight, i.instanceid', $isactive=1)
	getByModule ($moduleid, $asobject=true, $id_as_key=false)
	getList ($criteria=null)
	getObjects ($criteria=null, $id_as_key=false)
	insert (&$block)
Public Member Functions inherited from XoopsObjectHandler
&	create ()
	delete (&$object)
&	get ($int_id)
	insert (&$object)
	XoopsObjectHandler (&$db)

Additional Inherited Members
Public Attributes inherited from XoopsObjectHandler
	$db

Detailed Description

Definition at line 338 of file block.php.

Member Function Documentation

XoopsBlockHandler::assignBlocks

(

)

Definition at line 516 of file block.php.

& XoopsBlockHandler::create

(

$isNew = true

)

create a new block

See Also

XoopsBlock

Parameters

bool

$isNew

is the new block new??

Returns

object XoopsBlock reference to the new block

Definition at line 347 of file block.php.

XoopsBlockHandler::delete

(

&

$block

)

delete a block from the database

Parameters

object

XoopsBlock $block reference to the block to delete

Returns

bool TRUE if succesful

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 425 of file block.php.

References $result, and $sql.

& XoopsBlockHandler::get

(

$id

)

retrieve a specific XoopsBlock

See Also

XoopsBlock

Parameters

int

$id

bid of the block to retrieve

Returns

object XoopsBlock reference to the block

Definition at line 363 of file block.php.

References $result, and $sql.

XoopsBlockHandler::getAdminBlocks	(		$groupid,
			$orderby = 'i.weight,
		i.instanceid'
	)

Definition at line 510 of file block.php.

XoopsBlockHandler::getAllByGroupModule	(		$groupid,
			$module_id = 0,
			$toponlyblock = false,
			$visible = null,
			$orderby = 'i.weight,
		i.instanceid'	,
			$isactive = 1
	)

Definition at line 504 of file block.php.

XoopsBlockHandler::getByModule	(		$moduleid,
			$asobject = true,
			$id_as_key = false
	)

#@+

Deprecated:

Definition at line 498 of file block.php.

XoopsBlockHandler::getList

(

$criteria = null

)

get a list of blocks matchich certain conditions

Parameters

string

$criteria

conditions to match

Returns

array array of blocks matching the conditions

Definition at line 482 of file block.php.

References $criteria, $i, and $ret.

XoopsBlockHandler::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 449 of file block.php.

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

XoopsBlockHandler::insert

(

&

$block

)

write a new block into the database

Parameters

object

XoopsBlock $block reference to the block to insert

Returns

bool TRUE if succesful

: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5

Definition at line 386 of file block.php.

References $content, $dirname, $mid, $options, $result, $sql, and $title.

---

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

• L:/0xoops/xoops-2.5.6/htdocs/kernel/block.php