dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
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. 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='', $ref_int='', $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)
 Definit la societe comme un client. More...
 
 set_remise_supplier ($remise, $note, User $user)
 Definit la societe comme un client. More...
 
 set_remise_except ($remise, User $user, $desc, $tva_tx=0, $discount_type=0)
 Add a discount for third party. More...
 
 getAvailableDiscounts ($user='', $filter='', $maxvalue=0, $discount_type=0)
 Renvoie montant TTC des reductions/avoirs en cours disponibles de la societe. More...
 
 getSalesRepresentatives (User $user, $mode=0)
 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 ($statut, $mode=0)
 Renvoi le libelle d'un statut donne. 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 ()
 Renvoie la liste des contacts de cette societe. More...
 
 contact_array_objects ()
 Renvoie la liste des contacts de cette societe. 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)
 Attribut un code client a partir du module de controle des codes. More...
 
 get_codefournisseur ($objsoc=0, $type=1)
 Attribut un code fournisseur a partir du module de controle des codes. More...
 
 codeclient_modifiable ()
 Verifie si un code client est modifiable en fonction des parametres du module de controle des codes. More...
 
 codefournisseur_modifiable ()
 Verifie si un code fournisseur est modifiable dans configuration du module de controle des codes. More...
 
 check_codeclient ()
 Check customer code. More...
 
 check_codefournisseur ()
 Check supplier code. More...
 
 get_codecompta ($type)
 Renvoie un code compta, suivant le module de code compta. More...
 
 set_parent ($id)
 Define parent commany of current company. More...
 
 id_prof_verifiable ($idprof)
 Returns if a profid sould be verified. More...
 
 id_prof_exists ($idprof, $value, $socid=0)
 Verify if a profid exists into database for others thirds. More...
 
 id_prof_check ($idprof, $soc)
 Verifie la validite d'un identifiant professionnel en fonction du pays de la societe (siren, siret, ...) More...
 
 id_prof_url ($idprof, $thirdparty)
 Return an url to check online a professional id or empty string. More...
 
 has_projects ()
 Indique si la societe a des projets. 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 ()
 Charge la liste des categories fournisseurs. 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 ($statut, $mode=0, $label='')
 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')
 Return amount of bill not paid and total. More...
 
 get_OutstandingBill ()
 Return amount of bill not paid. More...
 
 getLibCustProspStatut ()
 Return label of status customer is prospect/customer. More...
 
 LibCustProspStatut ($statut)
 Renvoi le libelle d'un statut donne. 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)
 Sets object to supplied categories. More...
 
 setSalesRep ($salesrep)
 Sets sales representatives of the thirdparty. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 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 ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 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...
 
 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)
 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...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 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...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $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...
 
 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...
 

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

 $stcomm_id
 code statut prospect
 
 $order_min_amount
 Min order amounts.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. 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 43 of file societe.class.php.

Constructor & Destructor Documentation

◆ __construct()

Societe::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

◆ add_commercial()

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

Add link to sales representative.

Parameters
User$userObject user
int$commidId of user
Returns
void

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

◆ AddFournisseurInCategory()

Societe::AddFournisseurInCategory (   $categorie_id)

Insert link supplier - category.

Parameters
int$categorie_idId of category
Returns
int 0 if success, <> 0 if error

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

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

◆ check_codefournisseur()

Societe::check_codefournisseur ( )

Check supplier code.

Returns
int 0 if OK -1 ErrorBadCustomerCodeSyntax -2 ErrorCustomerCodeRequired -3 ErrorCustomerCodeAlreadyUsed -4 ErrorPrefixRequired

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

◆ codeclient_modifiable()

Societe::codeclient_modifiable ( )

Verifie si un code client est modifiable en fonction des parametres du module de controle des codes.

Returns
int 0=No, 1=Yes

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

◆ codefournisseur_modifiable()

Societe::codefournisseur_modifiable ( )

Verifie si un code fournisseur est modifiable dans configuration du module de controle des codes.

