Contact Class Reference

Class to manage contact/addresses. More...

Inheritance diagram for Contact:

Collaboration diagram for Contact:

Public Member Functions
	__construct ($db)
	Constructor.
	loadStateBoard ()
	Load indicators into this->nb for board.
	create ($user, $notrigger=0)
	Add a contact into database.
	update ($id, $user=null, $notrigger=0, $action='update', $nosyncuser=0)
	Update information into database.
	_load_ldap_dn ($info, $mode=0)
	Return DN string complete in the LDAP directory for the object.
	_load_ldap_info ()
	Initialize info table (LDAP attributes table)
	update_perso ($id, $user=null, $notrigger=0)
	Update field alert birthday.
	fetch ($id, $user=null, $ref_ext='', $email='', $loadalsoroles=0, $socid=0)
	Load object contact.
	findNearest ($id=0, $lastname='', $firstname='', $ref_ext='', $email='', $ref_alias='', $socid=0)
	Search the contact that match the most the provided parameters.
	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.
	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.
	delete ($user, $notrigger=0)
	Delete a contact from database.
	info ($id)
	Load contact information from the database.
	getNbOfEMailings ()
	Return number of mass Emailing received by these contacts with its email.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $maxlen=0, $moreparam='', $save_lastsearch_value=-1, $notooltip=0, $morecss='valignmiddle')
	Return name of contact with link (and eventually picto) Use $this->id, $this->lastname, $this->firstname, this->civility_id.
	getCivilityLabel ()
	Return civility label of contact.
	getLibStatut ($mode)
	Return the label of the status.
	LibStatut ($status, $mode)
	Return the label of a given status.
	LibPubPriv ($status)
	Return translated label of Public or Private.
	initAsSpecimen ()
	Initialise an instance with random values.
	setstatus ($status)
	Change status of a user.
	setCategories ($categories)
	Sets object to supplied categories.
	fetchRoles ()
	Fetch roles (default contact of some companies) for the current contact.
	getContactRoles ($element='')
	Get thirdparty contact roles of a given contact.
	updateRoles ()
	Updates all roles (default contact for companies) according to values inside the ->roles array.
	loadCacheOfProspStatus ($active=1)
	Load array of prospect status.
	getLibProspLevel ()
	Return prospect level.
	libProspLevel ($fk_prospectlevel)
	Return label of prospect level.
	setProspectLevel (User $user)
	Set prospect level.
	getLibProspCommStatut ($mode=0, $label='')
	Return status of prospect.
	libProspCommStatut ($statut, $mode=0, $label='', $picto='')
	Return label of a given status.
	setNoEmail ($no_email)
	Set "blacklist" mailing status.
	getNoEmail ()
	get "blacklist" mailing status set no_email attribute to 1 or 0
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchBarCode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

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

Public Attributes
	$fields
	'type' if the field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key.
Public Attributes inherited from CommonObject
	$origin_object

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

Detailed Description

Class to manage contact/addresses.

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

Constructor & Destructor Documentation

__construct()

Contact::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

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

References getDolGlobalString().

Member Function Documentation

_load_ldap_dn()

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

Return DN string complete in the LDAP directory for the object.

Parameters

array<string,mixed>	$info Info array loaded by _load_ldap_info
int<0,2>	$mode 0=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 782 of file contact.class.php.

References $conf, and getDolGlobalString().

_load_ldap_info()

Contact::_load_ldap_info

(

)

Initialize info table (LDAP attributes table)

Returns

array<string,mixed> Attributes info table

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

References $conf, address, dol_string_nohtmltag(), email, getDolGlobalString(), and getFullName().

create()

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

Add a contact into database.

Parameters

User	$user	Object user that create
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References $conf, CommonObject\call_trigger(), dol_now(), dol_syslog(), name, setEntity(), setUpperOrLowerCase(), update(), and update_perso().

delete()

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

Delete a contact from database.

Parameters

User	$user	User making the delete
int	$notrigger	Disable all trigger

Returns

int Return integer <0 if KO, >0 if OK

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

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

fetch()

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

Load object contact.

Parameters

int	$id	Id of contact
?User	$user	Load also alerts of this user (subscribing to alerts) that want alerts about this contact
string	$ref_ext	External reference, not given by Dolibarr
string	$email	Email
int	$loadalsoroles	Load also roles. Try to always use 0 here and load roles with a separate call of fetchRoles().
int	$socid	Filter on thirdparty id

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

