Societe Class Reference

Class to manage third parties objects (customers, suppliers, prospects...) More...

Inheritance diagram for Societe:

Collaboration diagram for Societe:

Public Member Functions
	__construct ($db)
	Constructor.
	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 $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='', $is_client=0, $is_supplier=0)
	Load a third party from database into memory.
	findNearest ($rowid=0, $ref='', $ref_ext='', $barcode='', $idprof1='', $idprof2='', $idprof3='', $idprof4='', $idprof5='', $idprof6='', $email='', $ref_alias='', $is_client=0, $is_supplier=0)
	Search the thirdparty that match the most the provided parameters.
	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=null, $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='', $morecss='')
	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.
	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 should 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 ()
	Check 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 attribute 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=array())
	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 current one, deleting the given company $soc_origin_id.
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.
	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.
	setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a signed 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
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
	$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 third parties objects (customers, suppliers, prospects...)

Definition at line 54 of file societe.class.php.

Constructor & Destructor Documentation

__construct()

Societe::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in Client, and Fournisseur.

Definition at line 875 of file societe.class.php.

References getDolGlobalString(), and status.

Member Function Documentation

add_commercial()

Societe::add_commercial	(	User	$user,
			$commid )

Add link to sales representative.

Parameters

User	$user	Object user
int	$commid	Id of user

Returns

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

Definition at line 2666 of file societe.class.php.

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

Referenced by create(), and setSalesRep().

AddFournisseurInCategory()

Societe::AddFournisseurInCategory

(

$categorie_id

)

Insert link supplier - category.

Parameters

int

$categorie_id

Id of category

Returns

int 0 if success, <> 0 if error

Definition at line 4162 of file societe.class.php.

check_codeclient()

Societe::check_codeclient

(

)

Check customer code.

Returns

int 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 NotConfigured - Setup empty so any value may be ok or not -6 Other (see this->error)

Definition at line 3591 of file societe.class.php.

References dol_include_once(), dol_syslog(), and getDolGlobalString().

Referenced by verify().

check_codefournisseur()

Societe::check_codefournisseur

(

)

Check supplier code.

Returns

int 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired -5 NotConfigured - Setup empty so any value may be ok or not -6 Other (see this->error)

Definition at line 3632 of file societe.class.php.

References dol_include_once(), dol_syslog(), and getDolGlobalString().

Referenced by verify().

codeclient_modifiable()

Societe::codeclient_modifiable

(

)

Check if a client code is editable based on the parameters of the code control module.

Returns

int 0=No, 1=Yes

Definition at line 3505 of file societe.class.php.

References dol_include_once(), dol_syslog(), and getDolGlobalString().

codefournisseur_modifiable()

Societe::codefournisseur_modifiable

(

)

Check if a vendor code is editable in the code control module configuration.

Returns

int 0=No, 1=Yes

Definition at line 3545 of file societe.class.php.

References dol_include_once(), dol_syslog(), and getDolGlobalString().

contact_array()

Societe::contact_array

(

)

Returns the contact list of this company.

Returns

array array of contacts

Definition at line 3268 of file societe.class.php.

References dol_print_error(), and dolGetFirstLastname().

contact_array_objects()

Societe::contact_array_objects

(

)

Returns the contact list of this company.

Returns

array $contacts array of contacts

Definition at line 3297 of file societe.class.php.

References dol_print_error().

contact_get_property()

Societe::contact_get_property	(		$rowid,
			$mode )

Return property of contact from its id.

Parameters

int	$rowid	id of contact
string	$mode	'email' or 'mobile'

Returns

string Email of contact with format: "Full name <email>"

Definition at line 3331 of file societe.class.php.

References dol_print_error(), dol_string_nospecial(), and dolGetFirstLastname().

contact_property_array()

Societe::contact_property_array	(		$mode = 'email',
			$hidedisabled = 0 )

Return list of contacts emails or mobile existing for third party.

Parameters

string	$mode	'email' or 'mobile'
int	$hidedisabled	1=Hide contact if disabled

