dolibarr  17.0.3
Public Member Functions | Static Public Member Functions | List of all members
Contact Class Reference

Class to manage contact/addresses. More...

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

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 load_state_board ()
 Load indicators into this->nb for board. More...
 
 create ($user, $notrigger=0)
 Add a contact into database. More...
 
 update ($id, $user=null, $notrigger=0, $action='update', $nosyncuser=0)
 Update informations into database. More...
 
 _load_ldap_dn ($info, $mode=0)
 Retourne chaine DN complete dans l'annuaire LDAP pour l'objet. More...
 
 _load_ldap_info ()
 Initialise tableau info (tableau des attributs LDAP) More...
 
 update_perso ($id, $user=null, $notrigger=0)
 Update field alert birthday. More...
 
 fetch ($id, $user=null, $ref_ext='', $email='', $loadalsoroles=0)
 Load object contact. More...
 
 setGenderFromCivility ()
 Set the property "gender" of this class, based on the property "civility_id" or use property "civility_code" as fallback, when "civility_id" is not available. More...
 
 load_ref_elements ()
 Load number of elements the contact is used as a link for ref_facturation ref_contrat ref_commande (for order and/or shipments) ref_propale. More...
 
 delete ($notrigger=0)
 Delete a contact from database // TODO Add $user as first param. More...
 
 info ($id)
 Charge les informations sur le contact, depuis la base. More...
 
 getNbOfEMailings ()
 Return number of mass Emailing received by this contacts with its email. More...
 
 getNomUrl ($withpicto=0, $option='', $maxlen=0, $moreparam='', $save_lastsearch_value=-1, $notooltip=0, $morecss='')
 Return name of contact with link (and eventually picto) Use $this->id, $this->lastname, $this->firstname, this->civility_id. More...
 
 getCivilityLabel ()
 Return civility label of contact. More...
 
 getLibStatut ($mode)
 Return label of contact status. More...
 
 LibStatut ($status, $mode)
 Renvoi le libelle d'un statut donne. More...
 
 LibPubPriv ($status)
 Return translated label of Public or Private. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 setstatus ($status)
 Change status of a user. More...
 
 setCategories ($categories)
 Sets object to supplied categories. More...
 
 fetchRoles ()
 Fetch roles (default contact of some companies) for the current contact. More...
 
 getContactRoles ($element='')
 Get Contact roles for a thirdparty. More...
 
 updateRoles ()
 Updates all roles (default contact for companies) according to values inside the ->roles array. More...
 
 loadCacheOfProspStatus ($active=1)
 Load array of prospect status. More...
 
 getLibProspLevel ()
 Return prostect level. More...
 
 libProspLevel ($fk_prospectlevel)
 Return label of prospect level. More...
 
 setProspectLevel (User $user)
 Set prospect level. More...
 
 getLibProspCommStatut ($mode=0, $label='')
 Return status of prospect. More...
 
 libProspCommStatut ($statut, $mode=0, $label='', $picto='')
 Return label of a given status. More...
 
 setNoEmail ($no_email)
 Set "blacklist" mailing status. More...
 
 getNoEmail ()
 get "blacklist" mailing status set no_email attribut to 1 or 0 More...
 
