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

Inheritance diagram for Societe:

Collaboration diagram for Societe:

Public Member Functions
	__construct ($db)
	Constructor. More...

	create (User $user)
	Create third party in database. More...

	create_individual (User $user)
	Create a contact/address from thirdparty. More...

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

	update ($id, $user= '', $call_trigger=1, $allowmodcodeclient=0, $allowmodcodefournisseur=0, $action= 'update', $nosyncmember=1)
	Update parameters of third party. More...

	fetch ($rowid, $ref= '', $ref_ext= '', $barcode= '', $idprof1= '', $idprof2= '', $idprof3= '', $idprof4= '', $idprof5= '', $idprof6= '', $email= '', $ref_alias= '')
	Load a third party from database into memory. More...

	delete ($id, User $fuser=null, $call_trigger=1)
	Delete a third party from database and all its dependencies (contacts, rib...) More...

	set_as_client ()
	Define third party as a customer. More...

	set_remise_client ($remise, $note, User $user)
	Defines the company as a customer. More...

	set_remise_supplier ($remise, $note, User $user)
	Defines the company as a customer. More...

	set_remise_except ($remise, User $user, $desc, $vatrate= '', $discount_type=0)
	Add a discount for third party. More...

	getAvailableDiscounts ($user= '', $filter= '', $maxvalue=0, $discount_type=0)
	Returns amount of included taxes of the current discounts/credits available from the company. More...

	getSalesRepresentatives (User $user, $mode=0, $sortfield=null, $sortorder=null)
	Return array of sales representatives. More...

	set_price_level ($price_level, User $user)
	Set the price level. More...

	add_commercial (User $user, $commid)
	Add link to sales representative. More...

	del_commercial (User $user, $commid)
	Add link to sales representative. More...

	getNomUrl ($withpicto=0, $option= '', $maxlen=0, $notooltip=0, $save_lastsearch_value=-1)
	Return a link on thirdparty (with picto) More...

	getLibStatut ($mode=0)
	Return label of status (activity, closed) More...

	LibStatut ($status, $mode=0)
	Return the label of a given status. More...

	thirdparty_and_contact_email_array ($addthirdparty=0)
	Return list of contacts emails existing for third party. More...

	thirdparty_and_contact_phone_array ()
	Return list of contacts mobile phone existing for third party. More...

	contact_property_array ($mode= 'email', $hidedisabled=0)
	Return list of contacts emails or mobile existing for third party. More...

	contact_array ()
	Returns the contact list of this company. More...

	contact_array_objects ()
	Returns the contact list of this company. More...

	contact_get_property ($rowid, $mode)
	Return property of contact from its id. More...

	display_rib ($mode= 'label')
	Return bank number property of thirdparty (label or rum) More...

	get_all_rib ()
	Return Array of RIB. More...

	get_codeclient ($objsoc=0, $type=0)
	Assigns a customer code from the code control module. More...

	get_codefournisseur ($objsoc=0, $type=1)
	Assigns a vendor code from the code control module. More...

	codeclient_modifiable ()
	Check if a client code is editable based on the parameters of the code control module. More...

	codefournisseur_modifiable ()
	Check if a vendor code is editable in the code control module configuration. More...

	check_codeclient ()
	Check customer code. More...

	check_codefournisseur ()
	Check supplier code. More...

	get_codecompta ($type)
	Assigns a accounting code from the accounting code module. More...

	set_parent ($id)
	Define parent commany of current company. More...

	id_prof_verifiable ($idprof)
	Returns if a profid sould be verified to be unique. More...

	id_prof_exists ($idprof, $value, $socid=0)
	Verify if a profid exists into database for others thirds. More...

	id_prof_check ($idprof, $soc)
	Check the validity of a professional identifier according to the country of the company (siren, siret, ...) More...

	id_prof_url ($idprof, $thirdparty)
	Return an url to check online a professional id or empty string. More...

	has_projects ()
	Indicates if the company has projects. More...

	info ($id)
	Load information for tab info. More...

	isACompany ()
	Return if third party is a company (Business) or an end user (Consumer) More...

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

	LoadSupplierCateg ()
	Load the list of provider categories. More...

	AddFournisseurInCategory ($categorie_id)
	Insert link supplier - category. More...

	create_from_member (Adherent $member, $socname= '', $socalias= '', $customercode= '')
	Create a third party into database from a member object. More...

	setMysoc (Conf $conf)
	Set properties with value into $conf. More...

	initAsSpecimen ()
	Initialise an instance with random values. More...

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

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

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

	getLibProspLevel ()
	Return prostect level. More...

	LibProspLevel ($fk_prospectlevel)
	Return label of prospect level. More...

	set_prospect_level (User $user)
	Set prospect level. More...

	getLibProspCommStatut ($mode=0, $label= '')
	Return status of prospect. More...

	LibProspCommStatut ($status, $mode=0, $label= '', $picto= '')
	Return label of a given status. More...

	set_OutstandingBill (User $user)
	Set outstanding value. More...

	getOutstandingProposals ($mode= 'customer')
	Return amount of order not paid and total. More...

	getOutstandingOrders ($mode= 'customer')
	Return amount of order not paid and total. More...

	getOutstandingBills ($mode= 'customer', $late=0)
	Return amount of bill not paid and total. More...

	getLibCustProspStatut ()
	Return label of status customer is prospect/customer. More...

	LibCustProspStatut ($status)
	Return the label of the customer/prospect status. More...

	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module. More...

	setCategories ($categories, $type_categ)
	Sets object to supplied categories. More...

	setSalesRep ($salesrep, $onlyAdd=false)
	Sets sales representatives of the thirdparty. More...

	setThirdpartyType ($typent_id)
	Define third-party type of current company. More...

