ActionComm Class Reference

Class to manage agenda events (actions) More...

Inheritance diagram for ActionComm:

Collaboration diagram for ActionComm:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	create (User $user, $notrigger=0)
	Add an action/event into database.
	createFromClone (User $fuser, $socid)
	Load an object from its id and create a new one in database.
	fetch ($id, $ref='', $ref_ext='', $email_msgid='', $loadresources=1)
	Load object from database.
	fetchResources ()
	Initialize $this->userassigned & this->socpeopleassigned array with list of id of user and contact assigned to event.
	fetch_userassigned ($override=true)
	Initialize this->userassigned array with list of id of user assigned to event.
	delete ($notrigger=0)
	Delete event from database.
	update (User $user, $notrigger=0)
	Update action into database If percentage = 100, on met a jour date 100%.
	getActions ($socid=0, $fk_element=0, $elementtype='', $filter='', $sortfield='a.datep', $sortorder='DESC', $limit=0)
	Load all objects with filters.
	load_board ($user, $load_state_board=0)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	info ($id)
	Charge les informations d'ordre info dans l'objet facture.
	getLibStatut ($mode, $hidenastatus=0)
	Return the label of the status.
	LibStatut ($percent, $mode, $hidenastatus=0, $datestart='')
	Return label of action status.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $maxlength=0, $classname='', $option='', $overwritepicto=0, $notooltip=0, $save_lastsearch_value=-1)
	Return URL of event Use $this->id, $this->type_code, $this->label and $this->type_label.
	getTypePicto ()
	Return Picto of type of event.
	setCategories ($categories)
	Sets object to supplied categories.
	build_exportfile ($format, $type, $cachedelay, $filename, $filters, $exportholiday=0)
	Export events from database into a cal file.
	initAsSpecimen ()
	Initialise an instance with random values.
	hasDelay ()
	Is the action delayed?
	loadReminders ($type='', $fk_user=0, $onlypast=true)
	Load event reminder of events.
	sendEmailsReminder ()
	Send reminders by emails CAN BE A CRON TASK.
	updatePercent ($id, $percent, $usermodid=0)
	Udpate the percent value of a event with the given id.
Public Member Functions inherited from CommonObject
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=false, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='', $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0, $display_type='card')
	Function to show lines of extrafields with output datas.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=false)
	Create object into database.
	fetchCommon ($id, $ref=null, $morewhere='')
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='')
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=false)
	Update object into database.
	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=false)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
