dolibarr  18.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
ActionComm Class Reference

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

Inheritance diagram for ActionComm:
Inheritance graph
[legend]
Collaboration diagram for ActionComm:
Collaboration graph
[legend]

Public Member Functions

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

Static Public Member Functions

static replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a product id with another one. More...
 
- 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. More...
 
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. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

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
 $projet
 
 $fk_projet
 
 $note
 

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. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare a part of the query for insert by returning an array with all properties of object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

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$dbDatabase handler

Reimplemented in ConferenceOrBooth.

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

References db.

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$formatThe format of the export 'vcal', 'ical/ics' or 'rss'
string$typeThe type of the export 'event' or 'journal'
integer$cachedelayDo not rebuild file if date older than cachedelay seconds
string$filenameThe name for the exported file.
array$filtersArray of filters. Example array('notolderthan'=>99, 'year'=>..., 'idfrom'=>..., 'notactiontype'=>'systemauto', 'project'=>123, ...)
integer$exportholiday0 = 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 1942 of file actioncomm.class.php.

◆ 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$userObject user making action
int$notrigger1 = 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.

◆ createFromClone()

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

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

Parameters
User$fuserObject user making action
int$socidId of thirdparty
Returns
int New id of clone

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

◆ delete()

ActionComm::delete (   $notrigger = 0)

Delete event from database.

Parameters
int$notrigger1 = disable triggers, 0 = enable triggers
Returns
int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

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

◆ fetch()

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

Load object from database.

Parameters
int$idId of action to get
string$refRef of action to get
string$ref_extRef ext to get
string$email_msgidEmail msgid
string$loadresources1=Load also resources
Returns
int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

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

◆ fetch_userassigned()

ActionComm::fetch_userassigned (   $override = true)

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

Parameters
bool$overrideOverride $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 973 of file actioncomm.class.php.

References $sql.

◆ 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 927 of file actioncomm.class.php.

References $sql.

◆ getActions()

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

Load all objects with filters.

Parameters
int$socidFilter by thirdparty
int$fk_elementId of element action is linked to
string$elementtypeType of element action is linked to
string$filterOther filter
string$sortfieldSort on this field
string$sortorderASC or DESC
string$limitLimit number of answers
Returns
array|string Error string if KO, array with actions if OK

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

◆ getLibStatut()

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

Return the label of the status.

Parameters
int$mode0=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$hidenastatus1=Show nothing if status is "Not applicable"
Returns
string String with status

Reimplemented in ConferenceOrBooth.

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

◆ 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$withpicto0 = No picto, 1 = Include picto into link, 2 = Only picto
int$maxlengthMax number of charaters into label. If negative, use the ref as label.
string$classnameForce style class on a link
string$option'' = Link to action, 'birthday'= Link to contact, 'holiday' = Link to leave
int$overwritepicto1 = Overwrite picto with this one
int$notooltip1 = 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 1658 of file actioncomm.class.php.

◆ getTooltipContentArray()

ActionComm::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsparams to construct tooltip data
Since
v18
Returns
array

Reimplemented from CommonObject.

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

◆ getTypePicto()

ActionComm::getTypePicto ( )

Return Picto of type of event.

Returns
string HTML String

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

◆ hasDelay()

ActionComm::hasDelay ( )

Is the action delayed?

Returns
bool

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

◆ info()

ActionComm::info (   $id)

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

Parameters
int$idId de la facture a charger
Returns
void

Reimplemented in ConferenceOrBooth.

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

References $sql, 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 2319 of file actioncomm.class.php.

◆ LibStatut()

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

Return label of action status.

Parameters
int$percentPercent
int$mode0=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$hidenastatus1=Show nothing if status is "Not applicable"
int$datestartDate start of event
Returns
string Label

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

◆ load_board()

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

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

Parameters
User$userObjet user
int$load_state_boardLoad indicator array this->nb
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

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

◆ loadReminders()

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

Load event reminder of events.

Parameters
string$typeType of reminder 'browser' or 'email'
int$fk_userId of user
bool$onlypasttrue = 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 2410 of file actioncomm.class.php.

◆ replaceProduct()

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

Function used to replace a product id with another one.

Parameters
DoliDB$dbsDatabase handler
int$origin_idOld product id
int$dest_idNew product id
Returns
bool

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

References $sql.

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 2358 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 2469 of file actioncomm.class.php.

◆ 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$categoriesCategory or categories IDs
Returns
int <0 if KO, >0 if OK

Definition at line 1895 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$userObject user making change
int$notrigger1 = disable triggers, 0 = enable triggers
Returns
int <0 if KO, >0 if OK

Reimplemented in ConferenceOrBooth.

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

◆ updatePercent()

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

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

Parameters
int$idThe id of the event
int$percentThe new percent value for the event
int$usermodidThe user who modified the percent
Returns
int 1 when update of the event was suscessfull, otherwise -1

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

References $sql, and db.


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