Public Member Functions inherited from CommonObject
	errorsToString ()
	Method to output saved errors. More...

	getFormatedCustomerRef ($objref)
	Return customer ref for screen output. More...

	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output. More...

	getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
	Return full name (civility+' '+name+' '+lastname) More...

	setUpperOrLowerCase ()
	Set to upper or ucwords/lower if needed. More...

	getKanbanView ($option= '')
	Return clicable link of object (with eventually picto) More...

	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode= '')
	Return full address of contact. More...

	getBannerAddress ($htmlkey, $object)
	Return full address for banner. More...

	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download. More...

	add_contact ($fk_socpeople, $type_contact, $source= 'external', $notrigger=0)
	Add a link between element $this->element and a contact. More...

	copy_linked_contact ($objFrom, $source= 'internal')
	Copy contact from one element to current. More...

	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line. More...

	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line. More...

	delete_linked_contact ($source= '', $code= '')
	Delete all links between an object $this and all its contacts. More...

	liste_contact ($status=-1, $source= 'external', $list=0, $code= '')
	Get array of all contacts for an object. More...

	swapContactStatus ($rowid)
	Update status of a contact linked to object. More...

	liste_type_contact ($source= 'internal', $order= 'position', $option=0, $activeonly=0, $code= '')
	Return array with list of possible values for type of contacts. More...

	listeTypeContacts ($source= 'internal', $option=0, $activeonly=0, $code= '', $element= '', $excludeelement= '')
	Return array with list of possible values for type of contacts. More...

	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code. More...

	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact. More...

	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...

	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...

	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...

	fetch_projet ()
	Load the project with id $this->fk_project into this->project. More...

	fetch_product ()
	Load the product with id $this->fk_product into this->product. More...

	fetch_user ($userid)
	Load the user with id $userid into this->user. More...

	fetch_origin ()
	Read linked origin object. More...

	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field. More...

	getValueFrom ($table, $id, $field)
	Getter generic. More...

	setValueFrom ($field, $value, $table= '', $id=null, $format= '', $id_field= '', $fuser=null, $trigkey= '', $fk_user_field= 'fk_user_modif')
	Setter generic. More...

	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...

	getListContactId ($source= 'external')
	Return list of id of contacts of object. More...

	setProject ($projectid)
	Link element with a project. More...

	setPaymentMethods ($id)
	Change the payments methods. More...

	setMulticurrencyCode ($code)
	Change the multicurrency code. More...

	setMulticurrencyRate ($rate, $mode=1)
	Change the multicurrency rate. More...

	setPaymentTerms ($id)
	Change the payments terms. More...

	setTransportMode ($id)
	Change the transport mode methods. More...

	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms. More...

	setDeliveryAddress ($id)
	Define delivery address. More...

	setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
	Change the shipping method. More...

	setWarehouse ($warehouse_id)
	Change the warehouse. More...

	setDocModel ($user, $modelpdf)
	Set last model used by doc generator. More...

	setBankAccount ($fk_account, $notrigger=false, $userused=null)
	Change the bank account. More...

	line_order ($renum=false, $rowidorder= 'ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines. More...

	getChildrenOfLine ($id, $includealltree=0)
	Get children of line. More...

	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank. More...

	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank. More...

	updateRangOfLine ($rowid, $rang)
	Update position of line (rang) More...

	line_ajaxorder ($rows)
	Update position of line with ajax (rang) More...

	updateLineUp ($rowid, $rang)
	Update position of line up (rang) More...

	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang) More...

	getRangOfLine ($rowid)
	Get position of line (rang) More...

	getIdOfLine ($rang)
	Get rowid of the line relative to its position. More...

	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang) More...

	update_ref_ext ($ref_ext)
	Update external ref of element. More...

	update_note ($note, $suffix= '')
	Update note of element. More...

	update_note_public ($note)
	Update public note (kept for backward compatibility) More...

	update_price ($exclspec=0, $roundingadjust= 'none', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...

	add_object_linked ($origin=null, $origin_id=null)
	Add objects linked in llx_element_element. More...

	fetchObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $clause= 'OR', $alsosametype=1, $orderby= 'sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only). More...

	updateObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '')
	Update object linked of a current object. More...

	deleteObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $rowid= '')
	Delete all links between an object $this. More...

	setStatut ($status, $elementId=null, $elementType= '', $trigkey= '')
	Set status of an object. More...

	getCanvas ($id=0, $ref= '')
	Load type of canvas of an object if it exists. More...

	getSpecialCode ($lineid)
	Get special code of a line. More...

	isObjectUsed ($id=0)
	Function to check if an object is used by others. More...

	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains. More...

	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines. More...

	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...

	setExtraParameters ()
	Set extra parameters. More...

	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir= '/core/tpl')
	Show add free and predefined products/services form. More...

	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir= '/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...

	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir= '/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...

	printOriginLinesList ($restrictlist= '', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...

	printOriginLine ($line, $var, $restrictlist= '', $defaulttpldir= '/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...

	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...

	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line. More...

	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references. More...

	addThumbs ($file)
	Build thumb. More...

	getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
	Return the default value to use for a field when showing the create form of object. More...

	call_trigger ($triggerName, $user)
	Call trigger based on this instance. More...

	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. More...

	setValuesForExtraLanguages ($onlykey= '')
	Fill array_options property of object by extrafields value (using for data sent by forms) More...

	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before. More...

	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...

	deleteExtraFields ()
	Delete all extra fields values for the current object. More...

	insertExtraFields ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...

	insertExtraLanguages ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...

	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object. More...

	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object. More...

	showInputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...

	showOutputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss= '')
	Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...

	showOptionals ($extrafields, $mode= 'view', $params=null, $keysuffix= '', $keyprefix= '', $onetrtd=0)
	Function to show lines of extrafields with output datas. More...

	getJSListDependancies ($type= '_extra')

	getRights ()
	Returns the rights used for this class. More...

	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation. More...

	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
	Show photos of an object (nbmax maximum), into several columns. More...

	isDate ($info)
	Function test if type is date. More...

	isDuration ($info)
	Function test if type is duration. More...

	isInt ($info)
	Function test if type is integer. More...

	isFloat ($info)
	Function test if type is float. More...

	isText ($info)
	Function test if type is text. More...

	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this. More...

	createCommon (User $user, $notrigger=false)
	Create object into database. More...

	fetchCommon ($id, $ref=null, $morewhere= '')
	Load object in memory from the database. More...

	fetchLinesCommon ($morewhere= '')
	Load object in memory from the database. More...

	updateCommon (User $user, $notrigger=false)
	Update object into database. More...

	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database. More...

	deleteByParentField ($parentId=0, $parentField= '')
	Delete all child object from a parent ID. More...

	deleteLineCommon (User $user, $idline, $notrigger=false)
	Delete a line of object in database. More...

	setStatusCommon ($user, $status, $notrigger=0, $triggercode= '')
	Set to a status. More...

	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen. More...

	fetchComments ()
	Load comments linked with current task. More...

	getNbComments ()
	Return nb comments already posted. More...

	trimParameters ($parameters)
	Trim object parameters. More...

	getCategoriesCommon ($type_categ)
	Sets object to given categories. More...

	setCategoriesCommon ($categories, $type_categ)
	Sets object to given categories. More...

	cloneCategories ($fromId, $toId, $type= '')
	Copy related categories to another object. More...

	deleteEcmFiles ($mode=0)
	Delete related files of object in database. More...

Static Public Member Functions
static	replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one. More...

Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref= '', $ref_ext= '')
	Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...

