dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | List of all members
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. More...
 
 create (User $user, $notrigger=0)
 Add an action/event into database. More...
 
 add (User $user, $notrigger=0)
 Add an action/event into database. More...
 
 createFromClone ($fuser, $socid)
 Load an object from its id and create a new one in database. More...
 
 fetch ($id, $ref='', $ref_ext='')
 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 ()
 Initialize this->userassigned array with list of id of user assigned to event. More...
 
 delete ($notrigger=0)
 Delete event from database. More...
 
 update ($user, $notrigger=0)
 Update action into database If percentage = 100, on met a jour date 100%. 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 label of status. More...
 
 LibStatut ($percent, $mode, $hidenastatus=0, $datestart='')
 Return label of action status. More...
 
 getNomUrl ($withpicto=0, $maxlength=0, $classname='', $option='', $overwritepicto=0, $notooltip=0)
 Return URL of event Use $this->id, $this->type_code, $this->label and $this->type_label. More...
 
 build_exportfile ($format, $type, $cachedelay, $filename, $filters)
 Export events from database into a cal file. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 hasDelay ()
 Is the action delayed? More...
 
 sendEmailsReminder ()
 Send reminders by emails CAN BE A CRON TASK. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=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. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 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...
 
 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->contactid 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_projet ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. More...
 
 setProject ($projectid)
 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)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id)
 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)
 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)
 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)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1)
 Fetch array of objects linked to current object. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='')
 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)
 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...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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'st possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 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='')
 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...
 
 addThumbs ($file)
 Build thumb. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. 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...
 
 updateExtraField ($key)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='')
 Function to show lines of extrafields with output datas. More...
 
 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...
 
 isDate ($info)
 Function test if type is date. 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...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 Delete object in database. 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...
 

Static Public Member Functions

static getActions ($db, $socid=0, $fk_element=0, $elementtype='', $filter='', $sortfield='a.datep', $sortorder='DESC', $limit=0)
 Load all objects with filters. More...
 
static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty 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 commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Additional Inherited Members

- Public Attributes inherited from CommonObject
 $projet
 
 $note
 
- 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...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage agenda events (actions)

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

Constructor & Destructor Documentation

ActionComm::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

ActionComm::add ( 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
Deprecated:
Use create instead

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

References create().

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

Export events from database into a cal file.

Parameters
string$format'vcal', 'ical/ics', 'rss'
string$type'event' or 'journal'
int$cachedelayDo not rebuild file if date older than cachedelay seconds
string$filenameForce filename
array$filtersArray of filters
Returns
int <0 if error, nb of events in new file if ok

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

References $resql, $title, build_calfile(), build_rssfile(), dol_delete_file(), dol_filemtime(), dol_get_first_day(), dol_get_last_day(), dol_mkdir(), dol_move(), dol_now(), dol_syslog(), and dolGetFirstLastname().

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

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

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

Referenced by add(), and createFromClone().

ActionComm::createFromClone (   $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 454 of file actioncomm.class.php.

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

ActionComm::delete (   $notrigger = 0)

Delete event from database.

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

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

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

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

Load object from database.

Parameters
int$idId of action to get
string$refRef of action to get
string$ref_extRef ext to get
Returns
int <0 if KO, >0 if OK

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

References $resql, dol_syslog(), fetchResources(), and type.

ActionComm::fetch_userassigned ( )

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

Returns
int <0 if KO, >0 if OK

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

References dol_print_error().

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

References $resql, and dol_print_error().

Referenced by createFromClone(), and fetch().

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

Load all objects with filters.

WARNING: This make a fetch on all records instead of making one request with a join.

Parameters
DoliDb$dbDatabase handler
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 or string Error string if KO, array with actions if OK

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

References $resql, dol_syslog(), and if.

Referenced by FormActions\showactions().

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

Return label of status.

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
int$hidenastatus1=Show nothing if status is "Not applicable"
Returns
string String with status

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

References LibStatut().

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

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
int$overwritepicto1=Overwrite picto
int$notooltip1=Disable tooltip
Returns
string Chaine avec URL

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

References dol_trunc(), and img_object().

ActionComm::hasDelay ( )

Is the action delayed?

Returns
bool

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

References dol_now().

ActionComm::info (   $id)

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

Parameters
int$idId de la facture a charger
Returns
void

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

References dol_print_error(), and dol_syslog().

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
void

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

References dol_now().

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

References if, and img_picto().

Referenced by getLibStatut().

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

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

Parameters
User$userObjet user
int$load_state_boardCharge indicateurs this->nb de tableau de bord
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

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

References $resql, dol_print_error(), and img_object().

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

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

References CommonObject\commonReplaceThirdparty().

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

References dol_now(), and dol_syslog().

ActionComm::update (   $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

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

References $resql, CommonObject\call_trigger(), dol_syslog(), and CommonObject\insertExtraFields().


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