Returns

array Array of contacts emails or mobile. Example: array(id=>'Name <email>')

Definition at line 3200 of file societe.class.php.

References dol_print_error(), and dolGetFirstLastname().

Referenced by thirdparty_and_contact_email_array(), and thirdparty_and_contact_phone_array().

create()

Societe::create	(	User	$user,
			$notrigger = 0 )

Create third party in database.

$this->code_client = -1 and $this->code_fournisseur = -1 means automatic assignment.

Parameters

User	$user	Object of user that ask creation
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int >=0 if OK, <0 if KO

Definition at line 910 of file societe.class.php.

References add_commercial(), CommonObject\call_trigger(), dol_now(), dol_syslog(), getDolGlobalString(), MultiCurrency\getIdFromCode(), name, setUpperOrLowerCase(), status, update(), and verify().

Referenced by create_from_member().

create_from_member()

Societe::create_from_member	(	Adherent	$member,
			$socname = '',
			$socalias = '',
			$customercode = '' )

Create a third party into database from a member object.

Parameters

Adherent	$member	Object member
string	$socname	Name of third party to force
string	$socalias	Alias name of third party to force
string	$customercode	Customer code

Returns

int Return integer <0 if KO, id of created account if OK

Definition at line 4294 of file societe.class.php.

References create(), create_individual(), dol_getIdFromCode(), dol_syslog(), getDolGlobalString(), name, and setEventMessages().

create_individual()

Societe::create_individual	(	User	$user,
			$no_email = 0,
			$tags = array(),
			$notrigger = 0 )

Create a contact/address from thirdparty.

Parameters

User	$user	Object user
int	$no_email	1=Do not send mailing, 0=Ok to receive mailing
array	$tags	Array of tag to affect to contact
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 1108 of file societe.class.php.

References dol_syslog(), and setUpperOrLowerCase().

Referenced by create_from_member().

del_commercial()

Societe::del_commercial	(	User	$user,
			$commid )

Add link to sales representative.

Parameters

User	$user	Object user
int	$commid	Id of user

Returns

int Return <0 if KO, >0 if OK

Definition at line 2726 of file societe.class.php.

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

Referenced by setSalesRep().

delete()

Societe::delete	(		$id,
		User	$fuser = null,
			$call_trigger = 1 )

Delete a third party from database and all its dependencies (contacts, rib...)

Parameters

int	$id	Id of third party to delete
User | null	$fuser	User who ask to delete thirdparty
int	$call_trigger	0=No, 1=yes

Returns

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

Definition at line 2151 of file societe.class.php.

References CommonObject\call_trigger(), CommonObject\deleteExtraFields(), dol_delete_dir_recursive(), dol_include_once(), dol_is_dir(), dol_syslog(), getDolGlobalString(), and CommonObject\isObjectUsed().

display_rib()

Societe::display_rib

(

$mode = 'label'

)

Return bank number property of thirdparty (label or rum)

Parameters

string

$mode

'label' or 'rum' or 'format'

Returns

string Bank label or RUM or '' if no bank account found

Definition at line 3373 of file societe.class.php.

fetch()

Societe::fetch	(		$rowid,
			$ref = '',
			$ref_ext = '',
			$barcode = '',
			$idprof1 = '',
			$idprof2 = '',
			$idprof3 = '',
			$idprof4 = '',
			$idprof5 = '',
			$idprof6 = '',
			$email = '',
			$ref_alias = '',
			$is_client = 0,
			$is_supplier = 0 )

Load a third party from database into memory.

Parameters

int	$rowid	Id of third party to load
string	$ref	Reference of third party, name (Warning, this can return several records)
string	$ref_ext	External reference of third party (Warning, this information is a free field not provided by Dolibarr)
string	$barcode	Barcode of third party to load
string	$idprof1	Prof id 1 of third party (Warning, this can return several records)
string	$idprof2	Prof id 2 of third party (Warning, this can return several records)
string	$idprof3	Prof id 3 of third party (Warning, this can return several records)
string	$idprof4	Prof id 4 of third party (Warning, this can return several records)
string	$idprof5	Prof id 5 of third party (Warning, this can return several records)
string	$idprof6	Prof id 6 of third party (Warning, this can return several records)
string	$email	Email of third party (Warning, this can return several records)
string	$ref_alias	Name_alias of third party (Warning, this can return several records)
int	$is_client	Only client third party
int	$is_supplier	Only supplier third party

Returns

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

Reimplemented in Client, and Fournisseur.

Definition at line 1804 of file societe.class.php.

References dol_syslog(), CommonObject\fetch_optionals(), getDolGlobalString(), getEntity(), name, price2num(), ref, and status.

fetchPartnerships()

Societe::fetchPartnerships

(

$mode

)

Function to get partnerships array.

Parameters

string

$mode

'member' or 'thirdparty'

Returns

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

Definition at line 5240 of file societe.class.php.

findNearest()

Societe::findNearest	(		$rowid = 0,
			$ref = '',
			$ref_ext = '',
			$barcode = '',
			$idprof1 = '',
			$idprof2 = '',
			$idprof3 = '',
			$idprof4 = '',
			$idprof5 = '',
			$idprof6 = '',
			$email = '',
			$ref_alias = '',
			$is_client = 0,
			$is_supplier = 0 )

Search the thirdparty that match the most the provided parameters.

Searching rules try to find the existing third party.

Parameters

int	$rowid	Id of third party
string	$ref	Reference of third party, name (Warning, this can return several records)
string	$ref_ext	External reference of third party (Warning, this information is a free field not provided by Dolibarr)
string	$barcode	Barcode of third party to load
string	$idprof1	Prof id 1 of third party (Warning, this can return several records)
string	$idprof2	Prof id 2 of third party (Warning, this can return several records)
string	$idprof3	Prof id 3 of third party (Warning, this can return several records)
string	$idprof4	Prof id 4 of third party (Warning, this can return several records)
string	$idprof5	Prof id 5 of third party (Warning, this can return several records)
string	$idprof6	Prof id 6 of third party (Warning, this can return several records)
string	$email	Email of third party (Warning, this can return several records)
string	$ref_alias	Name_alias of third party (Warning, this can return several records)
int	$is_client	Only client third party
int	$is_supplier	Only supplier third party

Returns

int ID of thirdparty found if OK, <0 if KO or if two records found, 0 if not found.

Definition at line 2124 of file societe.class.php.

generateDocument()

Societe::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0,
			$moreparams = null )

Create a document onto disk according to template module.

Parameters

string	$modele	Generator to use. Caller must set it to obj->model_pdf.
Translate	$outputlangs	object lang a utiliser pour traduction
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref
null | array	$moreparams	Array to provide more information

Returns

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

Definition at line 4995 of file societe.class.php.

References CommonObject\commonGenerateDocument(), dol_print_error(), dol_strlen(), and getDolGlobalString().

get_all_rib()

Societe::get_all_rib

(

)

Return Array of RIB.

Returns

CompanyBankAccount[]|int Return 0 if KO, Array of CompanyBankAccount if OK

Definition at line 3409 of file societe.class.php.

get_codecompta()

Societe::get_codecompta

(

$type

)

Assigns a accounting code from the accounting code module.

Computed value is stored into this->code_compta or this->code_compta_fournisseur according to $type. May be identical to the one entered or generated automatically. Currently, only the automatic generation is implemented.

Parameters

string

$type

Type of thirdparty ('customer' or 'supplier')

Returns

int 0 if OK, <0 if $type is not valid

Definition at line 3670 of file societe.class.php.

References dol_include_once(), and getDolGlobalString().

Referenced by update().

getAvailableDiscounts()

Societe::getAvailableDiscounts	(		$user = null,
			$filter = '',
			$maxvalue = 0,
			$discount_type = 0 )

Returns amount of included taxes of the current discounts/credits available from the company.

Parameters

?User	$user	Filter on a user author of discounts
string	$filter	Other filter
int	$maxvalue	Filter on max value for discount
	int<0,1>	$discount_type 0 => customer discount, 1 => supplier discount

Returns

float|int<-1,-1> Return integer <0 if KO, Credit note amount otherwise

Definition at line 2542 of file societe.class.php.

getContacts()

Societe::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)

Parameters

int	$list	0:Return array contains all properties, 1:Return array contains just id
string	$code	Filter on this code of contact type ('SHIPPING', 'BILLING', ...)
string	$element	Filter on this element of default contact type ('facture', 'propal', 'commande' ...)

Returns

array|int Array of contacts, -1 if error

Definition at line 5295 of file societe.class.php.

References dol_print_error(), and dol_syslog().

getKanbanView()

Societe::getKanbanView	(		$option = '',
			$arraydata = array() )

Return clicable link of object (with eventually picto)

Parameters

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

Returns

string HTML Code for Kanban thumb.

Definition at line 5259 of file societe.class.php.

References getNomUrl(), and img_picto().

getLibCustProspStatut()

Societe::getLibCustProspStatut

(

)

Return label of status customer is prospect/customer.

Returns

string Label

See also

getTypeUrl()

Definition at line 4952 of file societe.class.php.

References LibCustProspStatut().

getLibProspCommStatut()

Societe::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 4694 of file societe.class.php.

References LibProspCommStatut().

getLibProspLevel()

Societe::getLibProspLevel

(

)

Return prostect level.

Returns

string Label of prospect status

Definition at line 4658 of file societe.class.php.

References LibProspLevel().

getLibStatut()

Societe::getLibStatut

(

$mode = 0

)

Return label of status (activity, closed)

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 3110 of file societe.class.php.

References LibStatut(), and status.

getNbOfEMailings()

Societe::getNbOfEMailings

(

)

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

Returns

int Number of EMailings

Definition at line 4183 of file societe.class.php.

getNoEmail()

Societe::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 4266 of file societe.class.php.

References getEntity().

getNomUrl()

Societe::getNomUrl	(		$withpicto = 0,
			$option = '',
			$maxlen = 0,
			$notooltip = 0,
			$save_lastsearch_value = -1,
			$noaliasinname = 0,
			$target = '',
			$morecss = '' )

Return a link on thirdparty (with picto)

Parameters

int	$withpicto	Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)
string	$option	Target of link (''=auto, 'nolink'=no link, 'customer', 'prospect', 'supplier', 'project', 'agenda', ...)
int	$maxlen	Max length of name
int	$notooltip	1=Disable tooltip
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int	$noaliasinname	1=Do not add alias into the link ref
string	$target	add attribute target
string	$morecss	More CSS

Returns

string String with URL

Definition at line 2921 of file societe.class.php.

References dol_escape_htmltag(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), img_object(), and name.

Referenced by getKanbanView().

getOutstandingBills()

Societe::getOutstandingBills	(		$mode = 'customer',
			$late = 0 )

Return amount of bill not yet paid and total of all invoices.

Parameters

string	$mode	'customer' or 'supplier'
int	$late	0 => all invoice, 1=> only late

Returns

array array('opened'=>Amount including tax that remains to pay, 'total_ht'=>Total amount without tax of all objects paid or not, 'total_ttc'=>Total amount including tax of all object paid or not)

Definition at line 4861 of file societe.class.php.

References dol_now(), dol_syslog(), and FactureFournisseur\TYPE_CREDIT_NOTE.

getOutstandingOrders()

Societe::getOutstandingOrders

(

$mode = 'customer'

)

Return amount of order not yet paid and total and list of all orders.

Parameters

string

$mode

'customer' or 'supplier'

Returns

array array('opened'=>Amount including tax that remains to pay, 'total_ht'=>Total amount without tax of all objects paid or not, 'total_ttc'=>Total amount including tax of all object paid or not)

Definition at line 4817 of file societe.class.php.

References dol_syslog().

getOutstandingProposals()

Societe::getOutstandingProposals

(

$mode = 'customer'

)

Return amount of proposal not yet paid and total an dlist of all proposals.

Parameters

string

$mode

'customer' or 'supplier'

Returns

array array('opened'=>Amount including tax that remains to pay, 'total_ht'=>Total amount without tax of all objects paid or not, 'total_ttc'=>Total amount including tax of all object paid or not)

Definition at line 4773 of file societe.class.php.

References dol_syslog().

getParentsForCompany()

Societe::getParentsForCompany	(		$company_id,
			$parents = array() )

Get parents for company.

Parameters

int	$company_id	ID of company to search parent
array	$parents	List of companies ID found

Returns

array

Definition at line 3794 of file societe.class.php.

References getParentsForCompany(), and setEventMessage().

Referenced by getParentsForCompany().

getSalesRepresentatives()

Societe::getSalesRepresentatives	(	User	$user,
			$mode = 0,
			$sortfield = null,
			$sortorder = null )

Return array of sales representatives.

Parameters

User	$user	Object user (not used)
int	$mode	0=Array with properties, 1=Array of IDs.
string	$sortfield	List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb'
string	$sortorder	Sort order, separated by comma. Example: 'ASC,DESC';

Returns

array|int Array of sales representatives of the current third party or <0 if KO

Definition at line 2565 of file societe.class.php.

References dol_print_error(), getDolGlobalString(), and getEntity().

Referenced by setSalesRep().

getTooltipContentArray()

Societe::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array

$params

params to construct tooltip data

Since

v18

Returns

array

Reimplemented from CommonObject.

Definition at line 2761 of file societe.class.php.

References dol_escape_htmltag(), dol_format_address(), dol_print_phone(), dol_string_nohtmltag(), getDolGlobalString(), getTypeUrl(), img_picto(), name, Form\showphoto(), and status.

Referenced by getNomUrl().

getTypeUrl()

Societe::getTypeUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$tag = 'a' )

Return link(s) on type of thirdparty (with picto)

Parameters

int	$withpicto	Add picto into link (0=No picto, 1=Include picto with link, 2=Picto only)
string	$option	''=All
int	$notooltip	1=Disable tooltip
string	$tag	Tag 'a' or 'span'

Returns

string String with URL

Definition at line 3080 of file societe.class.php.

References dol_substr(), and getDolGlobalString().

Referenced by getTooltipContentArray().

has_projects()

Societe::has_projects

(

)

Indicates if the company has projects.

Returns

bool true if the company has projects, false otherwise

Definition at line 4037 of file societe.class.php.

id_prof_check()

Societe::id_prof_check	(		$idprof,
			$soc )

Check the validity of a professional identifier according to the country of the company (siren, siret, ...)

Parameters

int	$idprof	1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm)
Societe	$soc	Object societe

Returns

int Return integer <=0 if KO, >0 if OK TODO better to have this in a lib than into a business class

Definition at line 3928 of file societe.class.php.

References getDolGlobalString(), isValidSiren(), isValidSiret(), isValidTinForBE(), isValidTinForDZ(), isValidTinForES(), and isValidTinForPT().

id_prof_exists()

Societe::id_prof_exists	(		$idprof,
			$value,
			$socid = 0 )

Verify if a profid exists into database for others thirds.

Parameters

string	$idprof	'idprof1','idprof2','idprof3','idprof4','idprof5','idprof6','email' (Example: idprof1=siren, idprof2=siret, idprof3=naf, idprof4=rcs/rm)
string	$value	Value of profid
int	$socid	Id of thirdparty to exclude (if update)

Returns

boolean True if exists, False if not

Definition at line 3867 of file societe.class.php.

References getEntity().

Referenced by verify().

id_prof_url()

Societe::id_prof_url	(		$idprof,
			$thirdparty )

Return an url to check online a professional id or empty string.

Parameters

int	$idprof	1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm)
Societe	$thirdparty	Object thirdparty

Returns

string Url or empty string if no URL known TODO better in a lib than into business class

Definition at line 3984 of file societe.class.php.

References getDolGlobalString().

id_prof_verifiable()

Societe::id_prof_verifiable

(

$idprof

)

Returns if a profid should be verified to be unique.

Parameters

int

$idprof

1,2,3,4,5,6 (Example: 1=siren, 2=siret, 3=naf, 4=rcs/rm, 5=eori, 6=idprof6)

Returns

boolean true if the ID must be unique

Definition at line 3827 of file societe.class.php.

References getDolGlobalString().

Referenced by verify().

info()

Societe::info

(

$id

)

Load information for tab info.

Parameters

int

$id

Id of thirdparty to load

Returns

void

Definition at line 4060 of file societe.class.php.

References dol_print_error(), and ref.

initAsSpecimen()

Societe::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 4525 of file societe.class.php.

References dol_now(), and name.

isACompany()

Societe::isACompany

(

)

Check if third party is a company (Business) or an end user (Consumer)

Returns

boolean if a company: true || if a user: false

Definition at line 4093 of file societe.class.php.

References getDolGlobalInt(), and getDolGlobalString().

Referenced by verify().

isInEEC()

Societe::isInEEC

(

)

Return if a company is inside the EEC (European Economic Community)

Returns

boolean true = country inside EEC, false = country outside EEC

Definition at line 4124 of file societe.class.php.

References isInEEC().

Referenced by isInEEC().

LibCustProspStatut()

Societe::LibCustProspStatut

(

$status

)

Return the label of the customer/prospect status.

Parameters

int

$status

Id of prospection status

Returns

string Label of prospection status

Definition at line 4964 of file societe.class.php.

Referenced by getLibCustProspStatut().

LibProspCommStatut()

Societe::LibProspCommStatut	(		$status,
			$mode = 0,
			$label = '',
			$picto = '' )

Return label of a given status.

Parameters

int | string	$status	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 prospection status

Definition at line 4713 of file societe.class.php.

References img_action().

Referenced by getLibProspCommStatut().

LibProspLevel()

Societe::LibProspLevel

(

$fk_prospectlevel

)

Return label of prospect level.

Parameters

string

$fk_prospectlevel

Prospect level

Returns

string label of level

Definition at line 4670 of file societe.class.php.

Referenced by getLibProspLevel().

LibStatut()

Societe::LibStatut	(		$status,
			$mode = 0 )

Return the label of a given status.

Parameters

int	$status	Status id
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 Status label

Definition at line 3123 of file societe.class.php.

Referenced by getLibStatut().

LoadSupplierCateg()

Societe::LoadSupplierCateg

(

)

Load the list of provider categories.

Returns

int 0 if success, <> 0 if error

Definition at line 4136 of file societe.class.php.

mergeCompany()

Societe::mergeCompany

(

$soc_origin_id

)

Merge a company with current one, deleting the given company $soc_origin_id.

The company given in parameter will be removed. This is called for example by the societe/card.php file. It calls the method replaceThirdparty() of each object with relation with thirdparties, including hook 'replaceThirdparty' for external modules.

Parameters

int

$soc_origin_id

Company to merge the data from

Returns

int -1 if error, >=0 if OK

Definition at line 5378 of file societe.class.php.

References CommonObject\call_trigger(), dol_concatdesc(), dol_dir_list(), dol_is_dir(), dol_move(), dol_syslog(), name, setCategories(), and update().

replaceThirdparty()

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

static

Function used to replace a thirdparty id with another one.

It must be used within a transaction to avoid trouble

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 (will be removed)
int	$dest_id	New thirdparty id

Returns

bool True if success, False if error

Reimplemented in Fournisseur.

Definition at line 5148 of file societe.class.php.

References CommonObject\commonReplaceThirdparty(), dol_syslog(), Database\fetch_object(), and Database\query().

set_as_client()

Societe::set_as_client

(

)

Define third party as a customer.

Returns

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

Deprecated

Use setAsCustomer() instead

See also

