mymodulewidget1 Class Reference

Class to manage the box. More...

Inheritance diagram for mymodulewidget1:

Collaboration diagram for mymodulewidget1:

Public Member Functions
	__construct (DoliDB $db, $param='')
	Constructor.
	loadBox ($max=5)
	Load data into info_box_contents array to show array later.
	showBox ($head=null, $contents=null, $nooutput=0)
	Method to show box.
Public Member Functions inherited from ModeleBoxes
	__construct ($db, $param='')
	Constructor.
	error ()
	Return last error message.
	fetch ($rowid)
	Load a box line from its rowid.

Additional Inherited Members
Static Public Member Functions inherited from ModeleBoxes
static	getWidgetsList ($forcedirwidget=null)
	Return list of widget.

Detailed Description

Class to manage the box.

Warning: for the box to be detected correctly by dolibarr, the filename should be the lowercase classname

Definition at line 37 of file mymodulewidget1.php.

Constructor & Destructor Documentation

__construct()

mymodulewidget1::__construct	(	DoliDB	$db,
			$param = '' )

Constructor.

Parameters

DoliDB	$db	Database handler
string	$param	More parameters

Definition at line 77 of file mymodulewidget1.php.

Member Function Documentation

loadBox()

mymodulewidget1::loadBox

(

$max = 5

)

Load data into info_box_contents array to show array later.

Called by Dolibarr before displaying the box.

Parameters

int<0,max>

$max Maximum number of records to load

Returns

void

Reimplemented from ModeleBoxes.

Definition at line 97 of file mymodulewidget1.php.

showBox()

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

Method to show box.

Called when the box needs to be displayed.

Parameters

?array<array{text?:string,sublink?:string,subtext?:string,subpicto?:?string,picto?:string,nbcol?:int,limit?:int,subclass?:string,graph?:int<0,1>,target?:string}>	$head Array with properties of box title
?array<array{tr?:string,td?:string,target?:string,text?:string,text2?:string,textnoformat?:string,tooltip?:string,logo?:string,url?:string,maxlength?:int,asis?:int<0,1>}>	$contents Array with properties of box lines
int<0,1>	$nooutput No print, only return string

Returns

string

Reimplemented from ModeleBoxes.

Definition at line 199 of file mymodulewidget1.php.

---

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

• dolibarr_21.0/htdocs/modulebuilder/template/core/boxes/mymodulewidget1.php