ProductFournisseur Class Reference

Class to manage predefined suppliers products. More...

Inheritance diagram for ProductFournisseur:

Collaboration diagram for ProductFournisseur:

Public Member Functions
	__construct ($db)
	Constructor.
	remove_fournisseur ($id_fourn)
	Remove all prices for this couple supplier-product.
	remove_product_fournisseur_price ($rowid)
	Remove a price for a couple supplier-product.
	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.
	fetch_product_fournisseur_price ($rowid, $ignore_expression=0)
	Loads the price information of a provider.
	list_product_fournisseur_price ($prodid, $sortfield='', $sortorder='', $limit=0, $offset=0, $socid=0)
	List all supplier prices of a product.
	find_min_price_product_fournisseur ($prodid, $qty=0, $socid=0)
	Load properties for minimum price.
	setSupplierPriceExpression ($expression_id)
	Sets the supplier price expression.
	getSocNomUrl ($withpicto=0, $option='supplier', $maxlen=0, $notooltip=0)
	Display supplier of product.
	display_price_product_fournisseur ($showunitprice=1, $showsuptitle=1, $maxlen=0, $notooltip=0, $productFournList=array())
	Display price of product.
	listProductFournisseurPriceLog ($product_fourn_price_id, $sortfield='', $sortorder='', $limit=0, $offset=0)
	List supplier prices log of a supplier price.
	displayPriceProductFournisseurLog ($productFournLogList=array())
	Display log price of product supplier price.
	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).
	getLibStatut ($mode=0, $type=0)
	Return the label of the status.
	LibStatut ($status, $mode=0, $type=0)
	Return the status.
