Overview

Namespaces

  • None
  • Xmf
    • Database
    • Module
      • Helper
    • Template
  • Xoops
    • Auth
    • Core
      • Cache
      • Database
        • Logging
        • Schema
      • Exception
      • Handler
        • Scheme
      • Kernel
        • Dtype
        • Handlers
        • Model
      • Lists
      • Locale
        • Punic
      • Service
        • Contract
      • Session
      • Text
        • Sanitizer
          • Extensions
      • Theme
        • Plugins
    • Form
    • Html
    • Locale
    • Module
      • Helper
      • Plugin

Classes

  • XoopsBlock
  • XoopsBlockHandler
  • XoopsBlockModuleLink
  • XoopsBlockModuleLinkHandler
  • XoopsConfigHandler
  • XoopsConfigItem
  • XoopsConfigItemHandler
  • XoopsConfigOption
  • XoopsConfigOptionHandler
  • XoopsGroup
  • XoopsGroupHandler
  • XoopsGroupPerm
  • XoopsGroupPermHandler
  • XoopsMemberHandler
  • XoopsMembership
  • XoopsMembershipHandler
  • XoopsModule
  • XoopsModuleHandler
  • XoopsOnline
  • XoopsOnlineHandler
  • XoopsPrivateMessage
  • XoopsPrivateMessageHandler
  • XoopsTplFile
  • XoopsTplFileHandler
  • XoopsTplSet
  • XoopsTplSetHandler
  • XoopsUser
  • XoopsUserHandler
  • Overview
  • Namespace
  • Class
  • Tree

Class XoopsBlockHandler

XoopsBlockHandler

Xoops\Core\Kernel\XoopsObjectHandler
Extended by Xoops\Core\Kernel\XoopsPersistableObjectHandler
Extended by Xoops\Core\Kernel\Handlers\XoopsBlockHandler

Direct known subclasses

XoopsBlockHandler
Namespace: Xoops\Core\Kernel\Handlers
Package: Xoops\Core\Kernel
Category: Xoops\Core\Kernel\Handlers\XoopsBlockHandler
Copyright: 2000-2015 XOOPS Project (http://xoops.org)
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Kazumi Ono (AKA onokazu) http://www.myweb.ne.jp/, http://jp.xoops.org/
Author: Gregory Mage (AKA Mage)
Author: trabis lusopoemas@gmail.com
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Kernel/Handlers/XoopsBlockHandler.php
Methods summary
public
# __construct( Xoops\Core\Database\Connection $db = null )

Constructor

Constructor

Parameters

$db
database

Overrides

Xoops\Core\Kernel\XoopsPersistableObjectHandler::__construct()
public integer|false
# insertBlock( Xoops\Core\Kernel\Handlers\XoopsBlock $obj, boolean $force = false )

Insert a block

Insert a block

Parameters

$obj
block object to persist
$force
force insert even in 'safe' requests

Returns

integer|false
id of insert, or false on error
public boolean
# deleteBlock( Xoops\Core\Kernel\Handlers\XoopsBlock $obj )

Delete a ID from the database

Delete a ID from the database

Parameters

$obj
object to delete

Returns

boolean
public Xoops\Core\Kernel\Handlers\XoopsBlock[]
# getDistinctObjects( Xoops\Core\Kernel\CriteriaElement $criteria = null, boolean $id_as_key = false )

retrieve array of XoopsBlock objects meeting certain conditions

retrieve array of XoopsBlock objects meeting certain conditions

Parameters

$criteria
criteria to match
$id_as_key
should the blocks' bid be the key for the returned array?

Returns

Xoops\Core\Kernel\Handlers\XoopsBlock[]
public array
# getNameList( Xoops\Core\Kernel\CriteriaElement $criteria = null )

get a list of blocks matching certain conditions

get a list of blocks matching certain conditions

Parameters

$criteria
conditions to match

Returns

array
array of blocks matching the conditions
public array
# getAllBlocksByGroup( integer|int[] $groupid, boolean $asobject = true, integer $side = null, integer|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
retrieve as objects
$side

values: 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
0: not visible 1: visible
$orderby
order of the blocks
$isactive
1: active or 0:inactive blocks

Returns

array
of block objects
public array
# getAllBlocks( string $rettype = "object", integer $side = null, integer|null $visible = null, string $orderby = "side,weight,bid", integer $isactive = 1 )

getAllBlocks matching selection criteria

getAllBlocks matching selection criteria

Parameters

$rettype
what to return, values can be object, list or id
$side
block location (side)
$visible
null for all, 0 not visible, 1 for visible only
$orderby
comma separated columns to order by
$isactive
1: active or 0:inactive blocks

Returns

array
public array
# getByModule( integer $moduleid, boolean $asobject = true )

get blocks by module id

get blocks by module id

Parameters

$moduleid
module id
$asobject
true to fetch as objects, otherwise associative array

Returns

array
of block information
public array
# getAllByGroupModule( mixed $groupid, integer $module_id = 0, boolean $toponlyblock = false, mixed $visible = null, string $orderby = 'b.weight, m.block_id', integer $isactive = 1 )

XoopsBlock::getAllByGroupModule()

XoopsBlock::getAllByGroupModule()

Parameters

$groupid
int group id, int[] of group ids,
$module_id
module id
$toponlyblock
only for top block
$visible
restrict by visible values
$orderby
comma separated list of columns to order by
$isactive
restrict by isactive values

Returns

array
public array
# getNonGroupedBlocks( integer $module_id = 0, boolean $toponlyblock = false, mixed $visible = null, string $orderby = 'b.weight, m.block_id', integer $isactive = 1 )

XoopsBlock::getNonGroupedBlocks()

XoopsBlock::getNonGroupedBlocks()

Parameters

$module_id
module id
$toponlyblock
only for top block
$visible
restrict by visible values
$orderby
comma separated list of columns to order by
$isactive
restrict by isactive values

Returns

array
public integer
# countSimilarBlocks( integer $moduleId, string $funcNum, string $showFunc = null )

XoopsBlock::countSimilarBlocks()

XoopsBlock::countSimilarBlocks()

Parameters

$moduleId
module id
$funcNum
func number
$showFunc
show function

Returns

integer
count
public string
# buildContent( integer $position, string $content = "", string $contentdb = "" )

Aligns the content of a block

Aligns the content of a block

Parameters

$position

order of content 0 -> content in DB is positioned before the original content 1 -> content in DB is positioned after the original content

$content
content
$contentdb
content from database

Returns

string
public string
# buildTitle( string $originaltitle, string $newtitle = '' )

Enter description here... appears to be unused?

Enter description here... appears to be unused?

Parameters

$originaltitle
original title
$newtitle
new title

Returns

string
title winner of the title war?
public int[]
# getBlockByPerm( null|integer $groupid )

get list of ids of block that a group has permission to views

get list of ids of block that a group has permission to views

Parameters

$groupid
group

Returns

int[]
Methods inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
__call(), cleanOrphan(), create(), delete(), deleteAll(), deleteByLink(), get(), getAll(), getByLink(), getCount(), getCountByLink(), getCounts(), getCountsByLink(), getIds(), getList(), getObjects(), insert(), loadHandler(), setHandler(), synchronization(), updateAll(), updateByLink()
Properties inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
$className, $field_link, $field_object, $handler, $identifierName, $keyName, $keyName_link, $table, $table_link
Properties inherited from Xoops\Core\Kernel\XoopsObjectHandler
$db2
API documentation generated by ApiGen