XoopsBlockHandler Class Reference

Inheritance diagram for XoopsBlockHandler:

Collaboration diagram for XoopsBlockHandler:

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

Additional Inherited Members
Data Fields inherited from XoopsObjectHandler
	$db

Member Function Documentation

assignBlocks()

assignBlocks

(

)

Returns

bool

Deprecated:

create()

create

(

$isNew = true

)

create a new block

See also

XoopsBlock

Parameters

bool

$isNew

is the new block new??

Returns

XoopsBlock XoopsBlock reference to the new block

delete()

delete

(

XoopsObject

$block

)

delete a block from the database

Parameters

XoopsObject | XoopsBlock

$block

a XoopsBlock object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

get()

get

(

$id

)

retrieve a specific XoopsBlock

See also

XoopsBlock

Parameters

int

$id

bid of the block to retrieve

Returns

XoopsBlock reference to the block

Reimplemented from XoopsObjectHandler.

getAdminBlocks()

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

Parameters

	$groupid
string	$orderby

Returns

bool

Deprecated:

getAllByGroupModule()

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

Parameters

	$groupid
int	$module_id
bool	$toponlyblock
null	$visible
string	$orderby
int	$isactive

Returns

bool

Deprecated:

getByModule()

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

Deprecated:

Parameters

	$moduleid
bool	$asobject
bool	$id_as_key

Returns

bool

getList()

getList

(

CriteriaElement

$criteria = null

)

get a list of blocks matchich certain conditions

Parameters

CriteriaElement

$criteria

conditions to match

Returns

array array of blocks matching the conditions

getObjects()

getObjects	(	CriteriaElement	$criteria = null,
			$id_as_key = false
	)

retrieve array of XoopsBlocks meeting certain conditions

Parameters

CriteriaElement | CriteriaCompo	$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

insert()

insert

(

XoopsObject

$block

)

write a new block into the database

Parameters

XoopsObject | XoopsBlock

$block

a XoopsBlock object

Returns

bool true on success, otherwise false

Reimplemented from XoopsObjectHandler.

Here is the call graph for this function:

---

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

• C:/xoops2511b2/htdocs/kernel/block.php