CActionComm Class Reference

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

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

Detailed Description

Class to manage different types of events.

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

Constructor & Destructor Documentation

__construct()

CActionComm::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

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

Member Function Documentation

fetch()

CActionComm::fetch

(

$id

)

Load action type from database.

Parameters

int | string

$id

id or code of action type to read

Returns

int 1=ok, 0=not found, -1=error

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

References dol_syslog(), and type.

getNomUrl()

CActionComm::getNomUrl

(

$withpicto = 0

)

Return name of action type as a label translated.

Parameters

int

$withpicto

0=No picto, 1=Include picto into link, 2=Picto only

Returns

string|-1 Label of action type, or -1 if error

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

liste_array()

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

	''|int<0,1>	$active 1 or 0 to filter on event state active or not ('' by default = no filter)
	'id'|'code'|'all'	$idorcode 'id' or 'code' or 'all'
string	$excludetype	Type to exclude ('system' or 'systemauto')
	int<-2,1>	$onlyautoornot 1=Group all type AC_XXX into 1 line AC_MANUAL. 0=Keep details of type, -1 or -2=Keep details and add a combined line per calendar (Default, Auto, BoothConf, ...)
string	$morefilter	Add more SQL filter
	int<0,1>	$shortlabel 1=Get short label instead of long label

Returns

int<-1,-1>|array{id:array<int,string>,code:array<string,string>,all:array<string,array{id:string,label:string,type:string,color:mixed,picto:string}>,AC_OTH_AUTO?: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 160 of file cactioncomm.class.php.

References dol_syslog(), getDolGlobalString(), and liste_array().

Referenced by liste_array().

---

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

• dolibarr_dev/htdocs/comm/action/class/cactioncomm.class.php