Graphe d'héritage de XoopsBlock:

Graphe de collaboration de XoopsBlock:

Fonctions membres publiques
	__construct ($id=null)

	load ($id)

	store ()

	delete ()

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

	buildBlock ()

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

	buildTitle ($originaltitle, $newtitle='')

	isCustom ()

	getOptions ()

	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)

	__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 ()

Fonctions membres publiques hérités de 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='s')

	cleanVars ()

	registerFilter ($filtername)

	_loadFilters ()

	loadFilters ($method)

	xoopsClone ()

	__clone ()

	setErrors ($err_str)

	getErrors ()

	getHtmlErrors ()

	toArray ()

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

static	getByModule ($moduleid, $asobject=true)

Champs de données
	$db

Champs de données hérités de XoopsObject
	$vars = array()

	$cleanVars = array()

	$_isNew = false

	$_isDirty = false

	$_errors = array()

	$_filters = array()

Description détaillée

Class XoopsBlock

Documentation des constructeurs et destructeur

◆ __construct() [1/2]

__construct ( $id = null )

Paramètres

null | array $id

Voici le graphe d'appel pour cette fonction :

◆ __construct() [2/2]

__construct ( $id = null )

constructor

Paramètres

mixed $id

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ bcachetime()

bcachetime ( $format = '' )

Returns Class Base Variable avatar_id

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ bid()

bid ( $format = '' )

Returns Class Base Variable bid

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ block_type()

block_type ( $format = '' )

Returns Class Base Variable block_type

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ buildBlock()

buildBlock ( )

Build Block

Renvoie: unknown

Voici le graphe d'appel pour cette fonction :

◆ buildContent()

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

Paramètres

	$position
string	$content
string	$contentdb

Renvoie: string

◆ buildTitle()

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

Enter description here...

Paramètres

string	$originaltitle
string	$newtitle

Renvoie: string title

◆ c_type()

c_type ( $format = '' )

Returns Class Base Variable c_type

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ content()

content ( $format = '' )

Returns Class Base Variable content

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ countSimilarBlocks()

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

XoopsBlock::countSimilarBlocks()

Paramètres

mixed	$moduleId
mixed	$funcNum
mixed	$showFunc

Renvoie: int

Voici le graphe d'appel pour cette fonction :

◆ delete()

delete ( )

Delete a ID from the database

Renvoie: bool

◆ dirname()

dirname ( $format = '' )

Returns Class Base Variable dirname

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ edit_func()

edit_func ( $format = '' )

Returns Class Base Variable edit_func

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ func_file()

func_file ( $format = '' )

Returns Class Base Variable func_file

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ func_num()

func_num ( $format = '' )

Returns Class Base Variable func_num

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ getAllBlocks()

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

XoopsBlock::getAllBlocks()

Paramètres

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

Renvoie: array

Voici le graphe d'appel pour cette fonction :

◆ 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

Paramètres

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

Renvoie: array of block objects

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ getAllByGroupModule()

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

XoopsBlock::getAllByGroupModule()

Paramètres

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

Renvoie: array

Voici le graphe d'appel pour cette fonction :

◆ getByModule()

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

static

XoopsBlock::getByModule()

Paramètres

mixed	$moduleid
mixed	$asobject

Renvoie: array

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ getContent() [1/2]

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

do stripslashes/htmlspecialchars according to the needed output

Paramètres

string	$format	output use: 's' for Show and 'e' for Edit
string	$c_type	type of block content

Renvoie: string

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ getContent() [2/2]

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

return the content of the block for output

Paramètres

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)

Renvoie: string content for output

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

◆ getNonGroupedBlocks()

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

XoopsBlock::getNonGroupedBlocks()

Paramètres

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

Renvoie: array

Voici le graphe d'appel pour cette fonction :

◆ getOptions() [1/2]

getOptions ( )

XoopsBlock::getOptions()

Renvoie: bool

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

◆ getOptions() [2/2]

getOptions ( )

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

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

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

◆ id()

id ( $format = 'n' )

Returns Class Base Variable bid

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ isactive()

isactive ( $format = '' )

Returns Class Base Variable isactive

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ isCustom() [1/2]

isCustom ( )

XoopsBlock::isCustom()

Renvoie: bool

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ isCustom() [2/2]

isCustom ( )

Renvoie: bool

Réimplémentée dans SystemBlock.

Voici le graphe d'appel pour cette fonction :

◆ last_modified()

last_modified ( $format = '' )

Returns Class Base Variable last_modified

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ load()

load ( $id )

Load $id

Paramètres

int $id

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

◆ mid()

mid ( $format = '' )

Returns Class Base Variable mid

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ name()

name ( $format = '' )

Returns Class Base Variable name

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ options()

options ( $format = '' )

Returns Class Base Variable avatar_id

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ show_func()

show_func ( $format = '' )

Returns Class Base Variable show_func

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ side()

side ( $format = '' )

Returns Class Base Variable side

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ store()

store ( )

Store Block Data to Database

Renvoie: int $id

Voici le graphe d'appel pour cette fonction :

◆ template()

template ( $format = '' )

Returns Class Base Variable template

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ title()

title ( $format = '' )

Returns Class Base Variable title

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ visible()

visible ( $format = '' )

Returns Class Base Variable visible

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

◆ weight()

weight ( $format = '' )

Returns Class Base Variable weight

Paramètres

string $format

Renvoie: mixed

Voici le graphe d'appel pour cette fonction :

Documentation des champs

◆ $db

$db

La documentation de cette classe a été générée à partir des fichiers suivants :

XoopsCore25-2.5.11-Beta1/htdocs/class/xoopsblock.php
XoopsCore25-2.5.11-Beta1/htdocs/kernel/block.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct() [1/2]

◆ __construct() [2/2]

Documentation des fonctions membres

◆ bcachetime()

◆ bid()

◆ block_type()

◆ buildBlock()

◆ buildContent()

◆ buildTitle()

◆ c_type()

◆ content()

◆ countSimilarBlocks()

◆ delete()

◆ dirname()

◆ edit_func()

◆ func_file()

◆ func_num()

◆ getAllBlocks()

◆ getAllBlocksByGroup()

◆ getAllByGroupModule()

◆ getByModule()

◆ getContent() [1/2]

◆ getContent() [2/2]

◆ getNonGroupedBlocks()

◆ getOptions() [1/2]

◆ getOptions() [2/2]

◆ id()

◆ isactive()

◆ isCustom() [1/2]

◆ isCustom() [2/2]

◆ last_modified()

◆ load()

◆ mid()

◆ name()

◆ options()

◆ show_func()

◆ side()

◆ store()

◆ template()

◆ title()

◆ visible()

◆ weight()

Documentation des champs

◆ $db