dolibarr  7.0.0-beta
Public Member Functions | List of all members
Fournisseur Class Reference

Class to manage suppliers. More...

+ Inheritance diagram for Fournisseur:
+ Collaboration diagram for Fournisseur:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNbOfOrders ()
 Return nb of orders. More...
 
 nbOfProductRefs ()
 Returns number of ref prices (not number of products). More...
 
 load_state_board ()
 Load statistics indicators. More...
 
 CreateCategory ($user, $name)
 Create a supplier category. More...
 
 ListArray ()
 Return the suppliers list. More...
 
- Public Member Functions inherited from Societe
 __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='')
 Load a third party from database into memory. More...
 
 searchByName ($name, $type='0', $filters=array(), $exact=false, $case=false, $similar=false, $clause= 'AND')
 Search and fetch thirparties by name. 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_except ($remise, User $user, $desc, $tva_tx=0)
 Add a discount for third party. More...
 
 getAvailableDiscounts ($user='', $filter='', $maxvalue=0)
 Renvoie montant TTC des reductions/avoirs en cours disponibles de la societe. More...
 
 getSalesRepresentatives (User $user)
 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...
 
 LoadSupplierCateg ()
 Charge la liste des categories fournisseurs. More...
 
 AddFournisseurInCategory ($categorie_id)
 Insert link supplier - category. More...
 
 create_from_member (Adherent $member, $socname='', $socalias='')
 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...
 
- 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="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=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 ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. 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)
 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)
 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)
 Fetch array of objects linked to current object. 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='')
 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...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) 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'st 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. 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)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=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='')
 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...
 
 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)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Societe
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 inherited from Societe
 $stcomm_id
 code statut prospect
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 
- 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...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage suppliers.

Definition at line 34 of file fournisseur.class.php.

Constructor & Destructor Documentation

Fournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

Fournisseur::CreateCategory (   $user,
  $name 
)

Create a supplier category.

Parameters
User$userUser asking creation
string$nameCategory name
Returns
int <0 if KO, 0 if OK

Definition at line 155 of file fournisseur.class.php.

References $resql, and dol_syslog().

Fournisseur::getNbOfOrders ( )

Return nb of orders.

Returns
int Nb of orders

Definition at line 59 of file fournisseur.class.php.

References $resql.

Fournisseur::ListArray ( )

Return the suppliers list.

Returns
array Array of suppliers

Definition at line 181 of file fournisseur.class.php.

References $resql, and dol_print_error().

Fournisseur::load_state_board ( )

Load statistics indicators.

Returns
int <0 if KO, >0 if OK

Definition at line 111 of file fournisseur.class.php.

References $resql, and dol_print_error().

Fournisseur::nbOfProductRefs ( )

Returns number of ref prices (not number of products).

Returns
int Nb of ref prices, or <0 if error

Definition at line 85 of file fournisseur.class.php.

References $resql.


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