Inheritance diagram for XoopsBlockHandler:

Public Member Functions
	__construct (Connection $db=null)

	buildContent ($position, $content="", $contentdb="")

	buildTitle ($originaltitle, $newtitle= '')

	countSimilarBlocks ($moduleId, $funcNum, $showFunc=null)

	deleteBlock (XoopsBlock &$obj)

	getAllBlocks ($rettype="object", $side=null, $visible=null, $orderby="side,weight,bid", $isactive=1)

	getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby="b.weight,b.bid", $isactive=1)

	getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)

	getBlockByPerm ($groupid)

	getByModule ($moduleid, $asobject=true)

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

	getNameList (CriteriaElement $criteria=null)

	getNonGroupedBlocks ($module_id=0, $toponlyblock=false, $visible=null, $orderby= 'b.weight, m.block_id', $isactive=1)

	insertBlock (XoopsBlock &$obj, $force=false)

Public Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__call ($name, $args)

	cleanOrphan ($table_link= '', $field_link= '', $field_object= '')

	create ($isNew=true)

	delete (XoopsObject $object, $force=false)

	deleteAll (CriteriaElement $criteria, $force=true, $asObject=false)

	deleteByLink (CriteriaElement $criteria=null)

	get ($id=null, $fields=null)

	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)

	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)

	getCount (CriteriaElement $criteria=null)

	getCountByLink (CriteriaElement $criteria=null)

	getCounts (CriteriaElement $criteria=null)

	getCountsByLink (CriteriaElement $criteria=null)

	getIds (CriteriaElement $criteria=null)

	getList (CriteriaElement $criteria=null, $limit=0, $start=0)

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

	insert (XoopsObject $object, $force=true)

	loadHandler ($name, $args=null)

	setHandler ($handler=null, $args=null, $path=null)

	synchronization ($table_link= '', $field_link= '', $field_object= '')

	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria, $force=false)

	updateByLink ($data, CriteriaElement $criteria=null)

Public Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	create ()

	delete (XoopsObject $object, $force=true)

	get ($int_id)

	insert (XoopsObject $object, $force=true)

Additional Inherited Members
Public Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$className

	$field_link

	$field_object

	$identifierName

	$keyName

	$keyName_link

	$table

	$table_link

Public Attributes inherited from Xoops\Core\Kernel\XoopsObjectHandler
	$db2

Protected Member Functions inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	__construct (Connection $db=null, $table= '', $className= '', $keyName= '', $identifierName= '')

Protected Member Functions inherited from Xoops\Core\Kernel\XoopsObjectHandler
	__construct (Connection $db=null)

Protected Attributes inherited from Xoops\Core\Kernel\XoopsPersistableObjectHandler
	$handler

Detailed Description

Definition at line 415 of file block.php.

Constructor & Destructor Documentation

XoopsBlockHandler::__construct ( Connection $db = null )

Constructor

Parameters

Connection | null $db Xoops\Core\Database\Connection

Definition at line 422 of file block.php.

Member Function Documentation

XoopsBlockHandler::buildContent	(	$position,
		$content = `""`,
		$contentdb = `""`
	)

Aligns the content of a block If position is 0, content in DB is positioned before the original content If position is 1, content in DB is positioned after the original content

Parameters

integer	$position
string	$content
string	$contentdb

Returns: string

Definition at line 902 of file block.php.

References $content.

XoopsBlockHandler::buildTitle	(	$originaltitle,
		$newtitle = `''`
	)

Enter description here...

Parameters

string	$originaltitle
string	$newtitle

Returns: string title

Definition at line 922 of file block.php.

XoopsBlockHandler::countSimilarBlocks	(	$moduleId,
		$funcNum,
		$showFunc = `null`
	)

XoopsBlock::countSimilarBlocks()

Parameters

int	$moduleId
string	$funcNum
string	$showFunc

Returns: int

Definition at line 862 of file block.php.

References $count, and $result.

