dolibarr  7.0.0-beta
Public Member Functions | List of all members
CActionComm Class Reference

Class to manage different types of events. More...

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 fetch ($id)
 Load action type from database. More...
 
 liste_array ($active='', $idorcode='id', $excludetype='', $onlyautoornot=0, $morefilter='', $shortlabel=0)
 Return list of event types: array(id=>label) or array(code=>label) More...
 
 getNomUrl ($withpicto=0)
 Return name of action type as a label translated. More...
 

Detailed Description

Class to manage different types of events.

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

Constructor & Destructor Documentation

CActionComm::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 52 of file cactioncomm.class.php.

Member Function Documentation

CActionComm::fetch (   $id)

Load action type from database.

Parameters
int$idid or code of action type to read
Returns
int 1=ok, 0=not found, -1=error

Definition at line 63 of file cactioncomm.class.php.

References $resql, dol_syslog(), and type.

CActionComm::getNomUrl (   $withpicto = 0)

Return name of action type as a label translated.

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Picto only
Returns
string Label of action type

Definition at line 205 of file cactioncomm.class.php.

CActionComm::liste_array (   $active = '',
  $idorcode = 'id',
  $excludetype = '',
  $onlyautoornot = 0,
  $morefilter = '',
  $shortlabel = 0 
)

Return list of event types: array(id=>label) or array(code=>label)

Parameters
string | int$active1 or 0 to filter on event state active or not ('' by default = no filter)
string$idorcode'id' or 'code'
string$excludetypeType to exclude ('system' or 'systemauto')
int$onlyautoornot1=Group all type AC_XXX into 1 line AC_MANUAL. 0=Keep details of type, -1=Keep details and add a combined line "All manual"
string$morefilterAdd more SQL filter
int$shortlabel1=Get short label instead of long label
Returns
mixed Array of all event types if OK, <0 if KO. Key of array is id or code depending on parameter $idorcode.

Definition at line 113 of file cactioncomm.class.php.

References $resql, and dol_syslog().


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