Docs For Class XoopsBlock

constructor XoopsBlock [line 41]

XoopsBlock XoopsBlock(
[
$id = null])

Parameters:

$id

[ Top ]

method buildBlock [line 169]

void buildBlock(
)

[ Top ]

method buildContent [line 218]

void buildContent(

$position, [
$content = ""], [
$contentdb = ""])

Parameters:

	$position
	$content
	$contentdb

[ Top ]

method buildTitle [line 228]

void buildTitle(

$originaltitle, [
$newtitle = ""])

Parameters:

	$originaltitle
	$newtitle

[ Top ]

method countSimilarBlocks [line 516]

void countSimilarBlocks(

$moduleId, 
$funcNum, [
$showFunc = null])

Parameters:

	$moduleId
	$funcNum
	$showFunc

[ Top ]

method delete [line 113]

void delete(
)

[ Top ]

method getAllBlocks [line 347]

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

Parameters:

	$rettype
	$side
	$visible
	$orderby
	$isactive

[ Top ]

method getAllBlocksByGroup [line 293]

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

get all the blocks that match the supplied parameters

Tags:

return:

of block objects

Parameters:

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

[ Top ]

method getAllByGroupModule [line 416]

void getAllByGroupModule(

$groupid, [
$module_id = 0], [
$toponlyblock = false], [
$visible = null], [
$orderby = 'b.weight,b.bid'], [
$isactive = 1])

Parameters:

	$groupid
	$module_id
	$toponlyblock
	$visible
	$orderby
	$isactive

[ Top ]

method getByModule [line 396]

void getByModule(

$moduleid, [
$asobject = true])

Parameters:

	$moduleid
	$asobject

[ Top ]

method getContent [line 133]

string getContent(
[$format
$format = 'S'], [$c_type
$c_type = 'T'])

do stripslashes/htmlspecialchars according to the needed output

Parameters:

$format	$format	output use: S for Show and E for Edit
$c_type	$c_type	type of block content

[ Top ]

method getNonGroupedBlocks [line 465]

void getNonGroupedBlocks(
[
$module_id = 0], [
$toponlyblock = false], [
$visible = null], [
$orderby = 'b.weight,b.bid'], [
$isactive = 1])

Parameters:

	$module_id
	$toponlyblock
	$visible
	$orderby
	$isactive

[ Top ]

method getOptions [line 250]

void getOptions(
)

gets html form for editting block options

[ Top ]

method isCustom [line 238]

void isCustom(
)

[ Top ]

method load [line 77]

void load(

$id)

Parameters:

$id

[ Top ]

method store [line 84]

void store(
)

[ Top ]

Class: XoopsBlock

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: XoopsObject

Inherited Methods

Class: XoopsObject

Class Details

Tags:

Class Variables

$db =

Class Methods

constructor XoopsBlock [line 41]

Parameters:

method buildBlock [line 169]

method buildContent [line 218]

Parameters:

method buildTitle [line 228]

Parameters:

method countSimilarBlocks [line 516]

Parameters:

method delete [line 113]

method getAllBlocks [line 347]

Parameters:

method getAllBlocksByGroup [line 293]

Tags:

Parameters:

method getAllByGroupModule [line 416]

Parameters:

method getByModule [line 396]

Parameters:

method getContent [line 133]

Parameters:

method getNonGroupedBlocks [line 465]

Parameters:

method getOptions [line 250]

method isCustom [line 238]

method load [line 77]

Parameters:

method store [line 84]