Returns
int 0=No, 1=Yes

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

◆ contact_array()

Societe::contact_array ( )

Renvoie la liste des contacts de cette societe.

Returns
array tableau des contacts

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

◆ contact_array_objects()

Societe::contact_array_objects ( )

Renvoie la liste des contacts de cette societe.

Returns
array $contacts tableau des contacts

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

◆ contact_get_property()

Societe::contact_get_property (   $rowid,
  $mode 
)

Return property of contact from its id.

Parameters
int$rowidid of contact
string$mode'email' or 'mobile'
Returns
string Email of contact with format: "Full name <email>"

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

◆ 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$hidedisabled1=Hide contact if disabled
Returns
array Array of contacts emails or mobile. Example: array(id=>'Name <email>')

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

◆ create()

Societe::create ( User  $user)

Create third party in database.

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

Parameters
User$userObject of user that ask creation
Returns
int >= 0 if OK, < 0 if KO

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

◆ create_from_member()

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

Create a third party into database from a member object.

Parameters
Adherent$memberObject member
string$socnameName of third party to force
string$socaliasAlias name of third party to force
string$customercodeCustomer code
Returns
int <0 if KO, id of created account if OK

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

◆ create_individual()

Societe::create_individual ( User  $user)

Create a contact/address from thirdparty.

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

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

◆ del_commercial()

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

Add link to sales representative.

Parameters
User$userObject user
int$commidId of user
Returns
void

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

◆ delete()

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

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

Parameters
int$idId of third party to delete
User$fuserUser who ask to delete thirparty
int$call_trigger0=No, 1=yes
Returns
int <0 if KO, 0 if nothing done, >0 if OK

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

◆ 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 number

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

◆ fetch()

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

Load a third party from database into memory.

Parameters
int$rowidId of third party to load
string$refReference of third party, name (Warning, this can return several records)
string$ref_extExternal reference of third party (Warning, this information is a free field not provided by Dolibarr)
string$ref_intInternal reference of third party (not used by dolibarr)
string$idprof1Prof id 1 of third party (Warning, this can return several records)
string$idprof2Prof id 2 of third party (Warning, this can return several records)
string$idprof3Prof id 3 of third party (Warning, this can return several records)
string$idprof4Prof id 4 of third party (Warning, this can return several records)
string$idprof5Prof id 5 of third party (Warning, this can return several records)
string$idprof6Prof id 6 of third party (Warning, this can return several records)
string$emailEmail of third party (Warning, this can return several records)
string$ref_aliasName_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 1227 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$modeleGenerator to use. Caller must set it to obj->modelpdf or GETPOST('modelpdf') for example.
Translate$outputlangsobjet lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int <0 if KO, >0 if OK

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

◆ get_all_rib()

Societe::get_all_rib ( )

Return Array of RIB.

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

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

◆ get_codeclient()

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

Attribut un code client a partir du module de controle des codes.

Return value is stored into this->code_client

Parameters
Societe$objsocObject thirdparty
int$typeShould be 0 to say customer
Returns
void

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

◆ get_codecompta()

Societe::get_codecompta (   $type)

Renvoie un code compta, suivant le module de code compta.

Peut etre identique a celui saisit ou genere automatiquement. A ce jour seule la generation automatique est implementee

Parameters
string$typeType of thirdparty ('customer' or 'supplier')
Returns
string Code compta si ok, 0 si aucun, <0 si ko

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

◆ get_codefournisseur()

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

Attribut un code fournisseur a partir du module de controle des codes.

Return value is stored into this->code_fournisseur

Parameters
Societe$objsocObject thirdparty
int$typeShould be 1 to say supplier
Returns
void

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

◆ get_OutstandingBill()

Societe::get_OutstandingBill ( )

Return amount of bill not paid.

Returns
int Amount in debt for thirdparty
Deprecated:
See also
getOutstandingBills()

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

◆ getAvailableDiscounts()

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

