Class XoopsBlockHandler

XOOPS block handler class. (Singelton)

This class is responsible for providing data access mechanisms to the data source of XOOPS block class objects.

XoopsBlockHandler

Package: kernel\block
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono onokazu@xoops.org
Located at ernel/block.php

Methods summary
`public XoopsBlock`	# `create( boolean $isNew = true )` create a new block create a new block Parameters `$isNew` is the new block new?? Returns `XoopsBlock` XoopsBlock reference to the new block See `XoopsBlock` Overrides `XoopsObjectHandler::create()`
`public XoopsBlock`	# `get( integer $id )` retrieve a specific `XoopsBlock` retrieve a specific `XoopsBlock` Parameters `$id` bid of the block to retrieve Returns `XoopsBlock` reference to the block See `XoopsBlock` Overrides `XoopsObjectHandler::get()`
`public boolean`	# `insert( XoopsObject $block )` write a new block into the database write a new block into the database Parameters `$block` a XoopsBlock object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::insert()`
`public boolean`	# `delete( XoopsObject $block )` delete a block from the database delete a block from the database Parameters `$block` a XoopsBlock object Returns boolean true on success, otherwise false Overrides `XoopsObjectHandler::delete()`
`public array`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false )` retrieve array of `XoopsBlock`s meeting certain conditions retrieve array of `XoopsBlock`s meeting certain conditions Parameters `$criteria` `CriteriaElement` with conditions for the blocks `$id_as_key` should the blocks' bid be the key for the returned array? Returns array `XoopsBlock`s matching the conditions
`public array`	# `getList( CriteriaElement $criteria = null )` get a list of blocks matchich certain conditions get a list of blocks matchich certain conditions Parameters `$criteria` conditions to match Returns array array of blocks matching the conditions
`public boolean`	# `getByModule( $moduleid, boolean $asobject = true, boolean $id_as_key = false )` Deprecated Parameters `$moduleid` `$asobject` `$id_as_key` Returns boolean
`public boolean`	# `getAllByGroupModule( $groupid, integer $module_id = 0, boolean $toponlyblock = false, null $visible = null, string $orderby = 'i.weight,i.instanceid', integer $isactive = 1, $moduleid,…, boolean $asobject,…, boolean $id_as_key,… )` Deprecated Parameters `$groupid` `$module_id` `$toponlyblock` `$visible` `$orderby` `$isactive` `$moduleid`,… `$asobject`,… `$id_as_key`,… Returns boolean boolean
`public boolean`	# `getAdminBlocks( $groupid, string $orderby = 'i.weight,i.instanceid', $moduleid,…, boolean $asobject,…, boolean $id_as_key,… )` Deprecated Parameters `$groupid` `$orderby` `$moduleid`,… `$asobject`,… `$id_as_key`,… Returns boolean boolean
`public boolean`	# `assignBlocks( $moduleid,…, boolean $asobject,…, boolean $id_as_key,… )` Deprecated Parameters `$moduleid`,… `$asobject`,… `$id_as_key`,… Returns boolean boolean

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler(), __construct()`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsBlockHandler

Parameters

Returns

See

Overrides

Parameters

Returns

See

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns

Deprecated

Parameters

Returns