References address, dol_syslog(), email, CommonObject\fetch_optionals(), fetchRoles(), ref, and setGenderFromCivility().

fetchRoles()

Contact::fetchRoles

(

)

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

This load the array ->roles.

Returns

int Return integer <0 if KO, Nb of roles found if OK

See also

updateRoles()

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

Referenced by fetch().

findNearest()

Contact::findNearest	(		$id = 0,
			$lastname = '',
			$firstname = '',
			$ref_ext = '',
			$email = '',
			$ref_alias = '',
			$socid = 0 )

Search the contact that match the most the provided parameters.

Searching rules try to find the existing contact.

Parameters

int	$id	Id of contact
string	$lastname	Lastname (TODO Not yet implemented)
string	$firstname	Firstname (TODO Not yet implemented)
string	$ref_ext	External reference, not given by Dolibarr
string	$email	Email
string	$ref_alias	Name alias (TODO Not yet implemented)
int	$socid	Filter on thirdparty id

Returns

int ID of contact if OK, <0 if KO or if two records found for same ref or idprof, 0 if not found.

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

getCivilityLabel()

Contact::getCivilityLabel

(

)

Return civility label of contact.

Returns

string Translated name of civility

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

getContactRoles()

Contact::getContactRoles

(

$element = ''

)

Get thirdparty contact roles of a given contact.

Parameters

string

$element

Element type

Returns

array<array{fk_socpeople:int,type_contact:int}>|int<-1,-1> Array of contact roles or -1

Exceptions

Exception

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

References dol_print_error(), and dol_syslog().

getKanbanView()

Contact::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

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

References getNomUrl(), img_picto(), and Form\showphoto().

getLibProspCommStatut()

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

Return status of prospect.

Parameters

int	$mode	0=label long, 1=label short, 2=Picto + Label short, 3=Picto, 4=Picto + Label long
string	$label	Label to use for status for added status

Returns

string Label

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

References libProspCommStatut().

getLibProspLevel()

Contact::getLibProspLevel

(

)

Return prospect level.

Returns

string Label

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

References libProspLevel().

getLibStatut()

Contact::getLibStatut

(

$mode

)

Return the label of the status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

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

References LibStatut().

Referenced by getTooltipContentArray().

getNbOfEMailings()

Contact::getNbOfEMailings

(

)

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

Returns

int Number of EMailings

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

References email.

getNoEmail()

Contact::getNoEmail

(

)

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

Returns

int Return integer <0 if KO, >0 if OK

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

References email, and getEntity().

getNomUrl()

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

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

Parameters

int	$withpicto	Include picto with link (0=no picto, 1=picto + name, 2=picto only, -1=photo+name, -2=photo only)
string	$option	Where the link point to
int	$maxlen	Max length of
string	$moreparam	Add more param into URL
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link

Returns

string String with URL

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

References $conf, dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getFullName(), getTooltipContentArray(), img_object(), and Form\showphoto().

Referenced by getKanbanView().

getTooltipContentArray()

Contact::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

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

References $conf, dol_format_address(), dol_print_phone(), getDolGlobalString(), getFullName(), getLibStatut(), img_picto(), and Form\showphoto().

Referenced by getNomUrl().

info()

Contact::info

(

$id

)

Load contact information from the database.

Parameters

int

$id

Id of the contact to load

Returns

void

Definition at line 1417 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 1714 of file contact.class.php.

References address, and email.

libProspCommStatut()

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

Return label of a given status.

Parameters

int | string	$statut	Id or code for prospection status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
string	$label	Label to use for status for added status
string	$picto	Name 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 Label of status

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

References img_action().

Referenced by getLibProspCommStatut().

libProspLevel()

Contact::libProspLevel

(

$fk_prospectlevel

)

Return label of prospect level.

Parameters

string

$fk_prospectlevel

Prospect level

Returns

string label of level

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

Referenced by getLibProspLevel().

LibPubPriv()

Contact::LibPubPriv

(

$status

)

Return translated label of Public or Private.

Parameters

int

$status

Type (0 = public, 1 = private)

Returns

string Label translated

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

LibStatut()

Contact::LibStatut	(		$status,
			$mode )

Return the label of a given status.

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

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

References dolGetStatus().