static	commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one. More...

Public Attributes
const	NO_CUSTOMER = 0
	Third party is no customer.

const	CUSTOMER = 1
	Third party is a customer.

const	PROSPECT = 2
	Third party is a prospect.

const	CUSTOMER_AND_PROSPECT = 3
	Third party is a customer and a prospect.

const	NO_SUPPLIER = 0
	Third party is no supplier.

const	SUPPLIER = 1
	Third party is a supplier.

Public Attributes inherited from CommonObject
	$projet

	$note

Additional Inherited Members
Protected Member Functions inherited from CommonObject
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents. More...

	isArray ($info)
	Function test if type is array. More...

	canBeNull ($info)
	Function test if field can be null. More...

	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty. More...

	isIndex ($info)
	Function test if is indexed. More...

	setSaveQuery ()
	Function to prepare a part of the query for insert. More...

	getFieldList ()
	Function to concat keys of fields. More...

	quote ($value, $fieldsentry)
	Add quote to field value if necessary. More...

Detailed Description

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

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

Constructor & Destructor Documentation

Societe::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

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

References db, and fields.

Member Function Documentation

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

Add link to sales representative.

Parameters

User	$user	Object user
int	$commid	Id of user

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

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

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

Referenced by create(), and setSalesRep().

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