setAsCustomer()

Definition at line 2300 of file societe.class.php.

References dol_syslog(), and setAsCustomer().

set_remise_client()

Societe::set_remise_client	(		$remise,
			$note,
		User	$user )

Defines the company as a customer.

Parameters

float	$remise	Value in % of the discount
string	$note	Note/Reason for changing the discount
User	$user	User who sets the discount

Returns

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

Definition at line 2345 of file societe.class.php.

References dol_now(), and dol_syslog().

set_remise_except()

Societe::set_remise_except	(		$remise,
		User	$user,
			$desc,
			$vatrate = '',
			$discount_type = 0,
			$price_base_type = 'HT' )

Add a discount for third party.

Parameters

float	$remise	Amount of discount
User	$user	User adding discount
string	$desc	Reason of discount
string	$vatrate	VAT rate (may contain the vat code too). Example: '1.23', '1.23 (ABC)', ...
int	$discount_type	0 => customer discount, 1 => supplier discount
string	$price_base_type	Price base type 'HT' or 'TTC'

Returns

int Return integer <0 if KO, id of discount record if OK

Definition at line 2470 of file societe.class.php.

References price2num().

set_remise_supplier()

Societe::set_remise_supplier	(		$remise,
			$note,
		User	$user )

Defines the company as a customer.

Parameters

float	$remise	Value in % of the discount
string	$note	Note/Reason for changing the discount
User	$user	User who sets the discount

Returns

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

Definition at line 2406 of file societe.class.php.

References dol_now(), and dol_syslog().

setAccountancyCode()

Societe::setAccountancyCode	(		$type,
			$value )

Sets an accountancy code for a thirdparty.

Also calls COMPANY_MODIFY trigger when modified

Parameters

string	$type	It can be only 'buy' or 'sell'
string	$value	Accountancy code

Returns

int Return integer <0 KO >0 OK

Definition at line 5190 of file societe.class.php.

References dol_syslog().

setAsCustomer()

Societe::setAsCustomer

(

)

Define third party as a customer.

Returns

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

Since

dolibarr v19

Definition at line 2314 of file societe.class.php.

References getDolGlobalInt().

Referenced by set_as_client().

setCategories()

Societe::setCategories	(		$categories,
			$type_categ )

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 ID or array of Categories IDs
string	$type_categ	Category type ('customer' or 'supplier')

Returns

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

Definition at line 5053 of file societe.class.php.

References dol_syslog().

Referenced by mergeCompany().

setMysoc()

Societe::setMysoc

(

Conf

$conf

)

Set properties with value into $conf.

Parameters

Conf

$conf

Conf object (possibility to use another entity)

Returns

void

Definition at line 4393 of file societe.class.php.

References dol_syslog(), getCountry(), getDolGlobalInt(), getDolGlobalString(), getState(), name, and price2num().

setNoEmail()

Societe::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 4209 of file societe.class.php.

References dol_now(), and getEntity().

setParent()

Societe::setParent

(

$id

)

Define parent company of current company.

Parameters

int

$id

Id of thirdparty to set or '' to remove

Returns

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

Definition at line 3722 of file societe.class.php.

References dol_syslog(), setEventMessages(), and validateFamilyTree().

setPriceLevel()

Societe::setPriceLevel	(		$price_level,
		User	$user )

Set the price level.

Parameters

int	$price_level	Level of price
User	$user	Use making change

Returns

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

Definition at line 2631 of file societe.class.php.

References dol_now(), and dol_print_error().

setSalesRep()

Societe::setSalesRep	(		$salesrep,
			$onlyAdd = false )

Sets sales representatives of the thirdparty.

Parameters

int[] | int	$salesrep	User ID or array of user IDs
bool	$onlyAdd	Only add (no delete before)

Returns

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

Definition at line 5073 of file societe.class.php.

References add_commercial(), del_commercial(), and getSalesRepresentatives().

setThirdpartyType()

Societe::setThirdpartyType

(

$typent_id

)

Define third-party type of current company.