Public Member Functions inherited from Product
	check ()
	Check that ref and label are ok.
	create ($user, $notrigger=0)
	Insert product into database.
	verify ()
	Check properties of product are ok (like name, barcode, ...).
	check_barcode ($valuetotest, $typefortest)
	Check barcode.
	update ($id, $user, $notrigger=0, $action='update', $updatetype=false)
	Update a record into database.
	delete (User $user, $notrigger=0)
	Delete a product from database (if not used)
	getSellOrEatByMandatoryLabel ()
	Get sell or eat by mandatory label.
	setMultiLangs ($user)
	Update or add a translation for a product.
	delMultiLangs ($langtodelete, $user)
	Delete a language for this product.
	setAccountancyCode ($type, $value)
	Sets an accountancy code for a product.
	getMultiLangs ()
	Load array this->multilangs.
	log_price_delete ($user, $rowid)
	Delete a price line.
	getSellPrice ($thirdparty_seller, $thirdparty_buyer, $pqp=0)
	Return price of sell of a product for a seller/buyer/product.
	get_buyprice ($prodfournprice, $qty, $product_id=0, $fourn_ref='', $fk_soc=0)
	Read price used by a provider.
	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.
	setPriceExpression ($expression_id)
	Sets the supplier price expression.
	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.
	load_stats_mo ($socid=0)
	Charge tableau des stats OF pour le produit/service.
	load_stats_bom ($socid=0)
	Charge tableau des stats OF pour le produit/service.
	load_stats_propale ($socid=0)
	Charge tableau des stats propale pour le produit/service.
	load_stats_proposal_supplier ($socid=0)
	Charge tableau des stats propale pour le produit/service.
	load_stats_commande ($socid=0, $filtrestatut='', $forVirtualStock=0)
	Charge tableau des stats commande client pour le produit/service.
	load_stats_commande_fournisseur ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null)
	Charge tableau des stats commande fournisseur pour le produit/service.
	load_stats_sending ($socid=0, $filtrestatut='', $forVirtualStock=0, $filterShipmentStatus='')
	Charge tableau des stats expedition client pour le produit/service.
	load_stats_reception ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null)
	Charge tableau des stats réception fournisseur pour le produit/service.
	load_stats_inproduction ($socid=0, $filtrestatut='', $forVirtualStock=0, $dateofvirtualstock=null, $warehouseid=0)
	Charge tableau des stats production pour le produit/service.
	load_stats_contrat ($socid=0)
	Charge tableau des stats contrat pour le produit/service.
	load_stats_facture ($socid=0)
	Charge tableau des stats facture pour le produit/service.
	load_stats_facturerec ($socid=0)
	Charge tableau des stats facture recurrentes pour le produit/service.
	load_stats_facture_fournisseur ($socid=0)
	Charge tableau des stats facture pour le produit/service.
	get_nb_vente ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units or customers invoices in which product is included.
	get_nb_achat ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units or supplier invoices in which product is included.
	get_nb_propal ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in proposals in which product is included.
	get_nb_propalsupplier ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in proposals in which product is included.
	get_nb_order ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in orders in which product is included.
	get_nb_ordersupplier ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in orders in which product is included.
	get_nb_contract ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in orders in which product is included.
	get_nb_mos ($socid, $mode, $filteronproducttype=-1, $year=0, $morefilter='')
	Return nb of units in orders in which product is included.
	add_sousproduit ($id_pere, $id_fils, $qty, $incdec=1, $notrigger=0)
	Link a product/service to a parent product/service.
	update_sousproduit ($id_pere, $id_fils, $qty, $incdec=1, $notrigger=0)
	Modify composed product.
	del_sousproduit ($fk_parent, $fk_child, $notrigger=0)
	Remove a link between a subproduct and a parent product/service.
	is_sousproduit ($fk_parent, $fk_child)
	Check if it is a sub-product into a kit.
	add_fournisseur ($user, $id_fourn, $ref_fourn, $quantity)
	Add a supplier price for the product.
	list_suppliers ()
	Return list of suppliers providing the product or service.
	clone_price ($fromId, $toId)
	Recopie les prix d'un produit/service sur un autre.
	clone_associations ($fromId, $toId)
	Clone links between products.
	clone_fournisseurs ($fromId, $toId)
	Recopie les fournisseurs et prix fournisseurs d'un produit/service sur un autre.
	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.
	get_arbo_each_prod ($multiply=1, $ignore_stock_load=0)
	Build the tree of subproducts and return it.
	hasFatherOrChild ($mode=0)
	Count all parent and children products for current product (first level only)
	hasVariants ()
	Return if a product has variants or not.
	isVariant ()
	Return if loaded product is a variant.
	getFather ()
	Return all parent products for current product (first level only)
	getChildsArbo ($id, $firstlevelonly=0, $level=1, $parents=array())
	Return children of product $id.
	get_sousproduits_arbo ()
	getTooltipContentArray ($params)
	getTooltipContentArray
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create a document onto disk according to template module.
	getLibFinished ()
	Retour label of nature of product.
	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.
	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.
	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.
	load_virtual_stock ($includedraftpoforvirtual=null, $dateofvirtualstock=null)
	Load value ->stock_theorique of a product.
	loadBatchInfo ($batch)
	Load existing information about a serial.
	add_photo ($sdir, $file)
	Move an uploaded file described into $file array into target directory $sdir.
	is_photo_available ($sdir)
	Return if at least one photo is available.
	liste_photos ($dir, $nbmax=0)
	Return an array with all photos of product found on disk.
	delete_photo ($file)
	Delete a photo and its thumbs.
	get_image_size ($file)
	Load size of image file.
	loadStateBoard ()
	Load indicators this->nb for the dashboard.
	isProduct ()
	Return if the object is a product.
	isService ()
	Return if the object is a service.
	isStockManaged ()
	Return if the object is managed in stock.
	isMandatoryPeriod ()
	Return if the object has a constraint on mandatory_period.
	hasbatch ()
	Return if the object has a sell-by or eat-by date.
	get_barcode ($object, $type='')
	Get a barcode from the module to generate barcode values.
	initAsSpecimen ()
	Initialise an instance with random values.
	getLabelOfUnit ($type='long')
	Returns the text label from units dictionary.
	min_recommended_price ()
	Return minimum product recommended price.
	setCategories ($categories)
	Sets object to supplied categories.
	generateMultiprices (User $user, $baseprice, $price_type, $price_vat, $npr, $psq)
	Generates prices for a product based on product multiprice generation rules.
	getRights ()
	Returns the rights used for this class.
	info ($id)
	Load information for tab info.
	getProductDurationHours ()
	Return the duration of a service in hours (for a service based on duration fields)
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
	getProductsToPreviewInEmail ($limit)
	Retrieve and display products.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
