Inheritance diagram for XoopsBlock:

Collaboration diagram for XoopsBlock:

Public Member Functions
	__construct ($id=null)

	id ($format='n')

	bid ($format='')

	mid ($format='')

	func_num ($format='')

	options ($format='')

	name ($format='')

	title ($format='')

	content ($format='')

	side ($format='')

	weight ($format='')

	visible ($format='')

	block_type ($format='')

	c_type ($format='')

	isactive ($format='')

	dirname ($format='')

	func_file ($format='')

	show_func ($format='')

	edit_func ($format='')

	template ($format='')

	bcachetime ($format='')

	last_modified ($format='')

	getContent ($format='s', $c_type='T')

	getOptions ()

	isCustom ()

	buildBlock ()

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

	buildTitle ($originaltitle, $newtitle='')

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

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

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

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

Public Member Functions inherited from XoopsObject
	__construct ()

	XoopsObject ()

	setNew ()

	unsetNew ()

	isNew ()

	setDirty ()

	unsetDirty ()

	isDirty ()

	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='', $enumerations='')

	assignVar ($key, $value)

	assignVars ($var_arr)

	setVar ($key, $value, $not_gpc=false)

	setVars ($var_arr, $not_gpc=false)

	destroyVars ($var)

	destoryVars ($var)

	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)

&	getVars ()

	getValues ($keys=null, $format='s', $maxDepth=1)

	getVar ($key, $format=null)

	cleanVars ()

	registerFilter ($filtername)

	_loadFilters ()

	loadFilters ($method)

	xoopsClone ()

	__clone ()

	setErrors ($err_str)

	getErrors ()

	getHtmlErrors ()

	toArray ()

Static Public Member Functions
static	getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby='b.weight, b.bid', $isactive=1)

static	getByModule ($moduleid, $asobject=true)

Additional Inherited Members
Data Fields inherited from XoopsObject
	$vars = array()

	$cleanVars = array()

	$_isNew = false

	$_isDirty = false

	$_errors = array()

	$_filters = array()

Constructor & Destructor Documentation

◆ __construct()

__construct ( $id = null )

constructor

Parameters

mixed $id

Here is the call graph for this function:

Member Function Documentation

◆ bcachetime()

bcachetime ( $format = '' )

Returns Class Base Variable avatar_id

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ bid()

bid ( $format = '' )

Returns Class Base Variable bid

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ block_type()

block_type ( $format = '' )

Returns Class Base Variable block_type

Vaild block_type values are: S - generated by system module M - generated by a non-system module C - Custom block D - cloned system/module block E - cloned custom block, DON'T use it

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ buildBlock()

buildBlock ( )

Build Block

Returns: mixed

Deprecated:

Here is the call graph for this function:

◆ buildContent()

buildContent	(	$position,
		$content = `''`,
		$contentdb = `''`
	)

Parameters

	$position
string	$content
string	$contentdb

Returns: string

Deprecated:

◆ buildTitle()

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

Enter description here...

Parameters

string	$originaltitle
string	$newtitle

Returns: string title

Deprecated:

◆ c_type()

c_type ( $format = '' )

Returns Class Base Variable c_type

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ content()

content ( $format = '' )

Returns Class Base Variable content

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ countSimilarBlocks()

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

XoopsBlock::countSimilarBlocks()

Parameters

mixed	$moduleId
mixed	$funcNum
mixed	$showFunc

Returns: int

Deprecated:

Here is the call graph for this function:

◆ dirname()

dirname ( $format = '' )

Returns Class Base Variable dirname

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ edit_func()

edit_func ( $format = '' )

Returns Class Base Variable edit_func

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ func_file()

func_file ( $format = '' )

Returns Class Base Variable func_file

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ func_num()

func_num ( $format = '' )

Returns Class Base Variable func_num

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ getAllBlocks()

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

XoopsBlock::getAllBlocks()

Parameters

string	$rettype
mixed	$side
mixed	$visible
string	$orderby
integer	$isactive

Returns: array

Deprecated:

Here is the call graph for this function:

◆ getAllBlocksByGroup()

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

static

get all the blocks that match the supplied parameters

Parameters

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

Returns: array of block objects

Deprecated:

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllByGroupModule()

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
mixed	$toponlyblock
mixed	$visible
string	$orderby
integer	$isactive

Returns: array

Deprecated:: (This also appears, dead, in XoopsBlockHandler)

Here is the call graph for this function:

◆ getByModule()

static getByModule	(	$moduleid,
		$asobject = `true`
	)

static

XoopsBlock::getByModule()

Parameters

mixed	$moduleid
mixed	$asobject

Returns: array

Deprecated:: (This also appears, dead, in XoopsBlockHandler)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContent()

getContent	(	$format = `'s'`,
		$c_type = `'T'`
	)

return the content of the block for output

Parameters

string	$format
string	$c_type	type of content Valid values for the type of content: H : custom HTML block P : custom PHP block S : use text sanitizer (smilies enabled) T : use text sanitizer (smilies disabled)

Returns: string content for output

Reimplemented in SystemBlock.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNonGroupedBlocks()

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

XoopsBlock::getNonGroupedBlocks()

Parameters

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

Returns: array

Deprecated:

Here is the call graph for this function:

◆ getOptions()

getOptions ( )

(HTML-) form for setting the options of the block

Returns: string HTML for the form, FALSE if not defined for this block

Reimplemented in SystemBlock.

Here is the call graph for this function:

◆ id()

id ( $format = 'n' )

Returns Class Base Variable bid

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ isactive()

isactive ( $format = '' )

Returns Class Base Variable isactive

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ isCustom()

isCustom ( )

Returns: bool

Reimplemented in SystemBlock.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ last_modified()

last_modified ( $format = '' )

Returns Class Base Variable last_modified

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ mid()

mid ( $format = '' )

Returns Class Base Variable mid

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ name()

name ( $format = '' )

Returns Class Base Variable name

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ options()

options ( $format = '' )

Returns Class Base Variable avatar_id

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ show_func()

show_func ( $format = '' )

Returns Class Base Variable show_func

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ side()

side ( $format = '' )

Returns Class Base Variable side

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ template()

template ( $format = '' )

Returns Class Base Variable template

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ title()

title ( $format = '' )

Returns Class Base Variable title

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ visible()

visible ( $format = '' )

Returns Class Base Variable visible

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

◆ weight()

weight ( $format = '' )

Returns Class Base Variable weight

Parameters

string $format

Returns: mixed

Here is the call graph for this function:

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ bcachetime()

◆ bid()

◆ block_type()

◆ buildBlock()

◆ buildContent()

◆ buildTitle()

◆ c_type()

◆ content()

◆ countSimilarBlocks()

◆ dirname()

◆ edit_func()

◆ func_file()

◆ func_num()

◆ getAllBlocks()

◆ getAllBlocksByGroup()

◆ getAllByGroupModule()

◆ getByModule()

◆ getContent()

◆ getNonGroupedBlocks()

◆ getOptions()

◆ id()

◆ isactive()

◆ isCustom()

◆ last_modified()

◆ mid()

◆ name()

◆ options()

◆ show_func()

◆ side()

◆ template()

◆ title()

◆ visible()

◆ weight()