Parameters

int

$typent_id

third party type rowid in llx_c_typent

Returns

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

Definition at line 5118 of file societe.class.php.

References dol_getIdFromCode(), dol_syslog(), and CommonObject\setValueFrom().

thirdparty_and_contact_email_array()

Societe::thirdparty_and_contact_email_array

(

$addthirdparty = 0

)

Return list of contacts emails existing for third party.

Parameters

int

$addthirdparty

1=Add also a record for thirdparty email, 2=Same than 1 but add text ThirdParty in grey

Returns

array Array of contacts emails

Definition at line 3151 of file societe.class.php.

References contact_property_array(), dol_trunc(), and name.

thirdparty_and_contact_phone_array()

Societe::thirdparty_and_contact_phone_array

(

)

Return list of contacts mobile phone existing for third party.

Returns

array Array of contacts emails

Definition at line 3175 of file societe.class.php.

References contact_property_array(), dol_trunc(), and name.

update()

Societe::update	(		$id,
		User	$user,
			$call_trigger = 1,
			$allowmodcodeclient = 0,
			$allowmodcodefournisseur = 0,
			$action = 'update',
			$nosyncmember = 1 )

Update parameters of third party.

Parameters

int	$id	Id of company (deprecated, use 0 here and call update on an object loaded by a fetch)
User	$user	User who requests the update
int	$call_trigger	0=no, 1=yes
int	$allowmodcodeclient	Inclut modif code client et code compta
int	$allowmodcodefournisseur	Inclut modif code fournisseur et code compta fournisseur
string	$action	'add' or 'update' or 'merge'
int	$nosyncmember	Do not synchronize info of linked member

Returns

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

Definition at line 1350 of file societe.class.php.

References CommonObject\call_trigger(), clean_url(), dol_now(), dol_sanitizeFileName(), dol_syslog(), get_codecompta(), getDolGlobalString(), MultiCurrency\getIdFromCode(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), name, price2num(), setUpperOrLowerCase(), status, and verify().

Referenced by create(), and mergeCompany().

useLocalTax()

Societe::useLocalTax

(

$localTaxNum = 0

)

Check if we must use localtax feature or not according to country (country of $mysoc in most cases).

Parameters

int

$localTaxNum

To get info for only localtax1 or localtax2

Returns

boolean true or false

Definition at line 4584 of file societe.class.php.

useNPR()

Societe::useNPR

(

)

Check if we must use NPR Vat (french stupid rule) or not according to country (country of $mysoc in most cases).

Returns

boolean true or false

Definition at line 4612 of file societe.class.php.

References dol_syslog().

useRevenueStamp()

Societe::useRevenueStamp

(

)

Check if we must use revenue stamps feature or not according to country (country of $mysocin most cases).

Table c_revenuestamp contains the country and value of stamp per invoice.

Returns

boolean true or false

Definition at line 4635 of file societe.class.php.

References dol_syslog().

validateFamilyTree()

Societe::validateFamilyTree	(		$idparent,
			$idchild,
			$counter = 0 )

Check if a thirdparty $idchild is or not inside the parents (or grand parents) of another thirdparty id $idparent.

Parameters

int	$idparent	Id of thirdparty to check
int	$idchild	Id of thirdparty to compare to
int	$counter	Counter to protect against infinite loops

Returns

int Return integer <0 if KO, 0 if OK or 1 if at some level a parent company was the child to compare to

Definition at line 3761 of file societe.class.php.

References dol_syslog(), and validateFamilyTree().

Referenced by setParent(), and validateFamilyTree().

verify()

Societe::verify

(

)

Check properties of third party are ok (like name, third party codes, ...) Used before an add or update.

Returns

int 0 if OK, <0 if KO

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

References check_codeclient(), check_codefournisseur(), getDolGlobalString(), id_prof_exists(), id_prof_verifiable(), isACompany(), isValidEmail(), and name.

Referenced by create(), and update().

---

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

• dolibarr_20.0/htdocs/societe/class/societe.class.php