Referenced by getLibStatut().

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 Return integer <0 if KO, >=0 if OK

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

References dol_syslog().

loadCacheOfProspStatus()

Contact::loadCacheOfProspStatus

(

$active = 1

)

Load array of prospect status.

Parameters

int

$active

1=Active only, 0=Not active only, -1=All

Returns

int Return integer <0 if KO, >0 if OK

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

loadStateBoard()

Contact::loadStateBoard

(

)

Load indicators into this->nb for board.

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_print_error(), and getEntity().

replaceThirdparty()

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

static

Function used to replace a thirdparty id with another one.

Parameters

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

Returns

bool

Definition at line 1830 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

$categories

Category or categories IDs

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 1816 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 1231 of file contact.class.php.

Referenced by fetch().

setNoEmail()

Contact::setNoEmail

(

$no_email

)

Set "blacklist" mailing status.

Parameters

int

$no_email

1=Do not send mailing, 0=Ok to receive mailing

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_now(), email, and getEntity().

setProspectLevel()

Contact::setProspectLevel

(

User

$user

)

Set prospect level.

Parameters

User

$user

User who defines the discount

Returns

int Return integer <0 if KO, >0 if OK

Deprecated

Use update function instead

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

References update().

setstatus()

Contact::setstatus

(

$status

)

Change status of a user.

Parameters

int

$status

Status to set

Returns

int Return integer <0 if KO, 0 if nothing is done, >0 if OK

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

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

update()

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

Update information into database.

Parameters

int	$id	Id of contact/address to update
User	$user	Object user making change
int	$notrigger	0=no, 1=yes
string	$action	Current action for hookmanager
int	$nosyncuser	No sync linked user (external users and contacts are linked)

Returns

int Return integer <0 if KO, >0 if OK

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

References $conf, address, CommonObject\call_trigger(), dol_syslog(), email, CommonObject\insertExtraFields(), setUpperOrLowerCase(), and updateRoles().

Referenced by create(), and setProspectLevel().

update_perso()

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

Update field alert birthday.

Parameters

int	$id	Id of contact
User	$user	User asking to change alert or birthday
int	$notrigger	0=no, 1=yes

Returns

int Return integer <0 if KO, >=0 if OK

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

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

Referenced by create().

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

int

See also

fetchRoles()

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

References $conf, dol_now(), and getEntity().

Referenced by update().

Member Data Documentation

$fields

Contact::$fields

'type' if the field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key.

'enabled' is a condition when the field must be managed. 'position' is the sort order of field. 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0). 'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view forms, 2=Visible on list only, 3=Visible on create/update/view form only (not list), 4=Visible on list and update/view form only (not create). 5=Visible on list and view only (not create/not update). Using a negative value means field is not shown by default on list but can be selected for viewing) 'noteditable' says if field is not editable (1 or 0) 'default' is a default value for creation (can still be overwrote by the Setup of Default Values if field is editable in creation form). Note: If default is set to '(PROV)' and field is 'ref', the default value will be set to '(PROVid)' where id is rowid when a new record is created. 'index' if we want an index in database. 'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...). 'searchall' is 1 if we want to search in this field when making a search from the quick search button. 'isameasure' must be set to 1 if you want to have a total on list for this field. Field type must be summable like integer or double(24,8). 'css' is the CSS style to use on field. For example: 'maxwidth200' 'help' is a string visible as a tooltip on field 'showoncombobox' if value of the field must be visible into the label of the combobox that list record 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute. In most cases, this is never set into the definition of $fields into class, but is set dynamically by some part of code. 'arrayofkeyval' to set list of value if type is a list of predefined values. For example: array("0"=>"Draft","1"=>"Active","-1"=>"Cancel") 'comment' is not used. You can store here any text of your choice. It is not used by application.

Note: To have value dynamic, you can set value to 0 in definition and edit the value on the fly into the constructor. array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int<-2,5>|string,noteditable?:int<0,1>,default?:string,index?:int,foreignkey?:string,searchall?:int<0,1>,isameasure?:int<0,1>,css?:string,csslist?:string,help?:string,showoncombobox?:int<0,2>,disabled?:int<0,1>,arrayofkeyval?:array<int|string,string>,comment?:string,validate?:int<0,1>}> Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.

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

---

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

• dolibarr_dev/htdocs/contact/class/contact.class.php