Class SystemBlockHandler

System block handler class.

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

SystemBlockHandler

Package: system\blocks
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Located at odules/system/class/block.php

Methods summary
`public`	# `__construct( XoopsDatabase $db )` Parameters `$db` Overrides `XoopsPersistableObjectHandler::__construct()`
`public integer\|boolean`	# `insert( XoopsObject $obj, boolean $force = true )` Parameters `$obj` `$force` flag to force the query execution despite security settings Returns integer\|boolean object id on success, otherwise false Overrides `XoopsPersistableObjectHandler::insert()`
`public array &`	# `getObjects( CriteriaElement $criteria = null, boolean $id_as_key = false, boolean $as_object = true )` 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? `$as_object` return an array of objects Returns array `XoopsBlock`s matching the conditions Overrides `XoopsPersistableObjectHandler::getObjects()`
`public array`	# `getAllBlocksByGroup( integer\|int[] $groupid, boolean $asobject = true, integer\|string $side = null, $visible = null, string $orderby = 'b.weight,b.bid', integer $isactive = 1 )` get all the blocks that match the supplied parameters get all the blocks that match the supplied parameters Parameters `$groupid` groupid (can be an array) `$asobject` `$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 `$visible` not visible 1: visible `$orderby` order of the blocks `$isactive` Returns array of block objects
`public array`	# `getBlockByPerm( $groupid )` Parameters `$groupid` Returns array
`public array`	# `getAllByGroupModule( $groupid, integer $module_id = 0, boolean $toponlyblock = false, null $visible = null, string $orderby = 'b.weight, m.block_id', integer $isactive = 1 )` Parameters `$groupid` `$module_id` `$toponlyblock` `$visible` `$orderby` `$isactive` Returns array
`public array`	# `getNonGroupedBlocks( integer $module_id = 0, boolean $toponlyblock = false, null $visible = null, string $orderby = 'b.weight, m.block_id', integer $isactive = 1 )` Parameters `$module_id` `$toponlyblock` `$visible` `$orderby` `$isactive` Returns array
`public integer`	# `countSimilarBlocks( mixed $moduleId, mixed $funcNum, mixed $showFunc = null )` XoopsBlock::countSimilarBlocks() XoopsBlock::countSimilarBlocks() Parameters `$moduleId` `$funcNum` `$showFunc` Returns integer

Methods inherited from XoopsPersistableObjectHandler
`XoopsPersistableObjectHandler(), __call(), cleanOrphan(), convertResultSet(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLimit(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()`

Methods inherited from XoopsObjectHandler
`XoopsObjectHandler()`

Properties inherited from XoopsPersistableObjectHandler
`$className, $field_link, $field_object, $handler, $handlers, $identifierName, $keyName, $table`

Properties inherited from XoopsObjectHandler
`$db`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class SystemBlockHandler

Parameters

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns