dolibarr  21.0.0-alpha
Static Public Member Functions | List of all members
InfoBox Class Reference

Class to manage boxes on pages. More...

Static Public Member Functions

static getListOfPagesForBoxes ()
 Name of positions (See below) More...
 
static listBoxes ($dbs, $mode, $zone, $user=null, $excludelist=array(), $includehidden=1)
 Return array of boxes qualified for area and user. More...
 
static saveboxorder ($dbs, $zone, $boxorder, $userid=0)
 Save order of boxes for area and user. More...
 

Detailed Description

Class to manage boxes on pages.

This is an utility class (all is static)

Definition at line 29 of file infobox.class.php.

Member Function Documentation

◆ getListOfPagesForBoxes()

static InfoBox::getListOfPagesForBoxes ( )
static

Name of positions (See below)

Returns
string[] Array with list of zones

Definition at line 36 of file infobox.class.php.

◆ listBoxes()

static InfoBox::listBoxes (   $dbs,
  $mode,
  $zone,
  $user = null,
  $excludelist = array(),
  $includehidden = 1 
)
static

Return array of boxes qualified for area and user.

Parameters
DoliDB$dbsDatabase handler
string$mode'available' or 'activated'
int$zoneName or area (-1 for all, 0 for Homepage, 1 for Accountancy, 2 for xxx, ...)
User | null$userObject user to filter
array$excludelistArray of box id (box.box_id = boxes_def.rowid) to exclude
int$includehiddenInclude also hidden boxes
Returns
array Array of boxes

Definition at line 94 of file infobox.class.php.

◆ saveboxorder()

static InfoBox::saveboxorder (   $dbs,
  $zone,
  $boxorder,
  $userid = 0 
)
static

Save order of boxes for area and user.

Parameters
DoliDB$dbsDatabase handler
int$zoneName of area (0 for Homepage, ...)
string$boxorderList of boxes with correct order 'A:123,456,...-B:789,321...'
int$useridId of user
Returns
int Return integer <0 if KO, 0=Nothing done, > 0 if OK

Definition at line 224 of file infobox.class.php.


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