- Public Member Functions inherited from CommonObject
 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...
 
 getKanbanView ($option='')
 Return clicable link of object (with eventually picto) 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...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 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 ($val, $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, $notitle=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 $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 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 $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Additional Inherited Members

- Public Attributes inherited from CommonObject
 $projet
 
 $fk_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...
 
 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 contact/addresses.

Definition at line 40 of file contact.class.php.

Constructor & Destructor Documentation

◆ __construct()

Contact::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 337 of file contact.class.php.

Member Function Documentation

◆ _load_ldap_dn()

Contact::_load_ldap_dn (   $info,
  $mode = 0 
)

Retourne chaine DN complete dans l'annuaire LDAP pour l'objet.

Parameters
array$infoInfo string loaded by _load_ldap_info
int$mode0=Return full DN (uid=qqq,ou=xxx,dc=aaa,dc=bbb) 1=Return DN without key inside (ou=xxx,dc=aaa,dc=bbb) 2=Return key only (uid=qqq)
Returns
string DN

Definition at line 748 of file contact.class.php.

◆ _load_ldap_info()

Contact::_load_ldap_info ( )

Initialise tableau info (tableau des attributs LDAP)

Returns
array Tableau info des attributs

Definition at line 771 of file contact.class.php.

◆ create()

Contact::create (   $user,
  $notrigger = 0 
)

Add a contact into database.

Parameters
User$userObject user that create
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 439 of file contact.class.php.

◆ delete()

Contact::delete (   $notrigger = 0)

Delete a contact from database // TODO Add $user as first param.

Parameters
int$notriggerDisable all trigger
Returns
int <0 if KO, >0 if OK

Definition at line 1224 of file contact.class.php.

◆ fetch()

Contact::fetch (   $id,
  $user = null,
  $ref_ext = '',
  $email = '',
  $loadalsoroles = 0 
)

Load object contact.

Parameters
int$idId of contact
User$userLoad also alerts of this user (subscribing to alerts) that want alerts about this contact
string$ref_extExternal reference, not given by Dolibarr
string$emailEmail
int$loadalsorolesLoad also roles. Try to always 0 here and load roles with a separate call of fetchRoles().
Returns
int >0 if OK, <0 if KO or if two records found for same ref or idprof, 0 if not found.

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

◆ fetchRoles()

Contact::fetchRoles ( )

Fetch roles (default contact of some companies) for the current contact.

This load the array ->roles.

Returns
int <0 if KO, Nb of roles found if OK
See also
updateRoles()

Definition at line 1737 of file contact.class.php.

◆ getCivilityLabel()

Contact::getCivilityLabel ( )

Return civility label of contact.

Returns
string Translated name of civility

Definition at line 1521 of file contact.class.php.

◆ getContactRoles()

Contact::getContactRoles (   $element = '')

Get Contact roles for a thirdparty.

Parameters
string$elementElement type
Returns
array|int Array of contact roles or -1
Exceptions
Exception

Definition at line 1782 of file contact.class.php.

◆ getLibProspCommStatut()

Contact::getLibProspCommStatut (   $mode = 0,
  $label = '' 
)

Return status of prospect.

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
string$labelLabel to use for status for added status
Returns
string Libelle

Definition at line 1968 of file contact.class.php.

◆ getLibProspLevel()

Contact::getLibProspLevel ( )

Return prostect level.

Returns
string Libelle

Definition at line 1925 of file contact.class.php.

References libProspLevel().

◆ getLibStatut()

Contact::getLibStatut (   $mode)

Return label of contact status.

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Label of contact status

Definition at line 1540 of file contact.class.php.

◆ getNbOfEMailings()

Contact::getNbOfEMailings ( )

Return number of mass Emailing received by this contacts with its email.

Returns
int Number of EMailings

Definition at line 1389 of file contact.class.php.

◆ getNoEmail()

Contact::getNoEmail ( )

get "blacklist" mailing status set no_email attribut to 1 or 0

Returns
int <0 if KO, >0 if OK

Definition at line 2104 of file contact.class.php.

◆ getNomUrl()

Contact::getNomUrl (   $withpicto = 0,
  $option = '',
  $maxlen = 0,
  $moreparam = '',
  $save_lastsearch_value = -1,
  $notooltip = 0,
  $morecss = '' 
)

Return name of contact with link (and eventually picto) Use $this->id, $this->lastname, $this->firstname, this->civility_id.

Parameters
int$withpictoInclude picto with link (1=picto + name, 2=picto only, -1=photo+name, -2=photo only)
string$optionWhere the link point to
int$maxlenMax length of
string$moreparamAdd more param into URL
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$notooltip1=Disable tooltip
string$morecssAdd more css on link
Returns
string String with URL

Definition at line 1422 of file contact.class.php.

◆ info()

Contact::info (   $id)

Charge les informations sur le contact, depuis la base.

Parameters
int$idId du contact a charger
Returns
void

Definition at line 1348 of file contact.class.php.

◆ initAsSpecimen()

Contact::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

Definition at line 1609 of file contact.class.php.

◆ libProspCommStatut()

Contact::libProspCommStatut (   $statut,
  $mode = 0,
  $label = '',
  $picto = '' 
)

Return label of a given status.

Parameters
int | string$statutId or code for prospection status
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
string$labelLabel to use for status for added status
string$pictoName of image file to show ('filenew', ...) If no extension provided, we use '.png'. Image must be stored into theme/xxx/img directory. Example: picto.png if picto.png is stored into htdocs/theme/mytheme/img Example: picto.png@mymodule if picto.png is stored into htdocs/mymodule/img Example: /mydir/mysubdir/picto.png if picto.png is stored into htdocs/mydir/mysubdir (pictoisfullpath must be set to 1)
Returns
string Libelle du statut

Definition at line 1986 of file contact.class.php.

◆ libProspLevel()

Contact::libProspLevel (   $fk_prospectlevel)

Return label of prospect level.

Parameters
int$fk_prospectlevelProspect level
Returns
string label of level

Definition at line 1936 of file contact.class.php.

Referenced by getLibProspLevel().

◆ LibPubPriv()

Contact::LibPubPriv (   $status)

Return translated label of Public or Private.

Parameters
int$statusType (0 = public, 1 = private)
Returns
string Label translated

Definition at line 1590 of file contact.class.php.

◆ LibStatut()

Contact::LibStatut (   $status,
  $mode 
)

Renvoi le libelle d'un statut donne.

Parameters
int$statusId statut
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle

Definition at line 1553 of file contact.class.php.

◆ load_ref_elements()

Contact::load_ref_elements ( )

Load number of elements the contact is used as a link for ref_facturation ref_contrat ref_commande (for order and/or shipments) ref_propale.

Returns
int <0 if KO, >=0 if OK

Definition at line 1181 of file contact.class.php.

◆ load_state_board()

Contact::load_state_board ( )

Load indicators into this->nb for board.

Returns
int <0 if KO, >0 if OK

Definition at line 390 of file contact.class.php.

◆ loadCacheOfProspStatus()

Contact::loadCacheOfProspStatus (   $active = 1)

Load array of prospect status.

Parameters
int$active1=Active only, 0=Not active only, -1=All
Returns
int <0 if KO, >0 if OK

Definition at line 1901 of file contact.class.php.

◆ replaceThirdparty()

static Contact::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 1721 of file contact.class.php.

References CommonObject\commonReplaceThirdparty().

◆ setCategories()

Contact::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 1707 of file contact.class.php.

◆ setGenderFromCivility()

Contact::setGenderFromCivility ( )

Set the property "gender" of this class, based on the property "civility_id" or use property "civility_code" as fallback, when "civility_id" is not available.

Returns
void

Definition at line 1160 of file contact.class.php.

◆ setNoEmail()

Contact::setNoEmail (   $no_email)

Set "blacklist" mailing status.

Parameters
int$no_email1=Do not send mailing, 0=Ok to recieve mailling
Returns
int <0 if KO, >0 if OK

Definition at line 2047 of file contact.class.php.

◆ setProspectLevel()

Contact::setProspectLevel ( User  $user)

Set prospect level.

Parameters
User$userUtilisateur qui definie la remise
Returns
int <0 if KO, >0 if OK
Deprecated:
Use update function instead

Definition at line 1956 of file contact.class.php.

References update().

◆ setstatus()

Contact::setstatus (   $status)

Change status of a user.

Parameters
int$statusStatus to set
Returns
int <0 if KO, 0 if nothing is done, >0 if OK

Definition at line 1657 of file contact.class.php.

◆ update()

Contact::update (   $id,
  $user = null,
  $notrigger = 0,
  $action = 'update',
  $nosyncuser = 0 
)

Update informations into database.

Parameters
int$idId of contact/address to update
User$userObjet user making change
int$notrigger0=no, 1=yes
string$actionCurrent action for hookmanager
int$nosyncuserNo sync linked user (external users and contacts are linked)
Returns
int <0 if KO, >0 if OK

Definition at line 553 of file contact.class.php.

Referenced by setProspectLevel().

◆ update_perso()

Contact::update_perso (   $id,
  $user = null,
  $notrigger = 0 
)

Update field alert birthday.

Parameters
int$idId of contact
User$userUser asking to change alert or birthday
int$notrigger0=no, 1=yes
Returns
int <0 if KO, >=0 if OK

Definition at line 886 of file contact.class.php.

◆ updateRoles()

Contact::updateRoles ( )

Updates all roles (default contact for companies) according to values inside the ->roles array.

This is called by update of contact.

Returns
float|int
See also
fetchRoles()

Definition at line 1827 of file contact.class.php.


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