dolibarr  18.0.0-alpha
Public Member Functions | List of all members
mymodulewidget1 Class Reference

Class to manage the box. More...

Inheritance diagram for mymodulewidget1:
Inheritance graph
[legend]
Collaboration diagram for mymodulewidget1:
Collaboration graph
[legend]

Public Member Functions

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

Additional Inherited Members

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

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$dbDatabase handler
string$paramMore parameters

Definition at line 92 of file mymodulewidget1.php.

Member Function Documentation

◆ loadBox()

array Contents informations Usually created at runtime by mymodulewidget1::loadBox (   $max = 5)

Load data into info_box_contents array to show array later.

Called by Dolibarr before displaying the box.

Parameters
int$maxMaximum number of records to load
Returns
void

Definition at line 114 of file mymodulewidget1.php.

◆ showBox()

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

Method to show box.

Called by Dolibarr eatch time it wants to display the box.

Parameters
array$headArray with properties of box title
array$contentsArray with properties of box lines
int$nooutputNo print, only return string
Returns
string

Reimplemented from ModeleBoxes.

Definition at line 211 of file mymodulewidget1.php.


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