dolibarr 21.0.0-alpha
box_produits_alerte_stock Class Reference

Class to manage the box to show too low stocks products. More...

Inheritance diagram for box_produits_alerte_stock:
Collaboration diagram for box_produits_alerte_stock:

Public Member Functions

 __construct ($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
 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 to show too low stocks products.

Definition at line 37 of file box_produits_alerte_stock.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
DoliDB$dbDatabase handler
string$paramMore parameters

Reimplemented from ModeleBoxes.

Definition at line 50 of file box_produits_alerte_stock.php.

References getDolGlobalString(), and isVisibleToUserType().

Member Function Documentation

◆ loadBox()

box_produits_alerte_stock::loadBox ( $max = 5)

Load data into info_box_contents array to show array later.

Parameters
int$maxMaximum number of records to load
Returns
void

Reimplemented from ModeleBoxes.

Definition at line 70 of file box_produits_alerte_stock.php.

References getDolGlobalInt(), img_warning(), price(), and price2num().

◆ showBox()

box_produits_alerte_stock::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 240 of file box_produits_alerte_stock.php.


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