Class icms_view_block_Handler

ImpressCMS Core Block Object Handler Class

icms_view_block_Handler

Package: View\Block
Category: ICMS
Copyright: The ImpressCMS Project http://www.impresscms.org
License: GPL v2
Author: Gustavo Pilla (aka nekro) nekro@impresscms.org
Since: ImpressCMS 1.2
Located at view/block/Handler.php

Methods summary
`public object`	# `__construct( object & $db, string $itemname,…, string $keyname,…, string $idenfierName,…, string $summaryName,…, string $modulename,… )` Constructor - called from child classes Constructor - called from child classes Parameters `$db` Database object XoopsDatabase `$itemname`,… Object to be managed `$keyname`,… Name of the table key that uniquely identify each `icms_ipf_Object` `$idenfierName`,… Name of the field which properly identify the `icms_ipf_Object` `$summaryName`,… Name of the field which will be use as a summary for the object `$modulename`,… Directory name of the module controlling this object Returns object Overrides `icms_ipf_Handler::__construct()`
`public array`	# `getBlockPositions( boolean $full = false )` getBlockPositions getBlockPositions Parameters `$full` Returns array
`public array`	# `getByModule( unknown_type $mid, boolean $asObject = true )` getByModule getByModule Parameters `$mid` `$asObject` Returns array See $this->getObjects($criteria, false, $asObject);
`public array`	# `getAllBlocks( string $rettype = "object", string $side = null, boolean $visible = null, string $orderby = "side, weight, bid", boolean $isactive = 1 )` getAllBlocks getAllBlocks Parameters `$rettype` `$side` `$visible` `$orderby` `$isactive` Returns array
`public unknown`	# `getAllByGroupModule( unknown_type $groupid, unknown_type $module_id = '0-0', unknown_type $toponlyblock = false, unknown_type $visible = null, unknown_type $orderby = 'b.weight, b.bid', unknown_type $isactive = 1 )` getAllByGroupModule gets all blocks visible on a page, based on group permissions getAllByGroupModule gets all blocks visible on a page, based on group permissions Parameters `$groupid` `$module_id` `$toponlyblock` `$visible` `$orderby` `$isactive` Returns unknown
`public unknown`	# `getNonGroupedBlocks( unknown_type $module_id = 0, unknown_type $toponlyblock = false, unknown_type $visible = null, unknown_type $orderby = 'b.weight, b.bid', unknown_type $isactive = 1 )` getNonGroupedBlocks getNonGroupedBlocks Parameters `$module_id` `$toponlyblock` `$visible` `$orderby` `$isactive` Returns unknown
`public unknown`	# `insert( unknown_type & $obj, unknown_type $force = false, unknown_type $checkObject = true, unknown_type $debug = false )` Save a icms_view_block_Object Object Save a icms_view_block_Object Object Overwrited Method Parameters `$obj` `$force` `$checkObject` `$debug` Returns unknown Overrides `icms_ipf_Handler::insert()`
`public mixed &`	# `get( mixed $id, boolean $as_object = true, $debug = false, $criteria = false )` retrieve a `icms_ipf_Object` retrieve a `icms_ipf_Object` Parameters `$id` ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor `$as_object` whether to return an object or an array `$debug` `$criteria` Returns mixed reference to the `icms_ipf_Object`, FALSE if failed Overrides `icms_ipf_Handler::get()`
`public`	# `getCountSimilarBlocks( $moduleId, $funcNum, $showFunc = null )`
`public array`	# `getAllBlocksByGroup( $groupid, $asobject = TRUE, $side = NULL, $visible = NULL, $orderby = "b.weight,b.bid", $isactive = 1 )` get all the blocks that match the supplied parameters get all the blocks that match the supplied parameters This is added back in for backwards compatibility. Note - this only selects blocks form the system module Deprecated Use getObjects() instead Parameters `$groupid` sideblock - left 1: sideblock - right 2: sideblock - left and right 3: centerblock - left 4: centerblock - right 5: centerblock - center 6: centerblock - left, right, center `$asobject` (can be an array) `$side` not visible 1: visible `$visible` of the blocks `$orderby` `$isactive` Returns array of block objects

Methods inherited from icms_ipf_Handler
`addEventHook(), addPermission(), convertResultSet(), create(), delete(), deleteAll(), disableEvent(), enableUpload(), executeEvent(), getCount(), getD(), getIdentifierName(), getIdsFromObjectsAsArray(), getImagePath(), getImageUrl(), getList(), getListD(), getModuleConfig(), getModuleInfo(), getModuleItemString(), getObjects(), getObjectsAsArray(), getObjectsD(), getPermissions(), insertD(), query(), setGrantedObjectsCriteria(), setUploaderConfig(), updateAll(), updateCounter()`

Properties inherited from icms_ipf_Handler
`$_allowedMimeTypes, $_disabledEvents, $_eventHooks, $_itemname, $_maxFileSize, $_maxHeight, $_maxWidth, $_moduleName, $_modulePath, $_moduleUrl, $_page, $_uploadPath, $_uploadUrl, $className, $eventArray, $generalSQL, $highlightFields, $identifierName, $keyName, $permissionsArray, $summaryName, $table, $uploadEnabled`

Properties inherited from icms_core_ObjectHandler
`$db`

Packages

Classes

Class icms_view_block_Handler

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Deprecated

Parameters

Returns