XoopsBlockHandler::deleteBlock ( XoopsBlock & $obj )

Delete a ID from the database

Parameters

XoopsBlock $obj

Returns: bool

Definition at line 444 of file block.php.

References Xoops\Core\Kernel\XoopsObject\getVar().

Here is the call graph for this function:

XoopsBlockHandler::getAllBlocks	(	$rettype = `"object"`,
		$side = `null`,
		$visible = `null`,
		$orderby = `"side,weight,bid"`,
		$isactive = `1`
	)

Parameters

string	$rettype
boolean	$side
null	$visible
string	$orderby
int	$isactive

Returns: array

Definition at line 601 of file block.php.

References $result, $visible, XOOPS_CENTERBLOCK_ALL, and XOOPS_SIDEBLOCK_BOTH.

XoopsBlockHandler::getAllBlocksByGroup	(	$groupid,
		$asobject = `true`,
		$side = `null`,
		$visible = `null`,
		$orderby = `"b.weight,b.bid"`,
		$isactive = `1`
	)

get all the blocks that match the supplied parameters

Parameters

int	$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
bool	$asobject
int \| array	$groupid	groupid (can be an array)
int \| null	$visible	0: not visible 1: visible
string	$orderby	order of the blocks
int	$isactive

Returns: array of block objects

Definition at line 537 of file block.php.

References $result, $visible, XOOPS_CENTERBLOCK_ALL, and XOOPS_SIDEBLOCK_BOTH.

XoopsBlockHandler::getAllByGroupModule	(		$groupid,
			$module_id = `0`,
			$toponlyblock = `false`,
			$visible = `null`,
			$orderby = `'b.weight`,
		m.block_id'	,
			$isactive = `1`
	)

XoopsBlock::getAllByGroupModule()

Parameters

mixed	$groupid
integer	$module_id
boolean	$toponlyblock
mixed	$visible
string	$orderby
integer	$isactive

Returns: array

Definition at line 694 of file block.php.

References $module_id, $result, and $visible.

XoopsBlockHandler::getBlockByPerm ( $groupid )

Parameters

null | integer $groupid

Returns: array

Definition at line 938 of file block.php.

References $result.

XoopsBlockHandler::getByModule	(	$moduleid,
		$asobject = `true`
	)

Parameters

int	$moduleid
bool	$asobject

Returns: array

Definition at line 658 of file block.php.

References $result.

Referenced by xoops_module_install_system().

Here is the caller graph for this function:

XoopsBlockHandler::getDistinctObjects	(	CriteriaElement	$criteria = `null`,
			$id_as_key = `false`
	)

retrieve array of XoopsBlocks meeting certain conditions

Parameters

CriteriaElement \| null	$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

Definition at line 470 of file block.php.

References $criteria, and $result.

XoopsBlockHandler::getNameList ( CriteriaElement $criteria = null )

get a list of blocks matching certain conditions

Parameters

CriteriaElement | null $criteria conditions to match

Returns: array array of blocks matching the conditions

Definition at line 509 of file block.php.

References $criteria, $i, and $name.

XoopsBlockHandler::getNonGroupedBlocks	(		$module_id = `0`,
			$toponlyblock = `false`,
			$visible = `null`,
			$orderby = `'b.weight`,
		m.block_id'	,
			$isactive = `1`
	)

XoopsBlock::getNonGroupedBlocks()

Parameters

integer	$module_id
boolean	$toponlyblock
boolean	$visible
string	$orderby
integer	$isactive

Returns: array

Definition at line 779 of file block.php.

References $module_id, $result, $sql, and $visible.

XoopsBlockHandler::insertBlock	(	XoopsBlock &	$obj,
			$force = `false`
	)

Parameters

XoopsBlock	$obj
bool	$force

Returns: mixed

Definition at line 432 of file block.php.

References Xoops\Core\Kernel\XoopsObject\setVar().

Here is the call graph for this function:

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

C:/usr64/htdocs/kernel/block.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation