dolibarr  21.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | List of all members
ProductFournisseur Class Reference

Class to manage predefined suppliers products. More...

Inheritance diagram for ProductFournisseur:
Inheritance graph
[legend]
Collaboration diagram for ProductFournisseur:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 remove_fournisseur ($id_fourn)
 Remove all prices for this couple supplier-product. More...
 
 remove_product_fournisseur_price ($rowid)
 Remove a price for a couple supplier-product. More...
 
 update_buyprice ( $qty, $buyprice, $user, $price_base_type, $fourn, $availability, $ref_fourn, $tva_tx, $charges=0, $remise_percent=0, $remise=0, $newnpr=0, $delivery_time_days=0, $supplier_reputation='', $localtaxes_array=array(), $newdefaultvatcode='', $multicurrency_buyprice=0, $multicurrency_price_base_type='HT', $multicurrency_tx=1, $multicurrency_code='', $desc_fourn='', $barcode='', $fk_barcode_type=0, $options=array())
 Modify the purchase price for a supplier. More...
 
 fetch_product_fournisseur_price ($rowid, $ignore_expression=0)
 Loads the price information of a provider. More...
 
 list_product_fournisseur_price ($prodid, $sortfield='', $sortorder='', $limit=0, $offset=0, $socid=0)
 List all supplier prices of a product. More...
 
 find_min_price_product_fournisseur ($prodid, $qty=0, $socid=0)
 Load properties for minimum price. More...
 
 setSupplierPriceExpression ($expression_id)
 Sets the supplier price expression. More...
 
 getSocNomUrl ($withpicto=0, $option='supplier', $maxlen=0, $notooltip=0)
 Display supplier of product. More...
 
 display_price_product_fournisseur ($showunitprice=1, $showsuptitle=1, $maxlen=0, $notooltip=0, $productFournList=array())
 Display price of product. More...
 
 listProductFournisseurPriceLog ($product_fourn_price_id, $sortfield='', $sortorder='', $limit=0, $offset=0)
 List supplier prices log of a supplier price. More...
 
 displayPriceProductFournisseurLog ($productFournLogList=array())
 Display log price of product supplier price. More...
 
 getNomUrl ($withpicto=0, $option='', $maxlength=0, $save_lastsearch_value=-1, $notooltip=0, $morecss='', $add_label=0, $sep=' - ')
 Return a link to the object card (with optionally the picto). More...
 
 getLibStatut ($mode=0, $type=0)
 Return the label of the status. More...
 
 LibStatut ($status, $mode=0, $type=0)
 Return the status. More...
 
- Public Member Functions inherited from Product
 check ()
 Check that ref and label are ok. More...
 
 create ($user, $notrigger=0)
 Insert product into database. More...
 
 verify ()
 Check properties of product are ok (like name, barcode, ...). More...
 
 check_barcode ($valuetotest, $typefortest)
 Check barcode. More...
 
 update ($id, $user, $notrigger=0, $action='update', $updatetype=false)
 Update a record into database. More...
 
 delete (User $user, $notrigger=0)
 Delete a product from database (if not used) More...
 
 getSellOrEatByMandatoryLabel ()
 Get sell or eat by mandatory label. More...
 
 setMultiLangs ($user)
 Update or add a translation for a product. More...
 
 delMultiLangs ($langtodelete, $user)
 Delete a language for this product. More...
 
 setAccountancyCode ($type, $value)
 Sets an accountancy code for a product. More...
 
 getMultiLangs ()
 Load array this->multilangs. More...
 
 log_price_delete ($user, $rowid)
 Delete a price line. More...
 
 getSellPrice ($thirdparty_seller, $thirdparty_buyer, $pqp=0)
 Return price of sell of a product for a seller/buyer/product. More...
 
 get_buyprice ($prodfournprice, $qty, $product_id=0, $fourn_ref='', $fk_soc=0)
 Read price used by a provider. More...
 
 updatePrice ($newprice, $newpricebase, $user, $newvat=null, $newminprice=0, $level=0, $newnpr=0, $newpbq=0, $ignore_autogen=0, $localtaxes_array=array(), $newdefaultvatcode='', $price_label='', $notrigger=0)
 Modify customer price of a product/Service for a given level. More...
 
 setPriceExpression ($expression_id)
 Sets the supplier price expression. More...
 
 fetch ($id=0, $ref='', $ref_ext='', $barcode='', $ignore_expression=0, $ignore_price_load=0, $ignore_lang_load=0)
 Load a product in memory from database. More...
 
 load_stats_mo ($socid=0)
 Charge tableau des stats OF pour le produit/service. More...
 
 load_stats_bom ($socid=0)
 Charge tableau des stats OF pour le produit/service. More...
 
 load_stats_propale ($socid=0)
 Charge tableau des stats propale pour le produit/service. More...
 
 load_stats_proposal_supplier ($socid=0)
 Charge tableau des stats propale pour le produit/service. More...
 
 load_stats_commande ($socid=0, $filtrestatut='', $forVirtualStock=0)
 Charge tableau des stats commande client pour le produit/service. More...
 
 load_stats_commande_fournisseur ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null)
 Charge tableau des stats commande fournisseur pour le produit/service. More...
 
 load_stats_sending ($socid=0, $filtrestatut='', $forVirtualStock=0, $filterShipmentStatus='')
 Charge tableau des stats expedition client pour le produit/service. More...
 
 load_stats_reception ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null)
 Charge tableau des stats réception fournisseur pour le produit/service. More...
 
 load_stats_inproduction ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null, $warehouseid=0)
 Charge tableau des stats production pour le produit/service. More...
 
 load_stats_contrat ($socid=0)
 Charge tableau des stats contrat pour le produit/service. More...
 
 load_stats_facture ($socid=0)
 Charge tableau des stats facture pour le produit/service. More...
 
 load_stats_facturerec ($socid=0)
 Charge tableau des stats facture recurrentes pour le produit/service. More...
 
 load_stats_facture_fournisseur ($socid=0)
 Charge tableau des stats facture pour le produit/service. More...
 
 get_nb_vente ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units or customers invoices in which product is included. More...
 
 get_nb_achat ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units or supplier invoices in which product is included. More...
 
 get_nb_propal ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in proposals in which product is included. More...
 
 get_nb_propalsupplier ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in proposals in which product is included. More...
 
 get_nb_order ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in orders in which product is included. More...
 
 get_nb_ordersupplier ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in orders in which product is included. More...
 
 get_nb_contract ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in orders in which product is included. More...
 
 get_nb_mos ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
 Return nb of units in orders in which product is included. More...
 
 add_sousproduit ($id_pere, $id_fils, $qty, $incdec=1, $notrigger=0)
 Link a product/service to a parent product/service. More...
 
 update_sousproduit ($id_pere, $id_fils, $qty, $incdec=1, $notrigger=0)
 Modify composed product. More...
 
 del_sousproduit ($fk_parent, $fk_child, $notrigger=0)
 Remove a link between a subproduct and a parent product/service. More...
 
 is_sousproduit ($fk_parent, $fk_child)
 Check if it is a sub-product into a kit. More...
 
 add_fournisseur ($user, $id_fourn, $ref_fourn, $quantity)
 Add a supplier price for the product. More...
 
 list_suppliers ()
 Return list of suppliers providing the product or service. More...
 
 clone_price ($fromId, $toId)
 Recopie les prix d'un produit/service sur un autre. More...
 
 clone_associations ($fromId, $toId)
 Clone links between products. More...
 
 clone_fournisseurs ($fromId, $toId)
 Recopie les fournisseurs et prix fournisseurs d'un produit/service sur un autre. More...
 
 fetch_prod_arbo ($prod, $compl_path='', $multiply=1, $level=1, $id_parent=0, $ignore_stock_load=0)
 Function recursive, used only by get_arbo_each_prod(), to build tree of subproducts into ->res Define value of this->res. More...
 
 get_arbo_each_prod ($multiply=1, $ignore_stock_load=0)
 Build the tree of subproducts and return it. More...
 
 hasFatherOrChild ($mode=0)
 Count all parent and children products for current product (first level only) More...
 
 hasVariants ()
 Return if a product has variants or not. More...
 
 isVariant ()
 Return if loaded product is a variant. More...
 
 getFather ()
 Return all parent products for current product (first level only) More...
 
 getChildsArbo ($id, $firstlevelonly=0, $level=1, $parents=array())
 Return children of product $id. More...
 
 get_sousproduits_arbo ()
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Create a document onto disk according to template module. More...
 
 getLibFinished ()
 Retour label of nature of product. More...
 
 correct_stock ($user, $id_entrepot, $nbpiece, $movement, $label='', $price=0, $inventorycode='', $origin_element='', $origin_id=null, $disablestockchangeforsubproduct=0, $extrafields=null)
 Adjust stock in a warehouse for product. More...
 
 correct_stock_batch ($user, $id_entrepot, $nbpiece, $movement, $label='', $price=0, $dlc='', $dluo='', $lot='', $inventorycode='', $origin_element='', $origin_id=null, $disablestockchangeforsubproduct=0, $extrafields=null, $force_update_batch=false)
 Adjust stock in a warehouse for product with batch number. More...
 
 load_stock ($option='', $includedraftpoforvirtual=null, $dateofvirtualstock=null)
 Load information about stock of a product into ->stock_reel, ->stock_warehouse[] (including stock_warehouse[idwarehouse]->detail_batch for batch products) This function need a lot of load. More...
 
 load_virtual_stock ($includedraftpoforvirtual=null, $dateofvirtualstock=null)
 Load value ->stock_theorique of a product. More...
 
 loadBatchInfo ($batch)
 Load existing information about a serial. More...
 
 add_photo ($sdir, $file)
 Move an uploaded file described into $file array into target directory $sdir. More...
 
 is_photo_available ($sdir)
 Return if at least one photo is available. More...
 
 liste_photos ($dir, $nbmax=0)
 Return an array with all photos of product found on disk. More...
 
 delete_photo ($file)
 Delete a photo and its thumbs. More...
 
 get_image_size ($file)
 Load size of image file. More...
 
 loadStateBoard ()
 Load indicators this->nb for the dashboard. More...
 
 isProduct ()
 Return if object is a product. More...
 
 isService ()
 Return if object is a product. More...
 
 isStockManaged ()
 Return if object need to have its stock managed. More...
 
 isMandatoryPeriod ()
 Return if object have a constraint on mandatory_period. More...
 
 hasbatch ()
 Return if object has a sell-by date or eat-by date. More...
 
 get_barcode ($object, $type='')
 Get a barcode from the module to generate barcode values. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 getLabelOfUnit ($type='long')
 Returns the text label from units dictionary. More...
 
 min_recommended_price ()
 Return minimum product recommended price. More...
 
 setCategories ($categories)
 Sets object to supplied categories. More...
 
 generateMultiprices (User $user, $baseprice, $price_type, $price_vat, $npr, $psq)
 Generates prices for a product based on product multiprice generation rules. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 info ($id)
 Load information for tab info. More...
 
 getProductDurationHours ()
 Return the duration of a service in hours (for a service based on duration fields) More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty More...
 
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 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...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. 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 in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 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_project ()
 Load the project with id $this->fk_project into this->project. 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, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 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=0, $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=0, $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='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. 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...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 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, $entity=0)
 Function to check if an object is used by others (by children). 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...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 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...
 
 getExtraField ($key)
 Convenience method for retrieving the value of an extrafield without actually fetching it from the database. More...
 
 setExtraField ($key, $value)
 Convenience method for setting the value of an extrafield without actually updating it in the database. 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...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 Function used to get the logos or photos of an object. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
 Show photos of an object (nbmax maximum), into several columns. 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...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object in the database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed 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='', $remove_existing=true)
 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 $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a product id with another one. More...
 
- Static Public Member Functions inherited from Product
static getSellOrEatByMandatoryList ()
 Get sell or eat by mandatory list. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch. More...
 
static getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
 Function used to get an array with all items linked to an object id in association table. More...
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Public Attributes

 $fourn_ref
 
 $fk_product
 
 $fourn_barcode
 
 $fourn_fk_barcode_type
 
- Public Attributes inherited from Product
const SELL_OR_EAT_BY_MANDATORY_ID_NONE = 0
 Const sell or eat by mandatory id.
 
 $libelle
 
 $multiprices = array()
 Arrays for multiprices.
 
 $price_by_qty
 Price by quantity arrays.
 
 $multilangs = array()
 Array for multilangs.
 
 $default_vat_code
 Default VAT code for product (link to code into llx_c_tva but without foreign keys)
 
 $tva_tx
 Default VAT rate of product.
 
 $tva_npr = 0
 int French VAT NPR is used (0 or 1)
 
 $remise_percent
 Default discount percent.
 
 $localtax1_tx
 Other local taxes.
 
 $pmp
 Average price value for product entry into stock (PMP)
 
 $desiredstock = 0
 Ask for replenishment when $desiredstock < $stock_reel.
 
 $duration_value
 Service expiration.
 
 $duration_unit
 Service expiration unit.
 
 $duration
 Service expiration label (value + unit)
 
 $weight
 Metric of products.
 
 $imgWidth
 Size of image.
 
 $product_fourn_id
 Id du fournisseur.
 
 $product_id_already_linked
 Product ID already linked to a reference supplier.
 
 $stock_warehouse = array()
 Contains detail of stock of product into each warehouse.
 
 $ref_fourn
 
const TYPE_PRODUCT = 0
 Regular product.
 
const TYPE_SERVICE = 1
 Service.
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Private Member Functions

 logPrice ($user, $datec, $buyprice, $qty, $multicurrency_buyprice=null, $multicurrency_unitBuyPrice=null, $multicurrency_tx=null, $fk_multicurrency=null, $multicurrency_code=null)
 Private function to log price history. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements. More...
 
 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 return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 
- Protected Attributes inherited from Product
 $table_ref_field = 'ref'
 {}
 

Detailed Description

Class to manage predefined suppliers products.

Definition at line 41 of file fournisseur.product.class.php.

Constructor & Destructor Documentation

◆ __construct()

ProductFournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented from Product.

Definition at line 222 of file fournisseur.product.class.php.

Member Function Documentation

◆ display_price_product_fournisseur()

ProductFournisseur::display_price_product_fournisseur (   $showunitprice = 1,
  $showsuptitle = 1,
  $maxlen = 0,
  $notooltip = 0,
  $productFournList = array() 
)

Display price of product.

Parameters
int$showunitpriceShow "Unit price" into output string
int$showsuptitleShow "Supplier" into output string
int$maxlenMax length of name
integer$notooltip1=Disable tooltip
array$productFournListlist of ProductFournisseur objects to display in table format.
Returns
string String with supplier price

Definition at line 1077 of file fournisseur.product.class.php.

◆ displayPriceProductFournisseurLog()

ProductFournisseur::displayPriceProductFournisseurLog (   $productFournLogList = array())

Display log price of product supplier price.

Parameters
array$productFournLogListlist of ProductFournisseur price log objects to display in table format.
Returns
string HTML String with supplier price

Definition at line 1207 of file fournisseur.product.class.php.

◆ fetch_product_fournisseur_price()

ProductFournisseur::fetch_product_fournisseur_price (   $rowid,
  $ignore_expression = 0 
)

Loads the price information of a provider.

Parameters
int$rowidLine id
int$ignore_expressionIgnores the math expression for calculating price and uses the db value instead
Returns
int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK

Definition at line 678 of file fournisseur.product.class.php.

◆ find_min_price_product_fournisseur()

ProductFournisseur::find_min_price_product_fournisseur (   $prodid,
  $qty = 0,
  $socid = 0 
)

Load properties for minimum price.

Parameters
int$prodidProduct id
float$qtyMinimum quantity
int$socidget min price for specific supplier
Returns
int Return integer <0 if KO, 0=Not found of no product id provided, >0 if OK
See also
list_product_fournisseur_price()

Definition at line 890 of file fournisseur.product.class.php.

◆ getLibStatut()

ProductFournisseur::getLibStatut (   $mode = 0,
  $type = 0 
)

Return the label of the status.

Parameters
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
int$typeType of product
Returns
string Label of status

Reimplemented from Product.

Definition at line 1412 of file fournisseur.product.class.php.

◆ getNomUrl()

ProductFournisseur::getNomUrl (   $withpicto = 0,
  $option = '',
  $maxlength = 0,
  $save_lastsearch_value = -1,
  $notooltip = 0,
  $morecss = '',
  $add_label = 0,
  $sep = ' - ' 
)

Return a link to the object card (with optionally the picto).

Used getNomUrl of ProductFournisseur if a specific supplier ref is loaded. Otherwise use Product->getNomUrl().

Parameters
int$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string$optionOn what the link point to ('nolink', ...)
int$maxlengthMaxlength of ref
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$notooltipNo tooltip
string$morecss''=Add more css on link
int$add_label0=Default, 1=Add label into string, >1=Add first chars into string
string$sep' - '=Separator between ref and label if option 'add_label' is set
Returns
string String with URL

Reimplemented from Product.

Definition at line 1249 of file fournisseur.product.class.php.

◆ getSocNomUrl()

ProductFournisseur::getSocNomUrl (   $withpicto = 0,
  $option = 'supplier',
  $maxlen = 0,
  $notooltip = 0 
)

Display supplier of product.

Parameters
int$withpictoAdd picto
string$optionTarget of link ('', 'customer', 'prospect', 'supplier')
int$maxlenMax length of name
integer$notooltip1=Disable tooltip
Returns
string String with supplier price TODO Remove this method. Use getNomUrl directly.

Definition at line 1057 of file fournisseur.product.class.php.

◆ LibStatut()

ProductFournisseur::LibStatut (   $status,
  $mode = 0,
  $type = 0 
)

Return the status.

Parameters
int$statusId status
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
int$typeType of product
Returns
string Label of status

Reimplemented from Product.

Definition at line 1426 of file fournisseur.product.class.php.

◆ list_product_fournisseur_price()

ProductFournisseur::list_product_fournisseur_price (   $prodid,
  $sortfield = '',
  $sortorder = '',
  $limit = 0,
  $offset = 0,
  $socid = 0 
)

List all supplier prices of a product.

Parameters
int$prodidId of product
string$sortfieldSort field
string$sortorderSort order
int$limitLimit
int$offsetOffset
int$socidFilter on a third party id
Returns
array|int Array of ProductFournisseur with new properties to define supplier price
See also
find_min_price_product_fournisseur()

Definition at line 778 of file fournisseur.product.class.php.

◆ listProductFournisseurPriceLog()

ProductFournisseur::listProductFournisseurPriceLog (   $product_fourn_price_id,
  $sortfield = '',
  $sortorder = '',
  $limit = 0,
  $offset = 0 
)

List supplier prices log of a supplier price.

Parameters
int$product_fourn_price_idId of supplier price
string$sortfieldSort field
string$sortorderSort order
int$limitLimit
int$offsetOffset
Returns
array|int Array of Log prices

Definition at line 1149 of file fournisseur.product.class.php.

◆ logPrice()

ProductFournisseur::logPrice (   $user,
  $datec,
  $buyprice,
  $qty,
  $multicurrency_buyprice = null,
  $multicurrency_unitBuyPrice = null,
  $multicurrency_tx = null,
  $fk_multicurrency = null,
  $multicurrency_code = null 
)
private

Private function to log price history.

Parameters
User$userObject user who adds/changes price
integer$datecdate create
float$buypriceprice for qty
float$qtyqty for price
float$multicurrency_buypricePurchase price for the quantity min in currency
float$multicurrency_unitBuyPriceUnit Purchase price in currency
float$multicurrency_txRate currency
int$fk_multicurrencykey multi currency
string$multicurrency_codeCurrency code
Returns
int Return integer < 0 NOK > 0 OK

Definition at line 1462 of file fournisseur.product.class.php.

◆ remove_fournisseur()

ProductFournisseur::remove_fournisseur (   $id_fourn)

Remove all prices for this couple supplier-product.

Parameters
int$id_fournSupplier Id
Returns
int Return integer < 0 if error, > 0 if ok

Definition at line 238 of file fournisseur.product.class.php.

◆ remove_product_fournisseur_price()

ProductFournisseur::remove_product_fournisseur_price (   $rowid)

Remove a price for a couple supplier-product.

Parameters
int$rowidLine id of price
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 272 of file fournisseur.product.class.php.

◆ replaceProduct()

static ProductFournisseur::replaceProduct ( DoliDB  $dbs,
  $origin_id,
  $dest_id 
)
static

Function used to replace a product id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 1130 of file fournisseur.product.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Reimplemented from Product.

Definition at line 1113 of file fournisseur.product.class.php.

References CommonObject\commonReplaceThirdparty().

◆ setSupplierPriceExpression()

ProductFournisseur::setSupplierPriceExpression (   $expression_id)

Sets the supplier price expression.

Parameters
int$expression_idExpression
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1022 of file fournisseur.product.class.php.

◆ update_buyprice()

ProductFournisseur::update_buyprice (   $qty,
  $buyprice,
  $user,
  $price_base_type,
  $fourn,
  $availability,
  $ref_fourn,
  $tva_tx,
  $charges = 0,
  $remise_percent = 0,
  $remise = 0,
  $newnpr = 0,
  $delivery_time_days = 0,
  $supplier_reputation = '',
  $localtaxes_array = array(),
  $newdefaultvatcode = '',
  $multicurrency_buyprice = 0,
  $multicurrency_price_base_type = 'HT',
  $multicurrency_tx = 1,
  $multicurrency_code = '',
  $desc_fourn = '',
  $barcode = '',
  $fk_barcode_type = 0,
  $options = array() 
)

Modify the purchase price for a supplier.

Parameters
float$qtyMin quantity for which price is valid
float$buypricePurchase price for the quantity min
User$userObject user user made changes
string$price_base_typeHT or TTC
Societe$fournSupplier
int$availabilityProduct availability
string$ref_fournSupplier ref
float$tva_txNew VAT Rate (For example 8.5. Should not be a string)
string | float$chargescosts affering to product
float$remise_percentDiscount regarding qty (percent)
float$remiseDiscount regarding qty (amount)
int$newnprSet NPR or not
int$delivery_time_daysDelay in days for delivery (max). May be '' if not defined.
string$supplier_reputationReputation with this product to the defined supplier (empty, FAVORITE, DONOTORDER)
array$localtaxes_arrayArray with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).
string$newdefaultvatcodeDefault vat code
float$multicurrency_buypricePurchase price for the quantity min in currency
string$multicurrency_price_base_typeHT or TTC in currency
float$multicurrency_txRate currency
string$multicurrency_codeCurrency code
string$desc_fournCustom description for product_fourn_price
string$barcodeBarcode
int$fk_barcode_typeBarcode type
array$optionsExtrafields of product fourn price
Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 340 of file fournisseur.product.class.php.

Member Data Documentation

◆ $fk_product

ProductFournisseur::$fk_product
Deprecated:
See also
$product_id

Definition at line 93 of file fournisseur.product.class.php.

◆ $fourn_barcode

ProductFournisseur::$fourn_barcode
Deprecated:
See also
$supplier_barcode

Definition at line 190 of file fournisseur.product.class.php.

◆ $fourn_fk_barcode_type

ProductFournisseur::$fourn_fk_barcode_type
Deprecated:
See also
$supplier_fk_barcode_type

Definition at line 201 of file fournisseur.product.class.php.

◆ $fourn_ref

ProductFournisseur::$fourn_ref
Deprecated:
See also
$ref_supplier

Definition at line 67 of file fournisseur.product.class.php.


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