static	replaceProduct (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a product id with another one.
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

Public Attributes
	$recurid
	Properties to manage the recurring events.
const	EVENT_TODO = 0
	Typical value for a event that is in a todo state.
const	EVENT_IN_PROGRESS = 50
	Typical value for a event that is in a progress state.
const	EVENT_FINISHED = 100
	Typical value for a event that is in a finished state.
Public Attributes inherited from CommonObject
	$fk_projet
	$note
	$date_modification

Additional Inherited Members
Protected Member Functions inherited from CommonObject
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Class to manage agenda events (actions)

Definition at line 38 of file actioncomm.class.php.

Constructor & Destructor Documentation

__construct()

ActionComm::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in ConferenceOrBooth.

Definition at line 411 of file actioncomm.class.php.

Member Function Documentation

build_exportfile()

ActionComm::build_exportfile	(		$format,
			$type,
			$cachedelay,
			$filename,
			$filters,
			$exportholiday = 0 )

Export events from database into a cal file.

Parameters

string	$format	The format of the export 'vcal', 'ical/ics' or 'rss'
string	$type	The type of the export 'event' or 'journal'
integer	$cachedelay	Do not rebuild file if date older than cachedelay seconds
string	$filename	The name for the exported file.
array	$filters	Array of filters. Example array('notolderthan'=>99, 'year'=>..., 'idfrom'=>..., 'notactiontype'=>'systemauto', 'project'=>123, ...)
integer	$exportholiday	0 = don't integrate holidays into the export, 1 = integrate holidays into the export

Returns

integer -1 = error on build export file, 0 = export okay

Definition at line 1939 of file actioncomm.class.php.

References build_calfile(), build_rssfile(), dol_delete_file(), dol_filemtime(), dol_get_first_day(), dol_get_last_day(), dol_mkdir(), dol_move(), dol_now(), dol_stringtotime(), dol_syslog(), dolChmod(), dolGetFirstLastname(), and fetch_userassigned().

create()

ActionComm::create	(	User	$user,
			$notrigger = 0 )

Add an action/event into database.

$this->type_id OR $this->type_code must be set.

Parameters

User	$user	Object user making action
int	$notrigger	1 = disable triggers, 0 = enable triggers

Returns

int Id of created event, < 0 if KO

Reimplemented in ConferenceOrBooth.

Definition at line 424 of file actioncomm.class.php.

References CommonObject\call_trigger(), dol_htmlcleanlastbr(), dol_now(), dol_syslog(), dol_trunc(), CommonObject\insertExtraFields(), and ref.

Referenced by createFromClone().

createFromClone()

ActionComm::createFromClone	(	User	$fuser,
			$socid )

Load an object from its id and create a new one in database.

Parameters

User	$fuser	Object user making action
int	$socid	Id of thirdparty

Returns

int New id of clone

Definition at line 708 of file actioncomm.class.php.

References CommonObject\call_trigger(), create(), CommonObject\fetch_optionals(), fetchResources(), and CommonObject\setErrorsFromObject().

delete()

ActionComm::delete

(

$notrigger = 0

)

Delete event from database.

Parameters

int

$notrigger

1 = disable triggers, 0 = enable triggers

Returns

int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

Definition at line 1015 of file actioncomm.class.php.

References CommonObject\call_trigger(), CommonObject\deleteExtraFields(), and dol_syslog().

fetch()

ActionComm::fetch	(		$id,
			$ref = '',
			$ref_ext = '',
			$email_msgid = '',
			$loadresources = 1 )

Load object from database.

Parameters

int	$id	Id of action to get
string	$ref	Ref of action to get
string	$ref_ext	Ref ext to get
string	$email_msgid	Email msgid
string	$loadresources	1=Load also resources

Returns

int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

Definition at line 780 of file actioncomm.class.php.

References dol_syslog(), CommonObject\fetch_optionals(), fetchResources(), ref, and type.

Referenced by sendEmailsReminder().

fetch_userassigned()

ActionComm::fetch_userassigned

(

$override = true

)

Initialize this->userassigned array with list of id of user assigned to event.

Parameters

bool

$override

Override $this->userownerid when empty. TODO This should be false by default. True is here to fix corrupted data.

Returns

int <0 if KO, >0 if OK

Definition at line 969 of file actioncomm.class.php.

References dol_print_error().

Referenced by build_exportfile().

fetchResources()

ActionComm::fetchResources

(

)

Initialize $this->userassigned & this->socpeopleassigned array with list of id of user and contact assigned to event.

Returns

int <0 if KO, >0 if OK

Definition at line 923 of file actioncomm.class.php.

References dol_print_error().

Referenced by createFromClone(), and fetch().

getActions()

ActionComm::getActions	(		$socid = 0,
			$fk_element = 0,
			$elementtype = '',
			$filter = '',
			$sortfield = 'a.datep',
			$sortorder = 'DESC',
			$limit = 0 )

Load all objects with filters.

Parameters

int	$socid	Filter by thirdparty
int	$fk_element	Id of element action is linked to
string	$elementtype	Type of element action is linked to
string	$filter	Other filter
string	$sortfield	Sort on this field
string	$sortorder	ASC or DESC
string	$limit	Limit number of answers

Returns

array|string Error string if KO, array with actions if OK

Definition at line 1316 of file actioncomm.class.php.

References dol_syslog().

getLibStatut()

ActionComm::getLibStatut	(		$mode,
			$hidenastatus = 0 )

Return the label of the status.

Parameters

int	$mode	0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Picto+Long label, 7=Very short label+Picto
int	$hidenastatus	1=Show nothing if status is "Not applicable"

Returns

string String with status

Reimplemented in ConferenceOrBooth.

Definition at line 1509 of file actioncomm.class.php.

References LibStatut().

getNomUrl()

ActionComm::getNomUrl	(		$withpicto = 0,
			$maxlength = 0,
			$classname = '',
			$option = '',
			$overwritepicto = 0,
			$notooltip = 0,
			$save_lastsearch_value = -1 )

Return URL of event Use $this->id, $this->type_code, $this->label and $this->type_label.

Parameters

int	$withpicto	0 = No picto, 1 = Include picto into link, 2 = Only picto
int	$maxlength	Max number of charaters into label. If negative, use the ref as label.
string	$classname	Force style class on a link
string	$option	'' = Link to action, 'birthday'= Link to contact, 'holiday' = Link to leave
int	$overwritepicto	1 = Overwrite picto with this one
int	$notooltip	1 = Disable tooltip
int	$save_lastsearch_value	-1 = Auto, 0 = No save of lastsearch_values when clicking, 1 = Save lastsearch_values whenclicking

Returns

string Chaine avec URL

Definition at line 1656 of file actioncomm.class.php.

References dol_escape_htmltag(), dol_textishtml(), dol_trunc(), dolGetFirstLineOfText(), getDolGlobalInt(), img_object(), img_picto(), ref, and yn().

getTooltipContentArray()

ActionComm::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array

$params

params to construct tooltip data

Since

v18

Returns

array

Reimplemented from CommonObject.

Definition at line 1574 of file actioncomm.class.php.

References dol_escape_htmltag(), dol_textishtml(), dolGetFirstLineOfText(), img_picto(), ref, and yn().

getTypePicto()

ActionComm::getTypePicto

(

)

Return Picto of type of event.

Returns

string HTML String

Definition at line 1839 of file actioncomm.class.php.

References img_picto(), and type.

hasDelay()

ActionComm::hasDelay

(

)

Is the action delayed?

Returns

bool

Definition at line 2387 of file actioncomm.class.php.

References dol_now().

info()

ActionComm::info

(

$id

)

Charge les informations d'ordre info dans l'objet facture.

Parameters

int

$id

Id de la facture a charger

Returns

void

Reimplemented in ConferenceOrBooth.

Definition at line 1473 of file actioncomm.class.php.

References dol_print_error(), and dol_syslog().

initAsSpecimen()

ActionComm::initAsSpecimen

(

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns

int >0 if ok

Reimplemented in ConferenceOrBooth.

Definition at line 2314 of file actioncomm.class.php.

References dol_now().

LibStatut()

ActionComm::LibStatut	(		$percent,
			$mode,
			$hidenastatus = 0,
			$datestart = '' )

Return label of action status.

Parameters

int	$percent	Percent
int	$mode	0=Long label, 1=Short label, 2=Picto+Short label, 3=Picto, 4=Picto+Short label, 5=Short label+Picto, 6=Picto+Long label, 7=Very short label+Picto
int	$hidenastatus	1=Show nothing if status is "Not applicable"
int	$datestart	Date start of event

Returns

string Label

Definition at line 1524 of file actioncomm.class.php.

Referenced by getLibStatut().

load_board()

ActionComm::load_board	(		$user,
			$load_state_board = 0 )

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters

User	$user	Objet user
int	$load_state_board	Load indicator array this->nb

Returns

WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 1391 of file actioncomm.class.php.

References dol_print_error(), and img_object().

loadReminders()

ActionComm::loadReminders	(		$type = '',
			$fk_user = 0,
			$onlypast = true )

Load event reminder of events.

Parameters

string	$type	Type of reminder 'browser' or 'email'
int	$fk_user	Id of user
bool	$onlypast	true = get only past reminder, false = get all reminders linked to this

Returns

int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 2405 of file actioncomm.class.php.

References dol_now().

replaceProduct()

static ActionComm::replaceProduct ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a product id with another one.

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old product id
int	$dest_id	New product id

Returns

bool

Definition at line 2370 of file actioncomm.class.php.

References Database\query().

replaceThirdparty()

static ActionComm::replaceThirdparty ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 2353 of file actioncomm.class.php.

References CommonObject\commonReplaceThirdparty().

sendEmailsReminder()

ActionComm::sendEmailsReminder

(

)

Send reminders by emails CAN BE A CRON TASK.

Returns

int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 2466 of file actioncomm.class.php.

References complete_substitutions_array(), dol_now(), dol_syslog(), dol_trunc(), fetch(), CommonObject\fetch_thirdparty(), getCommonSubstitutionArray(), getDolGlobalString(), and make_substitutions().

setCategories()

ActionComm::setCategories

(

$categories

)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters

int[] | int

$categories

Category or categories IDs

Returns

int <0 if KO, >0 if OK

Definition at line 1892 of file actioncomm.class.php.

update()

ActionComm::update	(	User	$user,
			$notrigger = 0 )

Update action into database If percentage = 100, on met a jour date 100%.

Parameters

User	$user	Object user making change
int	$notrigger	1 = disable triggers, 0 = enable triggers

Returns

int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

Definition at line 1113 of file actioncomm.class.php.

References CommonObject\call_trigger(), dol_htmlcleanlastbr(), dol_syslog(), and CommonObject\insertExtraFields().

updatePercent()

ActionComm::updatePercent	(		$id,
			$percent,
			$usermodid = 0 )

Udpate the percent value of a event with the given id.

Parameters

int	$id	The id of the event
int	$percent	The new percent value for the event
int	$usermodid	The user who modified the percent

Returns

int 1 when update of the event was suscessfull, otherwise -1

Definition at line 2644 of file actioncomm.class.php.

---

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

• dolibarr_18.0/htdocs/comm/action/class/actioncomm.class.php