References $resql, and db.

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

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

Referenced by verify().

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

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

Referenced by verify().

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

References dol_include_once(), and dol_syslog().

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

References dol_include_once(), and dol_syslog().

Societe::contact_array ( )

Returns the contact list of this company.

Returns: array array of contacts

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

References $resql, db, dol_print_error(), and dolGetFirstLastname().

Societe::contact_array_objects ( )

Returns the contact list of this company.

Returns: array $contacts array of contacts

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

References $resql, db, and dol_print_error().

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

References $resql, db, dol_print_error(), dol_string_nospecial(), and dolGetFirstLastname().

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

References $resql, db, dol_print_error(), and dolGetFirstLastname().

Referenced by thirdparty_and_contact_email_array(), and thirdparty_and_contact_phone_array().

Societe::create ( User $user )

Create third party in database.

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

Parameters

User $user Object of user that ask creation

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

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

References add_commercial(), CommonObject\call_trigger(), db, dol_now(), dol_syslog(), get_codeclient(), get_codefournisseur(), MultiCurrency\getIdFromCode(), name, nom, CommonObject\setUpperOrLowerCase(), update(), and verify().

Referenced by 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 <0 if KO, id of created account if OK

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

References $resql, create(), create_individual(), db, dol_syslog(), CommonObject\getFullName(), name, nom, and setEventMessages().

Societe::create_individual ( User $user )

Create a contact/address from thirdparty.

Parameters

User $user Object user

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

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

References db, and dol_syslog().

Referenced by create_from_member().

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

Add link to sales representative.

Parameters

User	$user	Object user
int	$commid	Id of user

Returns: void

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

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

Referenced by setSalesRep().

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	$fuser	User who ask to delete thirdparty
int	$call_trigger	0=No, 1=yes

Returns: int <0 if KO, 0 if nothing done, >0 if OK

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

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

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

References db.

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

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)

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

References $resql, db, dol_syslog(), getEntity(), name, nom, and price2num().

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 or GETPOST('model','alpha') for example.
Translate	$outputlangs	objet 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 <0 if KO, >0 if OK

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

References CommonObject\commonGenerateDocument(), db, dol_print_error(), dol_strlen(), and print.

Referenced by thirdparty_doc_create().

Societe::get_all_rib ( )

Return Array of RIB.

Returns: array|int 0 if KO, Array of CompanyBanckAccount if OK

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

References db.

Societe::get_codeclient	(	$objsoc = `0`,
		$type = `0`
	)

Assigns a customer code from the code control module.

Return value is stored into this->code_client

Parameters

Societe	$objsoc	Object thirdparty
int	$type	Should be 0 to say customer

Returns: void

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

References dol_include_once(), and dol_syslog().

Referenced by create(), and update().

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

References db, and dol_include_once().

Referenced by update().

Societe::get_codefournisseur	(	$objsoc = `0`,
		$type = `1`
	)

Assigns a vendor code from the code control module.

Return value is stored into this->code_fournisseur

Parameters

Societe	$objsoc	Object thirdparty
int	$type	Should be 1 to say supplier

Returns: void

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

References dol_include_once(), and dol_syslog().

Referenced by create(), and update().

