XoopsBlock Class Reference

Inheritance diagram for XoopsBlock:

Public Member Functions
	__construct ($id=null)
	XoopsBlock ($id=null)
&	getContent ($format='S', $c_type='T')
&	buildBlock ()
&	buildContent ($position, $content='', $contentdb='')
&	buildTitle ($originaltitle, $newtitle='')
	isCustom ()
	getOptions ()
	load ($id)
	store ()
	delete ()
&	getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby='b.weight, b.bid', $isactive=1)
&	getAllBlocks ($rettype='object', $side=null, $visible=null, $orderby='side, weight, bid', $isactive=1)
&	getByModule ($moduleid, $asobject=true)
&	getAllByGroupModule ($groupid, $module_id=0, $toponlyblock=false, $visible=null, $orderby='b.weight, b.bid', $isactive=1)
&	getBlocks ($groupid, $mid=false, $blockFlag=SHOW_BLOCK_ALL, $orderby='b.weight, b.bid')
&	getNonGroupedBlocks ($module_id=0, $toponlyblock=false, $visible=null, $orderby='b.weight, b.bid', $isactive=1)
	countSimilarBlocks ($moduleId, $funcNum, $showFunc=null)
Public Member Functions inherited from XoopsObject
	__construct ()
	setNew ()
	unsetNew ()
	isNew ()
	setDirty ()
	unsetDirty ()
	isDirty ()
	initVar ($key, $data_type, $value=null, $required=false, $maxlength=null, $options='')
	assignVar ($key, $value)
	assignVars ($var_arr)
	setVar ($key, $value, $not_gpc=false)
	setVars ($var_arr, $not_gpc=false)
	setFormVars ($var_arr=null, $pref='xo_', $not_gpc=false)
&	getVars ()
&	getVar ($key, $format='s')
	getShow ($key)
	set ($key, $value)
	get ($key)
	getProperty ($key)
	getProperties ()
	cleanVars ()
	registerFilter ($filtername)
	_loadFilters ()
&	xoopsClone ()
	setErrors ($err_str)
	getErrors ()
	getHtmlErrors ()
Public Member Functions inherited from AbstractXoopsObject
	initVar ($key, $data_type, $default, $required, $size)

Static Public Member Functions
static &	sGetByModule ($moduleid, $asobject=true)

Data Fields
	$mBlockFlagMapping = []
Data Fields inherited from XoopsObject
	$vars = []
	$cleanVars = []
	$_isNew = false
	$_isDirty = false
	$_errors = []
	$_filters = []

Detailed Description

Definition at line 31 of file block.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$id = null

)

Parameters

mixed

$id

Definition at line 38 of file block.php.

Member Function Documentation

buildBlock()

& buildBlock

(

)

Definition at line 146 of file block.php.

buildContent()

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

Definition at line 194 of file block.php.

buildTitle()

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

Definition at line 205 of file block.php.

countSimilarBlocks()

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

Definition at line 321 of file block.php.

delete()

delete

(

)

Definition at line 277 of file block.php.

getAllBlocks()

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

Definition at line 288 of file block.php.

getAllBlocksByGroup()

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

Definition at line 282 of file block.php.

getAllByGroupModule()

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

Definition at line 303 of file block.php.

getBlocks()

& getBlocks	(		$groupid,
			$mid = false,
			$blockFlag = SHOW_BLOCK_ALL,
			$orderby = 'b.weight,
		b.bid'	)

Definition at line 309 of file block.php.

getByModule()

& getByModule	(		$moduleid,
			$asobject = true )

Definition at line 299 of file block.php.

getContent()

& getContent	(		$format = 'S',
			$c_type = 'T' )

return the content of the block for output

[ToDo] Why does this function return reference? Perhaps, it isn't needed even if it's at compatibility also.

Parameters

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

Returns

string content for output

Definition at line 107 of file block.php.

getNonGroupedBlocks()

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

Definition at line 315 of file block.php.

getOptions()

getOptions

(

)

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

Returns

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

Definition at line 228 of file block.php.

isCustom()

isCustom

(

)

Definition at line 215 of file block.php.

load()

load

(

$id

)

Definition at line 257 of file block.php.

sGetByModule()

static & sGetByModule ( $moduleid, $asobject = true )

static

Definition at line 294 of file block.php.

store()

store

(

)

Definition at line 267 of file block.php.

XoopsBlock()

XoopsBlock

(

$id = null

)

Definition at line 86 of file block.php.

Field Documentation

$mBlockFlagMapping

$mBlockFlagMapping = []

Definition at line 33 of file block.php.

---

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

• html/kernel/block.php