static	replaceProduct (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a product id with another one.
Static Public Member Functions inherited from Product
static	getSellOrEatByMandatoryList ()
	Get sell or eat by mandatory list.
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

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.

Additional Inherited Members
Public Attributes inherited from Product
const	SELL_OR_EAT_BY_MANDATORY_ID_NONE = 0
	Const sell or eat by mandatory id.
	$stock_warehouse = array()
	Contains detail of stock of product into each warehouse.
const	TYPE_PRODUCT = 0
	Regular product.
const	TYPE_SERVICE = 1
	Service.
Public Attributes inherited from CommonObject
	$origin_object
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.
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

$db

Database handler

Reimplemented from Product.

Definition at line 270 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<0,1>	$showunitprice Show "Unit price" into output string
	int<0,1>	$showsuptitle Show "Supplier" into output string
int	$maxlen	Max length of name
	int<0,1>	$notooltip 1=Disable tooltip
ProductFournisseur[]	$productFournList	list of ProductFournisseur objects to display in table format.

Returns

string String with supplier price

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

References getSocNomUrl(), and price().

displayPriceProductFournisseurLog()

ProductFournisseur::displayPriceProductFournisseurLog

(

$productFournLogList = array()

)

Display log price of product supplier price.

Parameters

array<array{rowid:int,supplier_ref:int,datec:int,lastname:string,price:float,quantity:float,fk_multicurrency:int,multicurrency_code:string,multicurrency_tx:string,multicurrency_price:string,multicurrency_unitprice:string}>|int<-1,-1>

$productFournLogList list of ProductFournisseur price log objects to display in table format.

Returns

string HTML String with supplier price

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

Referenced by getNomUrl().

fetch_product_fournisseur_price()

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

Loads the price information of a provider.

Parameters

int	$rowid	Line id in product_fournisseur_price
int	$ignore_expression	Ignores 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 726 of file fournisseur.product.class.php.

References dol_syslog(), price2num(), and status.

find_min_price_product_fournisseur()

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

Load properties for minimum price.

Parameters

int	$prodid	Product id
float	$qty	Minimum quantity
int	$socid	Load min price for this 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 939 of file fournisseur.product.class.php.

References dol_syslog(), and price2num().

getLibStatut()

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

Return the label of the status.

Parameters

int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
int	$type	Type of product

Returns

string Label of status

Reimplemented from Product.

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

References LibStatut(), and status.

Referenced by getNomUrl().

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	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('nolink', ...)
int	$maxlength	Maxlength of ref
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int	$notooltip	No tooltip
string	$morecss	''=Add more css on link
int	$add_label	0=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 1300 of file fournisseur.product.class.php.

References displayPriceProductFournisseurLog(), dol_trunc(), getDolGlobalString(), getLibStatut(), img_object(), img_picto(), length_accountg(), listProductFournisseurPriceLog(), measuringUnitString(), newToken(), ref, CommonObject\show_photos(), status, type, Product\TYPE_PRODUCT, and Product\TYPE_SERVICE.

getSocNomUrl()

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

Display supplier of product.

Parameters

int	$withpicto	Add picto
string	$option	Target of link ('', 'customer', 'prospect', 'supplier')
int	$maxlen	Max length of name
integer	$notooltip	1=Disable tooltip

Returns

string String with supplier price TODO Remove this method. Use getNomUrl directly.

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

Referenced by display_price_product_fournisseur().

LibStatut()

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

Return the status.

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
int	$type	Type of product

Returns

string Label of status

Reimplemented from Product.

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

Referenced by getLibStatut().

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	$prodid	Id of product
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit
int	$offset	Offset
int	$socid	Filter on a third party id

Returns

ProductFournisseur[]|int<-1,-1> Array of ProductFournisseur with new properties to define supplier price

See also

find_min_price_product_fournisseur()

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

References dol_syslog(), and price2num().

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_id	Id of supplier price
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit
int	$offset	Offset

Returns

array<array{rowid:int,supplier_ref:int,datec:int,lastname:string,price:float,quantity:float,fk_multicurrency:int,multicurrency_code:string,multicurrency_tx:string,multicurrency_price:string,multicurrency_unitprice:string}>|int<-1,-1> Array of Log prices

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

References dol_syslog().

Referenced by getNomUrl(), and update_buyprice().

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	$user	Object user who adds/changes price
integer	$datec	date create
float	$buyprice	price for qty
float	$qty	qty for price
float	$multicurrency_buyprice	Purchase price for the quantity min in currency
float	$multicurrency_unitBuyPrice	Unit Purchase price in currency
float	$multicurrency_tx	Rate currency
int	$fk_multicurrency	key multi currency
string	$multicurrency_code	Currency code

Returns

int Return integer < 0 NOK > 0 OK

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

References price2num().

Referenced by update_buyprice().

remove_fournisseur()

ProductFournisseur::remove_fournisseur

(

$id_fourn

)

Remove all prices for this couple supplier-product.

Parameters

int

$id_fourn

Supplier Id

Returns

int Return integer < 0 if error, > 0 if ok

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

References dol_syslog().

remove_product_fournisseur_price()

ProductFournisseur::remove_product_fournisseur_price

(

$rowid

)

Remove a price for a couple supplier-product.

Parameters

int

$rowid

Line id of price

Returns

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

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

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

replaceProduct()

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

static

Function used to replace a product id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 1181 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	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Reimplemented from Product.

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

References CommonObject\commonReplaceThirdparty().

setSupplierPriceExpression()

ProductFournisseur::setSupplierPriceExpression

(

$expression_id

)

Sets the supplier price expression.

Parameters

int

$expression_id

Expression

Returns

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

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

References dol_syslog().

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	$qty	Min quantity for which price is valid
float	$buyprice	Purchase price for the quantity min
User	$user	Object user user made changes
string	$price_base_type	HT or TTC
Societe	$fourn	Supplier
int	$availability	Product availability
string	$ref_fourn	Supplier ref
float	$tva_tx	New VAT Rate (For example 8.5. Should not be a string)
string | float	$charges	costs affering to product
float	$remise_percent	Discount regarding qty (percent)
float	$remise	Discount regarding qty (amount)
int	$newnpr	Set NPR or not
int	$delivery_time_days	Delay in days for delivery (max). May be '' if not defined.
string	$supplier_reputation	Reputation with this product to the defined supplier (empty, FAVORITE, DONOTORDER)
	array{0:string,1:float|int,2:string,3:float|int}|array{}	$localtaxes_array Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function).
string	$newdefaultvatcode	Default vat code
float	$multicurrency_buyprice	Purchase price for the quantity min in currency
string	$multicurrency_price_base_type	HT or TTC in currency
float	$multicurrency_tx	Rate currency
string	$multicurrency_code	Currency code
string	$desc_fourn	Custom description for product_fourn_price
string	$barcode	Barcode
int	$fk_barcode_type	Barcode type
	array<string,mixed>	$options Extrafields of product fourn price

Returns

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

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

References CommonObject\call_trigger(), dol_now(), dol_syslog(), get_localtax(), getDolGlobalString(), MultiCurrency\getIdFromCode(), listProductFournisseurPriceLog(), logPrice(), and price2num().

---

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

• dolibarr_dev/htdocs/fourn/class/fournisseur.product.class.php