Societe::getAvailableDiscounts	(	$user = `''`,
		$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
integer	$maxvalue	Filter on max value for discount
int	$discount_type	0 => customer discount, 1 => supplier discount

Returns: int <0 if KO, Credit note amount otherwise

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

References db.

Societe::getLibCustProspStatut ( )

Return label of status customer is prospect/customer.

Returns: string Label

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

References LibCustProspStatut().

Societe::getLibProspCommStatut	(	$mode = `0`,
		$label = `''`
	)

Return status of prospect.

Parameters

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

Returns: string Libelle

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

References LibProspCommStatut().

Societe::getLibProspLevel ( )

Return prostect level.

Returns: string Libelle

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

References LibProspLevel().

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

References LibStatut().

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

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 ('', 'customer', 'prospect', 'supplier', 'project')
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

Returns: string String with URL

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

References $_SERVER, dol_escape_htmltag(), dol_trunc(), img_object(), img_picto(), name, and Form\showphoto().

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

Return amount of bill not paid and total.

Parameters

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

Returns: array array('opened'=>Amount, 'total'=>Total amount)

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

References $resql, db, dol_now(), dol_syslog(), and FactureFournisseur\TYPE_CREDIT_NOTE.

Societe::getOutstandingOrders ( $mode = 'customer' )

Return amount of order not paid and total.

Parameters

string $mode 'customer' or 'supplier'

Returns: array array('opened'=>Amount, 'total'=>Total amount)

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

References $resql, db, and dol_syslog().

Societe::getOutstandingProposals ( $mode = 'customer' )

Return amount of order not paid and total.

Parameters

string $mode 'customer' or 'supplier'

Returns: array array('opened'=>Amount, 'total'=>Total amount)

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

References $resql, db, and dol_syslog().

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

Return array of sales representatives.

Parameters

User	$user	Object user
int	$mode	0=Array with properties, 1=Array of id.
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 Array of sales representatives of third party

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

References $resql, db, and dol_print_error().

Referenced by setSalesRep().

Societe::has_projects ( )

Indicates if the company has projects.

Returns: bool true if the company has projects, false otherwise

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

References $resql, db, and print.

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 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
Societe	$soc	Objet societe

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

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

References dol_strlen().

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

References $resql, db, getEntity(), and print.

Referenced by verify().

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

Societe::id_prof_verifiable ( $idprof )

Returns if a profid sould 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 3138 of file societe.class.php.

Referenced by verify().

Societe::info ( $id )

Load information for tab info.

Parameters

int $id Id of thirdparty to load

Returns: void

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

References db, and dol_print_error().

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

References dol_now(), name, and nom.

Societe::isACompany ( )

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

Returns: boolean true=is a company, false=a and user

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

Referenced by get_default_tva(), and verify().

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

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

Referenced by getLibCustProspStatut().

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

References img_action().

Referenced by getLibProspCommStatut().

Societe::LibProspLevel ( $fk_prospectlevel )

Return label of prospect level.

Parameters

int $fk_prospectlevel Prospect level

Returns: string label of level

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

References db.

Referenced by getLibProspLevel().

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

References dolGetStatus().

Referenced by getLibStatut().

Societe::LoadSupplierCateg ( )

Load the list of provider categories.

Returns: int 0 if success, <> 0 if error

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

References $resql, and db.

static Societe::replaceThirdparty	(	DoliDB	$db,
			$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	$db	Database handler
int	$origin_id	Old thirdparty id (will be removed)
int	$dest_id	New thirdparty id

Returns: bool True if success, False if error

Thirdparty commercials cannot be the same in both thirdparties so we look for them and remove some to avoid duplicate. Because this function is meant to be executed within a transaction, we won't take care of begin/commit.

llx_societe_extrafields table must not be here because we don't care about the old thirdparty data Do not include llx_societe because it will be replaced later

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

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

Societe::set_as_client ( )

Define third party as a customer.

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

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

References $resql, and db.

Societe::set_OutstandingBill ( User $user )

Set outstanding value.

Parameters

User $user User making change

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

Deprecated:: Use update function instead

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

References update().

Societe::set_parent ( $id )

Define parent commany of current company.

Parameters

int $id Id of thirdparty to set or '' to remove

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

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

References $resql, db, and dol_syslog().

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

Set the price level.

Parameters

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

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

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

References db, dol_now(), and dol_print_error().

Societe::set_prospect_level ( User $user )

Set prospect level.

Parameters

User $user User who sets the discount

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

Deprecated:: Use update function instead

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

References update().

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

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

References $resql, db, dol_now(), and dol_syslog().

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

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). Exemple: '1.23', '1.23 (ABC)', ...
int	$discount_type	0 => customer discount, 1 => supplier discount

Returns: int <0 if KO, id of discount record if OK

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

References db, and price2num().

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

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

References $resql, db, dol_now(), and dol_syslog().

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

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

References db, and dol_syslog().

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

References db, dol_syslog(), getCountry(), getState(), name, and nom.

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

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

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

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

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

References $resql, db, dol_getIdFromCode(), and dol_syslog().

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

Returns: array Array of contacts emails

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

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

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

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

Societe::update	(	$id,
		$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 <0 if KO, >=0 if OK

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

References $resql, CommonObject\call_trigger(), clean_url(), db, dol_now(), dol_sanitizeFileName(), dol_syslog(), get_codeclient(), get_codecompta(), get_codefournisseur(), MultiCurrency\getIdFromCode(), CommonObject\insertExtraFields(), CommonObject\insertExtraLanguages(), name, nom, price2num(), CommonObject\setUpperOrLowerCase(), and verify().

Referenced by create(), set_OutstandingBill(), and set_prospect_level().

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

References $resql, and db.

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

References $resql, db, and dol_syslog().

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

References $resql, db, and dol_syslog().

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

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

Referenced by create(), and update().

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

htdocs/societe/class/societe.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation