Client Class Reference

Class to manage customers or prospects. More...

Inheritance diagram for Client:

Collaboration diagram for Client:

Public Member Functions
	__construct ($db)
	Constructor.
	load_state_board ()
	Load indicators into this->nb for board.
	loadCacheOfProspStatus ($active=1)
	Load array of prospect status.
Public Member Functions inherited from Societe
	create (User $user, $notrigger=0)
	Create third party in database.
	create_individual (User $user, $no_email=0, $tags=array(), $notrigger=0)
	Create a contact/address from thirdparty.
	verify ()
	Check properties of third party are ok (like name, third party codes, ...) Used before an add or update.
	update ($id, $user='', $call_trigger=1, $allowmodcodeclient=0, $allowmodcodefournisseur=0, $action='update', $nosyncmember=1)
	Update parameters of third party.
	fetch ($rowid, $ref='', $ref_ext='', $barcode='', $idprof1='', $idprof2='', $idprof3='', $idprof4='', $idprof5='', $idprof6='', $email='', $ref_alias='')
	Load a third party from database into memory.
	delete ($id, User $fuser=null, $call_trigger=1)
	Delete a third party from database and all its dependencies (contacts, rib...)
	set_as_client ()
	Define third party as a customer.
	setAsCustomer ()
	Define third party as a customer.
	set_remise_client ($remise, $note, User $user)
	Defines the company as a customer.
	set_remise_supplier ($remise, $note, User $user)
	Defines the company as a customer.
	set_remise_except ($remise, User $user, $desc, $vatrate='', $discount_type=0, $price_base_type='HT')
	Add a discount for third party.
	getAvailableDiscounts ($user='', $filter='', $maxvalue=0, $discount_type=0)
	Returns amount of included taxes of the current discounts/credits available from the company.
	getSalesRepresentatives (User $user, $mode=0, $sortfield=null, $sortorder=null)
	Return array of sales representatives.
	setPriceLevel ($price_level, User $user)
	Set the price level.
	add_commercial (User $user, $commid)
	Add link to sales representative.
	del_commercial (User $user, $commid)
	Add link to sales representative.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $maxlen=0, $notooltip=0, $save_lastsearch_value=-1, $noaliasinname=0, $target='')
	Return a link on thirdparty (with picto)
	getTypeUrl ($withpicto=0, $option='', $notooltip=0, $tag='a')
	Return link(s) on type of thirdparty (with picto)
	getLibStatut ($mode=0)
	Return label of status (activity, closed)
	LibStatut ($status, $mode=0)
	Return the label of a given status.
	thirdparty_and_contact_email_array ($addthirdparty=0)
	Return list of contacts emails existing for third party.
	thirdparty_and_contact_phone_array ()
	Return list of contacts mobile phone existing for third party.
	contact_property_array ($mode='email', $hidedisabled=0)
	Return list of contacts emails or mobile existing for third party.
	contact_array ()
	Returns the contact list of this company.
	contact_array_objects ()
	Returns the contact list of this company.
	contact_get_property ($rowid, $mode)
	Return property of contact from its id.
	display_rib ($mode='label')
	Return bank number property of thirdparty (label or rum)
	get_all_rib ()
	Return Array of RIB.
	get_codeclient ($objsoc=0, $type=0)
	Assigns a customer code from the code control module.
	get_codefournisseur ($objsoc=0, $type=1)
	Assigns a vendor code from the code control module.
	codeclient_modifiable ()
	Check if a client code is editable based on the parameters of the code control module.
	codefournisseur_modifiable ()
	Check if a vendor code is editable in the code control module configuration.
	check_codeclient ()
	Check customer code.
	check_codefournisseur ()
	Check supplier code.
	get_codecompta ($type)
	Assigns a accounting code from the accounting code module.
	setParent ($id)
	Define parent company of current company.
	validateFamilyTree ($idparent, $idchild, $counter=0)
	Check if a thirdparty $idchild is or not inside the parents (or grand parents) of another thirdparty id $idparent.
	getParentsForCompany ($company_id, $parents=array())
	Get parents for company.
	id_prof_verifiable ($idprof)
	Returns if a profid sould be verified to be unique.
	id_prof_exists ($idprof, $value, $socid=0)
	Verify if a profid exists into database for others thirds.
	id_prof_check ($idprof, $soc)
	Check the validity of a professional identifier according to the country of the company (siren, siret, ...)
	id_prof_url ($idprof, $thirdparty)
	Return an url to check online a professional id or empty string.
	has_projects ()
	Indicates if the company has projects.
	info ($id)
	Load information for tab info.
	isACompany ()
	Return if third party is a company (Business) or an end user (Consumer)
	isInEEC ()
	Return if a company is inside the EEC (European Economic Community)
	LoadSupplierCateg ()
	Load the list of provider categories.
	AddFournisseurInCategory ($categorie_id)
	Insert link supplier - category.
	getNbOfEMailings ()
	Return number of mass Emailing received by this contacts with its email.
	setNoEmail ($no_email)
	Set "blacklist" mailing status.
	getNoEmail ()
	get "blacklist" mailing status set no_email attribut to 1 or 0
	create_from_member (Adherent $member, $socname='', $socalias='', $customercode='')
	Create a third party into database from a member object.
	setMysoc (Conf $conf)
	Set properties with value into $conf.
	initAsSpecimen ()
	Initialise an instance with random values.
	useLocalTax ($localTaxNum=0)
	Check if we must use localtax feature or not according to country (country of $mysoc in most cases).
	useNPR ()
	Check if we must use NPR Vat (french stupid rule) or not according to country (country of $mysoc in most cases).
	useRevenueStamp ()
	Check if we must use revenue stamps feature or not according to country (country of $mysocin most cases).
	getLibProspLevel ()
	Return prostect level.
	LibProspLevel ($fk_prospectlevel)
	Return label of prospect level.
	getLibProspCommStatut ($mode=0, $label='')
	Return status of prospect.
	LibProspCommStatut ($status, $mode=0, $label='', $picto='')
	Return label of a given status.
	getOutstandingProposals ($mode='customer')
	Return amount of proposal not yet paid and total an dlist of all proposals.
	getOutstandingOrders ($mode='customer')
	Return amount of order not yet paid and total and list of all orders.
	getOutstandingBills ($mode='customer', $late=0)
	Return amount of bill not yet paid and total of all invoices.
	getLibCustProspStatut ()
	Return label of status customer is prospect/customer.
	LibCustProspStatut ($status)
	Return the label of the customer/prospect status.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	setCategories ($categories, $type_categ)
	Sets object to supplied categories.
	setSalesRep ($salesrep, $onlyAdd=false)
	Sets sales representatives of the thirdparty.
	setThirdpartyType ($typent_id)
	Define third-party type of current company.
	setAccountancyCode ($type, $value)
	Sets an accountancy code for a thirdparty.
	fetchPartnerships ($mode)
	Function to get partnerships array.
	getKanbanView ($option='', $arraydata=null)
	Return clicable link of object (with eventually picto)
	getContacts ($list=0, $code='', $element='')
	Get array of all contacts for a society (stored in societe_contacts instead of element_contacts for all other objects)
	mergeCompany ($soc_origin_id)
	Merge a company with another one, deleting the given company.
Public Member Functions inherited from CommonObject
	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.
	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=false, $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=false, $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='none', $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.
	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.
	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 datas.
	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.
	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=false)
	Create object into 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=false)
	Update object into database.
	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=false)
	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.

Additional Inherited Members
Static Public Member Functions inherited from Societe
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 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.
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 inherited from Societe
const	NO_CUSTOMER = 0
	Third party type is no customer.
const	CUSTOMER = 1
	Third party type is a customer.
const	PROSPECT = 2
	Third party type is a prospect.
const	CUSTOMER_AND_PROSPECT = 3
	Third party type is a customer and a prospect.
const	NO_SUPPLIER = 0
	Third party supplier flag is not supplier.
const	SUPPLIER = 1
	Third party supplier flag is a supplier.
Public Attributes inherited from CommonObject
	$fk_projet
	$expedition
	$livraison
	$commandeFournisseur
	$note
	$date_modification
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.
	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 customers or prospects.

Definition at line 31 of file client.class.php.

Constructor & Destructor Documentation

__construct()

Client::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from Societe.

Definition at line 43 of file client.class.php.

Member Function Documentation

load_state_board()

Client::load_state_board

(

)

Load indicators into this->nb for board.

Returns

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

Definition at line 57 of file client.class.php.

References dol_print_error().

loadCacheOfProspStatus()

Client::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 107 of file client.class.php.

---

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

• dolibarr_19.0/htdocs/societe/class/client.class.php