ModeleBoxes Class Reference

Class ModeleBoxes. More...

Inheritance diagram for ModeleBoxes:

Public Member Functions
	__construct ($db, $param= '')
	Constructor. More...
	error ()
	Return last error message. More...
	fetch ($rowid)
	Load a box line from its rowid. More...
	showBox ($head=null, $contents=null, $nooutput=0)
	Standard method to show a box (usage by boxes not mandatory, a box can still use its own showBox function) More...

Static Public Member Functions
static	getWidgetsList ($forcedirwidget=null)
	Return list of widget. More...

Detailed Description

Class ModeleBoxes.

Boxes parent class

Definition at line 34 of file modules_boxes.php.

Constructor & Destructor Documentation

ModeleBoxes::__construct	(		$db,
			$param = ''
	)

Constructor.

Parameters

DoliDB	$db	Database handler
string	$param	More parameters

Definition at line 118 of file modules_boxes.php.

References db.

Member Function Documentation

ModeleBoxes::error

(

)

Return last error message.

Returns

string Error message

Definition at line 128 of file modules_boxes.php.

ModeleBoxes::fetch

(

$rowid

)

Load a box line from its rowid.

Parameters

int

$rowid

Row id to load

Returns

int <0 if KO, >0 if OK

Definition at line 141 of file modules_boxes.php.

References $resql, db, dol_syslog(), and rowid.

static ModeleBoxes::getWidgetsList (   $forcedirwidget = null )

static

Return list of widget.

Function used by admin page htdoc/admin/widget. List is sorted by widget filename so by priority to run.

Parameters

array

$forcedirwidget

null=All default directories. This parameter is used by modulebuilder module only.

Returns

array Array list of widget

Definition at line 371 of file modules_boxes.php.

References dol_buildpath(), dol_osencode(), img_object(), img_picto(), and print.

ModeleBoxes::showBox	(		$head = null,
			$contents = null,
			$nooutput = 0
	)

Standard method to show a box (usage by boxes not mandatory, a box can still use its own showBox function)

Parameters

array	$head	Array with properties of box title
array	$contents	Array with properties of box lines
int	$nooutput	No print, only return string

Returns

string

Definition at line 181 of file modules_boxes.php.

References dol_cache_refresh(), dol_escape_htmltag(), dol_filecache(), dol_readcachefile(), dol_syslog(), dol_trunc(), img_object(), img_picto(), and print.

---

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

• htdocs/core/boxes/modules_boxes.php