Renvoie montant TTC des reductions/avoirs en cours disponibles de la societe.

Parameters
User$userFiltre sur un user auteur des remises
string$filterFiltre autre
integer$maxvalueFilter on max value for discount
int$discount_type0 => customer discount, 1 => supplier discount
Returns
int <0 if KO, Credit note amount otherwise

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

◆ getLibCustProspStatut()

Societe::getLibCustProspStatut ( )

Return label of status customer is prospect/customer.

Returns
string Label

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

References LibCustProspStatut().

◆ getLibProspCommStatut()

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

Return status of prospect.

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
string$labelLabel to use for status for added status
Returns
string Libelle

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

◆ getLibProspLevel()

Societe::getLibProspLevel ( )

Return prostect level.

Returns
string Libelle

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

References LibProspLevel().

◆ getLibStatut()

Societe::getLibStatut (   $mode = 0)

Return label of status (activity, closed)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle

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

◆ getNomUrl()

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

Return a link on thirdparty (with picto)

Parameters
int$withpictoAdd picto into link (0=No picto, 1=Include picto with link, 2=Picto only)
string$optionTarget of link ('', 'customer', 'prospect', 'supplier', 'project')
int$maxlenMax length of name
int$notooltip1=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 2005 of file societe.class.php.

◆ getOutstandingBills()

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

Return amount of bill not paid and total.

Parameters
string$mode'customer' or 'supplier'
Returns
array array('opened'=>Amount, 'total'=>Total amount)

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

◆ getOutstandingOrders()

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

◆ getOutstandingProposals()

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

◆ getSalesRepresentatives()

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

Return array of sales representatives.

Parameters
User$userObject user
int$mode0=Array with properties, 1=Array of id.
Returns
array Array of sales representatives of third party

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

◆ has_projects()

Societe::has_projects ( )

Indique si la societe a des projets.

Returns
bool true si la societe a des projets, false sinon

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

◆ id_prof_check()

Societe::id_prof_check (   $idprof,
  $soc 
)

Verifie la validite d'un identifiant professionnel en fonction du pays de la societe (siren, siret, ...)

Parameters
int$idprof1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm)
Societe$socObjet 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 2949 of file societe.class.php.

◆ 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$valueValue of profid
int$socidId of thirdparty to exclude (if update)
Returns
boolean True if exists, False if not

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

◆ id_prof_url()

Societe::id_prof_url (   $idprof,
  $thirdparty 
)

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

Parameters
int$idprof1,2,3,4 (Example: 1=siren,2=siret,3=naf,4=rcs/rm)
Societe$thirdpartyObject thirdparty
Returns
string Url or empty string if no URL known TODO better in a lib than into business class

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

◆ id_prof_verifiable()

Societe::id_prof_verifiable (   $idprof)

Returns if a profid sould be verified.

Parameters
int$idprof1,2,3,4,5,6 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm,5=idprof5,6=idprof6)
Returns
boolean true , false

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

◆ info()

Societe::info (   $id)

Load information for tab info.

Parameters
int$idId of thirdparty to load
Returns
void

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

◆ 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
void

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

◆ isACompany()

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

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

◆ LibCustProspStatut()

Societe::LibCustProspStatut (   $statut)

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
Returns
string Libelle du statut

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

Referenced by getLibCustProspStatut().

◆ LibProspCommStatut()

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

Return label of a given status.

Parameters
int | string$statutId or code for prospection status
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
string$labelLabel to use for status for added status
Returns
string Libelle du statut

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

◆ LibProspLevel()

Societe::LibProspLevel (   $fk_prospectlevel)

Return label of prospect level.

Parameters
int$fk_prospectlevelProspect level
Returns
string label of level

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

Referenced by getLibProspLevel().

◆ LibStatut()

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

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
int$mode0=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 Libelle du statut

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

◆ LoadSupplierCateg()

Societe::LoadSupplierCateg ( )

Charge la liste des categories fournisseurs.

Returns
int 0 if success, <> 0 if error

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

◆ replaceThirdparty()

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$dbDatabase handler
int$origin_idOld thirdparty id (will be removed)
int$dest_idNew 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 4113 of file societe.class.php.

References dol_syslog().

◆ set_as_client()

Societe::set_as_client ( )

Define third party as a customer.

Returns
int <0 if KO, >0 if OK

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

◆ set_OutstandingBill()

Societe::set_OutstandingBill ( User  $user)

Set outstanding value.

Parameters
User$userUser making change
Returns
int <0 if KO, >0 if OK
Deprecated:
Use update function instead

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

References update().

◆ set_parent()

Societe::set_parent (   $id)

Define parent commany of current company.

Parameters
int$idId of thirdparty to set or '' to remove
Returns
int <0 if KO, >0 if OK

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

◆ set_price_level()

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

Set the price level.

Parameters
int$price_levelLevel of price
User$userUse making change
Returns
int <0 if KO, >0 if OK

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

◆ set_prospect_level()

Societe::set_prospect_level ( User  $user)

Set prospect level.

Parameters
User$userUtilisateur qui definie la remise
Returns
int <0 if KO, >0 if OK
Deprecated:
Use update function instead

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

References update().

◆ set_remise_client()

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

Definit la societe comme un client.

Parameters
float$remiseValeur en % de la remise
string$noteNote/Motif de modification de la remise
User$userUtilisateur qui definie la remise
Returns
int <0 if KO, >0 if OK

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

◆ set_remise_except()

Societe::set_remise_except (   $remise,
User  $user,
  $desc,
  $tva_tx = 0,
  $discount_type = 0 
)

Add a discount for third party.

Parameters
float$remiseAmount of discount
User$userUser adding discount
string$descReason of discount
float$tva_txVAT rate
int$discount_type0 => customer discount, 1 => supplier discount
Returns
int <0 if KO, id of discount record if OK

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

◆ set_remise_supplier()

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

Definit la societe comme un client.

Parameters
float$remiseValeur en % de la remise
string$noteNote/Motif de modification de la remise
User$userUtilisateur qui definie la remise
Returns
int <0 if KO, >0 if OK

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

◆ setCategories()

Societe::setCategories (   $categories,
  $type 
)

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$typeCategory type ('customer' or 'supplier')
Returns
int <0 if KO, >0 if OK

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

◆ setMysoc()

Societe::setMysoc ( Conf  $conf)

Set properties with value into $conf.

Parameters
Conf$confConf object (possibility to use another entity)
Returns
void

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

◆ setSalesRep()

Societe::setSalesRep (   $salesrep)

Sets sales representatives of the thirdparty.

Parameters
int[]|int$salesrep User ID or array of user IDs
Returns
int <0 if KO, >0 if OK

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

◆ thirdparty_and_contact_email_array()

Societe::thirdparty_and_contact_email_array (   $addthirdparty = 0)

Return list of contacts emails existing for third party.

Parameters
int$addthirdparty1=Add also a record for thirdparty email
Returns
array Array of contacts emails

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

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

◆ update()

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

Update parameters of third party.

Parameters
int$idId of company (deprecated, use 0 here and call update on an object loaded by a fetch)
User$userUtilisateur qui demande la mise a jour
int$call_trigger0=no, 1=yes
int$allowmodcodeclientInclut modif code client et code compta
int$allowmodcodefournisseurInclut modif code fournisseur et code compta fournisseur
string$action'add' or 'update' or 'merge'
int$nosyncmemberDo not synchronize info of linked member
Returns
int <0 if KO, >=0 if OK

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

Referenced by set_OutstandingBill(), and set_prospect_level().

◆ 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$localTaxNumTo get info for only localtax1 or localtax2
Returns
boolean true or false

Definition at line 3513 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 3537 of file societe.class.php.

◆ useRevenueStamp()

Societe::useRevenueStamp ( )

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

Returns
boolean true or false

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

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


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