dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Contact Class Reference

Class to manage contact/addresses. More...

+ Inheritance diagram for Contact:
+ Collaboration diagram for Contact:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 load_state_board ()
 Load indicators into this->nb for board. More...
 
 create ($user)
 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=0, $ref_ext='')
 Load object contact. More...
 
 setGenderFromCivility ()
 Set property ->gender from property ->civility_id. 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)
 Efface le contact de la base. 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)
 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 ($statut, $mode)
 Renvoi le libelle d'un statut donne. More...
 
 LibPubPriv ($statut)
 Return translated label of Public or Private. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 setstatus ($statut)
 Change status of a user. More...
 
 setCategories ($categories)
 Sets object to supplied categories. 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 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...
 

Public Attributes

 $fk_departement
 
 $departement_code
 
 $departement
 
- Public Attributes inherited from CommonObject
 $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...
 
 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 contact/addresses.

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

Constructor & Destructor Documentation

Contact::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

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 454 of file contact.class.php.

Contact::_load_ldap_info ( )

Initialise tableau info (tableau des attributs LDAP)

Returns
array Tableau info des attributs

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

References dol_strlen(), and CommonObject\getFullName().

Contact::create (   $user)

Add a contact into database.

Parameters
User$userObject user that create
Returns
int <0 if KO, >0 if OK

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

References $resql, CommonObject\call_trigger(), dol_now(), dol_syslog(), name, update(), and update_perso().

Contact::delete (   $notrigger = 0)

Efface le contact de la base.

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

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

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

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

Load object contact.

Parameters
int$idid du contact
User$userUtilisateur (abonnes aux alertes) qui veut les alertes de ce contact
string$ref_extExternal reference, not given by Dolibarr
Returns
int -1 if KO, 0 if OK but not found, 1 if OK

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

References $resql, dol_syslog(), CommonObject\fetch_optionals(), and setGenderFromCivility().

Contact::getCivilityLabel ( )

Return civility label of contact.

Returns
string Translated name of civility

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

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 1148 of file contact.class.php.

References LibStatut().

Contact::getNbOfEMailings ( )

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

Returns
int Number of EMailings

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

References $resql, and dol_syslog().

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

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
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
Returns
string String with URL

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

References dol_escape_htmltag(), dol_trunc(), CommonObject\getFullName(), and img_object().

Contact::info (   $id)

Charge les informations sur le contact, depuis la base.

Parameters
int$idId du contact a charger
Returns
void

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

References $resql, and print.

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
void

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

References $resql.

Contact::LibPubPriv (   $statut)

Return translated label of Public or Private.

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

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

Contact::LibStatut (   $statut,
  $mode 
)

Renvoi le libelle d'un statut donne.

Parameters
int$statutId 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 1160 of file contact.class.php.

References img_picto().

Referenced by getLibStatut().

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 824 of file contact.class.php.

References $resql, and dol_syslog().

Contact::load_state_board ( )

Load indicators into this->nb for board.

Returns
int <0 if KO, >0 if OK

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

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

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 1355 of file contact.class.php.

References CommonObject\commonReplaceThirdparty().

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$categories Category or categories IDs

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

Contact::setGenderFromCivility ( )

Set property ->gender from property ->civility_id.

Returns
void

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

Referenced by fetch().

Contact::setstatus (   $statut)

Change status of a user.

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

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

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

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 275 of file contact.class.php.

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

Referenced by create().

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 546 of file contact.class.php.

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

Referenced by create().

Member Data Documentation

Contact::$departement
Deprecated:
See also
state

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

Contact::$departement_code
Deprecated:
See also
state_code

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

Contact::$fk_departement
Deprecated:
See also
state_id

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

Referenced by update().


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