Référence de la classe SystemBlockHandler

Graphe d'héritage de SystemBlockHandler:

Graphe de collaboration de SystemBlockHandler:

Fonctions membres publiques
	__construct (XoopsDatabase $db)
	insert (XoopsObject $obj, $force=true)
&	getObjects (CriteriaElement $criteria=null, $id_as_key=false, $as_object=true)
	getAllBlocksByGroup ($groupid, $asobject=true, $side=null, $visible=null, $orderby='b.weight, b.bid', $isactive=1)
	getBlockByPerm ($groupid)
	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)
Fonctions membres publiques hérités de XoopsPersistableObjectHandler
	__construct (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	XoopsPersistableObjectHandler (XoopsDatabase $db=null, $table='', $className='', $keyName='', $identifierName='')
	setHandler ($handler=null, $args=null, $path=null)
	loadHandler ($name, $args=null)
	__call ($name, $args)
	create ($isNew=true)
	get ($id=null, $fields=null)
	delete (XoopsObject $object, $force=false)
	deleteAll (CriteriaElement $criteria=null, $force=true, $asObject=false)
	updateAll ($fieldname, $fieldvalue, CriteriaElement $criteria=null, $force=false)
&	getAll (CriteriaElement $criteria=null, $fields=null, $asObject=true, $id_as_key=true)
	getList (CriteriaElement $criteria=null, $limit=0, $start=0)
&	getIds (CriteriaElement $criteria=null)
&	getByLimit ($limit=0, $start=0, CriteriaElement $criteria=null, $fields=null, $asObject=true)
	getCount (CriteriaElement $criteria=null)
	getCounts (CriteriaElement $criteria=null)
&	getByLink (CriteriaElement $criteria=null, $fields=null, $asObject=true, $field_link=null, $field_object=null)
	getCountByLink (CriteriaElement $criteria=null)
	getCountsByLink (CriteriaElement $criteria=null)
	updateByLink ($data, CriteriaElement $criteria=null)
	deleteByLink (CriteriaElement $criteria=null)
	cleanOrphan ($table_link='', $field_link='', $field_object='')
	synchronization ()
	convertResultSet ($result, $id_as_key=false, $as_object=true)
Fonctions membres publiques hérités de XoopsObjectHandler
	XoopsObjectHandler ($db)
	create ()
	get ($int_id)
	insert (XoopsObject $object)
	delete (XoopsObject $object)

Membres hérités additionnels
Champs de données hérités de XoopsPersistableObjectHandler
	$handler
	$handlers = array('read' => null, 'stats' => null, 'joint' => null, 'write' => null, 'sync' => null)
	$table
	$keyName
	$className
	$identifierName
	$field_link
	$field_object
Champs de données hérités de XoopsObjectHandler
	$db

Documentation des constructeurs et destructeur

__construct()

__construct

(

XoopsDatabase

$db

)

Paramètres

null | XoopsDatabase

$db

Réimplémentée à partir de XoopsObjectHandler.

Documentation des fonctions membres

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 :

getAllBlocksByGroup()

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

get all the blocks that match the supplied parameters

Paramètres

int | int[]	$groupid	groupid (can be an array)
bool	$asobject
int | 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 :

getAllByGroupModule()

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

Paramètres

	$groupid
int	$module_id
bool	$toponlyblock
null	$visible
string	$orderby
int	$isactive

Renvoie

array

getBlockByPerm()

getBlockByPerm

(

$groupid

)

Paramètres

$groupid

Renvoie

array

getNonGroupedBlocks()

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

Paramètres

int	$module_id
bool	$toponlyblock
null	$visible
string	$orderby
int	$isactive

Renvoie

array

getObjects()

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

retrieve array of XoopsBlocks meeting certain conditions

Paramètres

CriteriaElement | CriteriaCompo	$criteria	CriteriaElement with conditions for the blocks
bool	$id_as_key	should the blocks' bid be the key for the returned array?
bool	$as_object	return an array of objects

Renvoie

array XoopsBlocks matching the conditions

Réimplémentée à partir de XoopsPersistableObjectHandler.

Voici le graphe d'appel pour cette fonction :

insert()

insert	(	XoopsObject	$obj,
			$force = true
	)

Paramètres

XoopsObject | SystemBlock

$obj

Renvoie

int|bool object id on success, otherwise false

Réimplémentée à partir de XoopsPersistableObjectHandler.

Voici le graphe d'appel pour cette fonction :

---

La documentation de cette classe a été générée à partir du fichier suivant :

• XoopsCore25-2.5.11-Beta1/htdocs/modules/system/class/block.php