Product Class Reference

Class to manage products or services. More...

Inheritance diagram for Product:

Collaboration diagram for Product:

Public Member Functions
	__construct ($db)
	Constructor.
	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
	getNomUrl ($withpicto=0, $option='', $maxlength=0, $save_lastsearch_value=-1, $notooltip=0, $morecss='', $add_label=0, $sep=' - ')
	Return clickable link of object (with eventually picto)
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create a document onto disk according to template module.
	getLibStatut ($mode=0, $type=0)
	Return label of status of object.
	LibStatut ($status, $mode=0, $type=0)
	Return label of a given status.
	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	getSellOrEatByMandatoryList ()
	Get sell or eat by mandatory list.
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
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.

Public Attributes
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 Attributes
	$table_ref_field = 'ref'
	{}

Private Member Functions
	getArrayForPriceCompare ($level=0)
	used to check if price have really change to avoid log pollution
	_log_price ($user, $level=0)
	Insert a track that we changed a customer price.
	_get_stats ($sql, $mode, $year=0)
	Return an array formatted for showing graphs.

Additional Inherited Members
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.

Detailed Description

Class to manage products or services.

Definition at line 49 of file product.class.php.

Constructor & Destructor Documentation

__construct()

Product::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in ProductFournisseur.

Definition at line 876 of file product.class.php.

Member Function Documentation

_get_stats()

Product::_get_stats ( $sql, $mode, $year = 0 )

private

Return an array formatted for showing graphs.

Parameters

string	$sql	Request to execute
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$year	Year (0=current year, -1=all years)

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4274 of file product.class.php.

References dol_mktime(), dol_print_date(), dol_strlen(), and dol_trunc().

Referenced by get_nb_achat(), get_nb_contract(), get_nb_mos(), get_nb_order(), get_nb_ordersupplier(), get_nb_propal(), get_nb_propalsupplier(), and get_nb_vente().

_log_price()

Product::_log_price ( $user, $level = 0 )

private

Insert a track that we changed a customer price.

Parameters

User	$user	User making change
int	$level	price level to change

Returns

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

Definition at line 2225 of file product.class.php.

References dol_now(), dol_print_error(), dol_syslog(), price(), price2num(), and status.

Referenced by create(), and updatePrice().

add_fournisseur()

Product::add_fournisseur	(		$user,
			$id_fourn,
			$ref_fourn,
			$quantity )

Add a supplier price for the product.

Note: Duplicate ref is accepted for different quantity only, or for different companies.

Parameters

User	$user	User that make link
int	$id_fourn	Supplier id
string	$ref_fourn	Supplier ref
float	$quantity	Quantity minimum for price

Returns

int<-3,1> Return integer < 0 if KO, 0 if link already exists for this product, > 0 if OK

Definition at line 5002 of file product.class.php.

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

add_photo()

Product::add_photo	(		$sdir,
			$file )

Move an uploaded file described into $file array into target directory $sdir.

Parameters

string	$sdir	Target directory
	array{name:string,tmp_name:string}	$file Array of file info of file to upload: array('name'=>..., 'tmp_name'=>...)

Returns

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

Definition at line 6374 of file product.class.php.

References CommonObject\addThumbs(), dol_mkdir(), dol_move_uploaded_file(), dol_osencode(), getDolGlobalInt(), and ref.

add_sousproduit()

Product::add_sousproduit	(		$id_pere,
			$id_fils,
			$qty,
			$incdec = 1,
			$notrigger = 0 )

Link a product/service to a parent product/service.

Parameters

int	$id_pere	Id of parent product/service
int	$id_fils	Id of child product/service
float	$qty	Quantity
int	$incdec	1=Increase/decrease stock of child when parent stock increase/decrease
int	$notrigger	Disable triggers

Returns

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

Definition at line 4774 of file product.class.php.

References CommonObject\call_trigger(), del_sousproduit(), dol_print_error(), dol_syslog(), and price2num().

check()

Product::check

(

)

Check that ref and label are ok.

Returns

int >1 if OK, <=0 if KO

Definition at line 891 of file product.class.php.

References dol_sanitizeFileName(), dol_strlen(), getDolGlobalInt(), and ref.

check_barcode()

Product::check_barcode	(		$valuetotest,
			$typefortest )

Check barcode.

Parameters

string	$valuetotest	Value to test
string	$typefortest	Type of barcode (ISBN, EAN, ...)

Returns

int 0 if OK -1 ErrorBadBarCodeSyntax -2 ErrorBarCodeRequired -3 ErrorBarCodeAlreadyUsed

Definition at line 1292 of file product.class.php.

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

Referenced by verify().

clone_associations()

Product::clone_associations	(		$fromId,
			$toId )

Clone links between products.

Parameters

int	$fromId	Product id
int	$toId	Product id

Returns

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

Definition at line 5220 of file product.class.php.

References dol_syslog().

clone_fournisseurs()

Product::clone_fournisseurs	(		$fromId,
			$toId )

Recopie les fournisseurs et prix fournisseurs d'un produit/service sur un autre.

Parameters

int	$fromId	Id produit source
int	$toId	Id produit cible

Returns

int Return integer < 0 si erreur, > 0 si ok

Definition at line 5247 of file product.class.php.

References dol_now(), and dol_syslog().

clone_price()

Product::clone_price	(		$fromId,
			$toId )

Recopie les prix d'un produit/service sur un autre.

Parameters

int	$fromId	Id product source
int	$toId	Id product target

Returns

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

Definition at line 5132 of file product.class.php.

References dol_now(), and dol_syslog().

correct_stock()

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.

Parameters

User	$user	user asking change
int	$id_entrepot	id of warehouse
float	$nbpiece	nb of units (should be always positive, use $movement to decide if we add or remove)
	int<0,1>	$movement 0 = add, 1 = remove
string	$label	Label of stock movement
float	$price	Unit price HT of product, used to calculate average weighted price (PMP in french). If 0, average weighted price is not changed.
string	$inventorycode	Inventory code
string	$origin_element	Origin element type
?int	$origin_id	Origin id of element
int	$disablestockchangeforsubproduct	Disable stock change for sub-products of kit (useful only if product is a subproduct)
?ExtraFields	$extrafields	Array of extrafields

Returns

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

Definition at line 6019 of file product.class.php.

Referenced by update().

correct_stock_batch()

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.

Parameters

User	$user	user asking change
int	$id_entrepot	id of warehouse
float	$nbpiece	nb of units (should be always positive, use $movement to decide if we add or remove)
	int<0,1>	$movement 0 = add, 1 = remove
string	$label	Label of stock movement
float	$price	Price to use for stock eval
int | string	$dlc	eat-by date
int | string	$dluo	sell-by date
string	$lot	Lot number
string	$inventorycode	Inventory code
string	$origin_element	Origin element type
?int	$origin_id	Origin id of element
int	$disablestockchangeforsubproduct	Disable stock change for sub-products of kit (useful only if product is a subproduct)
?ExtraFields	$extrafields	Array of extrafields
boolean	$force_update_batch	Force update batch

Returns

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

Definition at line 6082 of file product.class.php.

Referenced by update().

create()

Product::create	(		$user,
			$notrigger = 0 )

Insert product into database.

Parameters

User	$user	User making insert
int	$notrigger	Disable triggers

Returns

int Id of product/service if OK, < 0 if KO

Definition at line 922 of file product.class.php.

References _log_price(), CommonObject\call_trigger(), dol_include_once(), dol_now(), dol_sanitizeFileName(), dol_string_nospecial(), dol_strlen(), dol_syslog(), get_barcode(), getDolGlobalInt(), getDolGlobalString(), price(), price2num(), ref, status, type, update(), and verify().

del_sousproduit()

Product::del_sousproduit	(		$fk_parent,
			$fk_child,
			$notrigger = 0 )

Remove a link between a subproduct and a parent product/service.

Parameters

int	$fk_parent	Id of parent product (child will no more be linked to it)
int	$fk_child	Id of child product
int	$notrigger	Disable triggers

Returns

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

Definition at line 4899 of file product.class.php.

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

Referenced by add_sousproduit().

delete()

Product::delete	(	User	$user,
			$notrigger = 0 )

Delete a product from database (if not used)

Parameters

User	$user	User (object) deleting product
int	$notrigger	Do not execute trigger

Returns

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

Definition at line 1752 of file product.class.php.

References CommonObject\call_trigger(), CommonObject\deleteEcmFiles(), CommonObject\deleteExtraFields(), dol_delete_dir_recursive(), dol_sanitizeFileName(), dol_syslog(), User\hasRight(), CommonObject\isObjectUsed(), isProduct(), and ref.

delete_photo()

Product::delete_photo

(

$file

)

Delete a photo and its thumbs.

Parameters

string

$file

Path to image file

Returns

void

Definition at line 6517 of file product.class.php.

References dol_delete_file(), and dol_osencode().

delMultiLangs()

Product::delMultiLangs	(		$langtodelete,
			$user )

Delete a language for this product.

Parameters

string	$langtodelete	Language code to delete
User	$user	Object user making delete

Returns

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

Definition at line 2060 of file product.class.php.

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

fetch()

Product::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.

Parameters

int	$id	Id of product/service to load
string	$ref	Ref of product/service to load
string	$ref_ext	Ref ext of product/service to load
string	$barcode	Barcode of product/service to load
int	$ignore_expression	When module dynamicprices is on, ignores the math expression for calculating price and uses the db value instead
int	$ignore_price_load	Load product without loading $this->multiprices... array (when we are sure we don't need them)
int	$ignore_lang_load	Load product without loading $this->multilangs language arrays (when we are sure we don't need them)

Returns

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

French VAT NPR

Local taxes

Definition at line 2852 of file product.class.php.

References description, dol_syslog(), CommonObject\fetch_optionals(), getCountry(), getDolGlobalInt(), getDolGlobalString(), getMultiLangs(), price(), price2num(), ref, status, and type.

fetch_prod_arbo()

Product::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.

Parameters

array	$prod	Products array
string	$compl_path	Directory path of parents to add before
int	$multiply	Because each sublevel must be multiplicated by parent nb
int	$level	Init level
int	$id_parent	Id parent
int	$ignore_stock_load	Ignore stock load

Returns

void

Definition at line 5298 of file product.class.php.

References fetch_prod_arbo(), and getDolGlobalString().

Referenced by fetch_prod_arbo(), and get_arbo_each_prod().

generateDocument()

Product::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0 )

Create a document onto disk according to template module.

Parameters

string	$modele	Force model to use ('' to not force)
Translate	$outputlangs	Object langs to use for output
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref

Returns

int 0 if KO, 1 if OK

Definition at line 5853 of file product.class.php.

References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().

generateMultiprices()

Product::generateMultiprices	(	User	$user,
			$baseprice,
			$price_type,
			$price_vat,
			$npr,
			$psq )

Generates prices for a product based on product multiprice generation rules.

Parameters

User	$user	User that updates the prices
float	$baseprice	Base price
string	$price_type	Base price type
float	$price_vat	VAT % tax
int	$npr	NPR
	int<0,1>	$psq 1 if it has price by quantity

Returns

int -1 KO, 1 OK

Definition at line 6845 of file product.class.php.

References getDolGlobalInt(), and updatePrice().

Referenced by updatePrice().

get_arbo_each_prod()

Product::get_arbo_each_prod	(		$multiply = 1,
			$ignore_stock_load = 0 )

Build the tree of subproducts and return it.

this->sousprods must have been loaded by this->get_sousproduits_arbo()

Parameters

int	$multiply	Because each sublevel must be multiplicated by parent nb
int	$ignore_stock_load	Ignore stock load

Returns

array<int,array{id:int,id_parent:int,ref:string,nb:int,nb_total:int,stock:float,stock_alert:float,label:string,fullpath:string,type:int,desiredstick:float,level:int,incdec:int<0,1>,entity:CommonObject}> Array with tree

Definition at line 5361 of file product.class.php.

References fetch_prod_arbo().

get_barcode()

Product::get_barcode	(		$object,
			$type = '' )

Get a barcode from the module to generate barcode values.

Return value is stored into this->barcode

Parameters

Product	$object	Object product or service
string	$type	Barcode type (ean, isbn, ...)

Returns

string

Definition at line 6660 of file product.class.php.

References $object, dol_include_once(), dol_syslog(), and getDolGlobalString().

Referenced by create(), and update().

get_buyprice()

Product::get_buyprice	(		$prodfournprice,
			$qty,
			$product_id = 0,
			$fourn_ref = '',
			$fk_soc = 0 )

Read price used by a provider.

We enter as input couple prodfournprice/qty or triplet qty/product_id/fourn_ref. This also set some properties on product like ->buyprice, ->fourn_pu, ...

Parameters

int	$prodfournprice	Id du tarif = rowid table product_fournisseur_price
	float|int<-1,-1>	$qty Quantity asked or -1 to get first entry found
int	$product_id	Filter on a particular product id
string	$fourn_ref	Filter on a supplier price ref. 'none' to exclude ref in search.
int	$fk_soc	If of supplier

Returns

int|string|mixed[] Return integer <-1 if KO, -1 if qty not enough, 0 if OK but nothing found, id_product if OK and found. May also initialize some properties like (->ref_supplier, buyprice, fourn_pu, vatrate_supplier...), or printable result of hook

See also

getSellPrice(), find_min_price_product_fournisseur()

Definition at line 2461 of file product.class.php.

References dol_syslog(), and getDolGlobalString().

get_image_size()

Product::get_image_size

(

$file

)

Load size of image file.

Parameters

string

$file

Path to file

Returns

void

Definition at line 6551 of file product.class.php.

References dol_osencode().

get_nb_achat()

Product::get_nb_achat	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units or supplier invoices in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4407 of file product.class.php.

References _get_stats().

get_nb_contract()

Product::get_nb_contract	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in orders in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4667 of file product.class.php.

References _get_stats().

get_nb_mos()

Product::get_nb_mos	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in orders in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4721 of file product.class.php.

References _get_stats().

get_nb_order()

Product::get_nb_order	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in orders in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4563 of file product.class.php.

References _get_stats().

get_nb_ordersupplier()

Product::get_nb_ordersupplier	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in orders in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4615 of file product.class.php.

References _get_stats().

get_nb_propal()

Product::get_nb_propal	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in proposals in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities, 'byamount'=amount
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4459 of file product.class.php.

References _get_stats().

get_nb_propalsupplier()

Product::get_nb_propalsupplier	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units in proposals in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4511 of file product.class.php.

References _get_stats().

get_nb_vente()

Product::get_nb_vente	(		$socid,
			$mode,
			$filteronproducttype = -1,
			$year = 0,
			$morefilter = '' )

Return nb of units or customers invoices in which product is included.

Parameters

int	$socid	Limit count on a particular third party id
string	$mode	'byunit'=number of unit, 'bynumber'=nb of entities
int	$filteronproducttype	0=To filter on product only, 1=To filter on services only
int	$year	Year (0=last 12 month, -1=all years)
string	$morefilter	More sql filters

Returns

array<int<0,11>,array<int,int|float>>|int<-1,-1> Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11

Definition at line 4354 of file product.class.php.

References _get_stats().

get_sousproduits_arbo()

Product::get_sousproduits_arbo

(

)

Return tree of all subproducts for product. Tree contains array of array(0=prodid, 1=>qty, 2=>product type, 3=>label, 4=>incdec, 5=>product ref)
Set this->sousprods

Returns

void

Definition at line 5580 of file product.class.php.

References getChildsArbo().

getArrayForPriceCompare()

Product::getArrayForPriceCompare ( $level = 0 )

private

used to check if price have really change to avoid log pollution

Parameters

int

$level

price level to change

Returns

array{level:int,multiprices:float,multiprices_ttc:float,multiprices_base_type:string,multiprices_min:float,multiprices_min_ttc:float,multiprices_tva_tx:float,multiprices_recuperableonly:float}|array{}

Definition at line 2188 of file product.class.php.

Referenced by updatePrice().

getChildsArbo()

Product::getChildsArbo	(		$id,
			$firstlevelonly = 0,
			$level = 1,
			$parents = array() )

Return children of product $id.

Parameters

int	$id	Id of product to search children of
int	$firstlevelonly	Return only direct child
int	$level	Level of recursing call (start to 1)
int[]	$parents	Array of all parents of $id

Returns

array<int,array{0:int,1:float,2:int,3:string,4:int,5:string}>|array{}|int<-1,-1> Return array(prodid=>array(0=prodid, 1=>qty, 2=>product type, 3=>label, 4=>incdec, 5=>product ref,6:int,7:int)

Definition at line 5506 of file product.class.php.

References dol_print_error(), dol_syslog(), and getChildsArbo().

Referenced by get_sousproduits_arbo(), and getChildsArbo().

getFather()

Product::getFather

(

)

Return all parent products for current product (first level only)

Returns

array|int Array of product

See also

hasFatherOrChild()

Definition at line 5465 of file product.class.php.

References dol_print_error().

Referenced by load_stats_commande(), load_stats_contrat(), load_stats_facture(), load_stats_facturerec(), load_stats_propale(), and load_stats_sending().

getKanbanView()

Product::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	?array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

Definition at line 6989 of file product.class.php.

References dol_escape_htmltag(), getLibStatut(), getNomUrl(), img_picto(), is_photo_available(), isProduct(), isService(), price(), CommonObject\show_photos(), and status.

getLabelOfUnit()

Product::getLabelOfUnit

(

$type = 'long'

)

Returns the text label from units dictionary.

Parameters

string

$type

Label type (long or short)

Returns

string|int Return integer <0 if ko, label if ok

Definition at line 6739 of file product.class.php.

References dol_syslog().

getLibFinished()

Product::getLibFinished

(

)

Retour label of nature of product.

Returns

string|int Return label or ''. -1 if error

Definition at line 5978 of file product.class.php.

References dol_syslog().

getLibStatut()

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

Return label of status of object.

Parameters

int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
int	$type	0=Sell, 1=Buy, 2=Batch Number management

Returns

string Label of status

Reimplemented in ProductFournisseur.

Definition at line 5877 of file product.class.php.

References LibStatut(), and status.

Referenced by getKanbanView(), and getTooltipContentArray().

getMultiLangs()

Product::getMultiLangs

(

)

Load array this->multilangs.

Returns

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

Definition at line 2152 of file product.class.php.

References description.

Referenced by fetch().

getNomUrl()

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

Return clickable link of object (with eventually picto)

Parameters

int	$withpicto	Add picto into link
string	$option	Where point the link ('stock', 'composition', 'category', 'supplier', '')
int	$maxlength	Maxlength of ref
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values when clicking
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 in ProductFournisseur.

Definition at line 5749 of file product.class.php.

References dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), img_object(), isProduct(), isService(), and type.

Referenced by getKanbanView().

getProductDurationHours()

Product::getProductDurationHours

(

)

Return the duration of a service in hours (for a service based on duration fields)

Returns

float|-1 Duration in hours if OK, -1 if KO

Definition at line 6951 of file product.class.php.

getProductsToPreviewInEmail()

Product::getProductsToPreviewInEmail

(

$limit

)

Retrieve and display products.

Parameters

int

$limit

The maximum number of results to return.

Returns

array<int, array<string, mixed>>|int return array if OK, -1 if KO

Definition at line 7052 of file product.class.php.

References dol_print_error(), and getEntity().

getRights()

Product::getRights

(

)

Returns the rights used for this class.

Returns

Object

Reimplemented from CommonObject.

Definition at line 6900 of file product.class.php.

References isProduct().

getSellOrEatByMandatoryLabel()

Product::getSellOrEatByMandatoryLabel

(

)

Get sell or eat by mandatory label.

Returns

string Sell or eat by mandatory label

Definition at line 1930 of file product.class.php.

References getSellOrEatByMandatoryList().

getSellOrEatByMandatoryList()

static Product::getSellOrEatByMandatoryList ( )

static

Get sell or eat by mandatory list.

Returns

array{0:string,1:string,2:string,3:string} Sell or eat by mandatory list

Definition at line 1911 of file product.class.php.

Referenced by getSellOrEatByMandatoryLabel().

getSellPrice()

Product::getSellPrice	(		$thirdparty_seller,
			$thirdparty_buyer,
			$pqp = 0 )

Return price of sell of a product for a seller/buyer/product.

Parameters

Societe	$thirdparty_seller	Seller
Societe	$thirdparty_buyer	Buyer
int	$pqp	Id of product price per quantity if a selection was done of such a price

Returns

array{pu_ht:float|int|string,pu_ttc:float|int|string,price_min:float|int|string,price_base_type:string,tva_tx:float|string|null|int,tva_npr:float|int}

See also

get_buyprice(), find_min_price_product_fournisseur()

Definition at line 2292 of file product.class.php.

References get_default_npr(), get_default_tva(), getDolGlobalString(), and price().

getTooltipContentArray()

Product::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Returns

array<string,string> Data to show in tooltip

Since

v18

Reimplemented from CommonObject.

Definition at line 5600 of file product.class.php.

References description, dolGetFirstLineOfText(), getDolGlobalString(), getLibStatut(), img_picto(), isProduct(), isService(), isStockManaged(), length_accountg(), measuringUnitString(), price(), ref, CommonObject\show_photos(), status, and type.

Referenced by getNomUrl().

hasbatch()

Product::hasbatch

(

)

Return if the object has a sell-by or eat-by date.

Returns

boolean True if the object has a sell-by or eat-by date, false otherwise.

Definition at line 6645 of file product.class.php.

Referenced by load_stock(), and update().

hasFatherOrChild()

Product::hasFatherOrChild

(

$mode = 0

)

Count all parent and children products for current product (first level only)

Parameters

int

$mode

0=Both parent and child, -1=Parents only, 1=Children only

Returns

int Nb of father + child

See also

getFather(), get_sousproduits_arbo()

Definition at line 5383 of file product.class.php.

hasVariants()

Product::hasVariants

(

)

Return if a product has variants or not.

Returns

int Number of variants

Definition at line 5415 of file product.class.php.

info()

Product::info

(

$id

)

Load information for tab info.

Parameters

int

$id

Id of thirdparty to load

Returns

void

Definition at line 6917 of file product.class.php.

References dol_print_error(), and ref.

initAsSpecimen()

Product::initAsSpecimen

(

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns

int

Definition at line 6692 of file product.class.php.

References description, dol_now(), ref, and status.

is_photo_available()

Product::is_photo_available

(

$sdir

)

Return if at least one photo is available.

Parameters

string

$sdir

Directory to scan

Returns

boolean True if at least one photo is available, False if not

Definition at line 6418 of file product.class.php.

References dol_is_file(), dol_osencode(), getDolGlobalInt(), image_format_supported(), and utf8_check().

Referenced by getKanbanView().

is_sousproduit()

Product::is_sousproduit	(		$fk_parent,
			$fk_child )

Check if it is a sub-product into a kit.

Parameters

int	$fk_parent	Id of parent kit product
int	$fk_child	Id of child product

Returns

int<-1,1> Return 1 or 0; -1 if error

Definition at line 4962 of file product.class.php.

References dol_print_error().

isMandatoryPeriod()

Product::isMandatoryPeriod

(

)

Return if the object has a constraint on mandatory_period.

Returns

boolean True if mandatory_period is set to 1, false otherwise.

Definition at line 6635 of file product.class.php.

isProduct()

Product::isProduct

(

)

Return if the object is a product.

Returns

boolean True if the object is a product, false otherwise.

Definition at line 6605 of file product.class.php.

References type, and TYPE_PRODUCT.

Referenced by delete(), getKanbanView(), getNomUrl(), getRights(), getTooltipContentArray(), isStockManaged(), and update().

isService()

Product::isService

(

)

Return if the object is a service.

Returns

boolean True if the object is a service, false otherwise.

Definition at line 6615 of file product.class.php.

References type, and TYPE_SERVICE.

Referenced by getKanbanView(), getNomUrl(), getTooltipContentArray(), and update().

isStockManaged()

Product::isStockManaged

(

)

Return if the object is managed in stock.

Returns

boolean True if the object is managed in stock, false otherwise.

Definition at line 6625 of file product.class.php.

References getDolGlobalString(), and isProduct().

Referenced by getTooltipContentArray().

isVariant()

Product::isVariant

(

)

Return if loaded product is a variant.

Returns

bool|int Return true if the product is a variant, false if not, -1 if error

Definition at line 5438 of file product.class.php.

References dol_print_error(), and getEntity().

LibStatut()

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

Return label of a given status.

Parameters

int	$status	Statut
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	0=Status "to sell", 1=Status "to buy", 2=Status "to Batch"

Returns

string Label of status

Reimplemented in ProductFournisseur.

Definition at line 5901 of file product.class.php.

References LibStatut().

Referenced by getLibStatut(), and LibStatut().

list_suppliers()

Product::list_suppliers

(

)

Return list of suppliers providing the product or service.

Returns

int[] Array of vendor ids

Definition at line 5098 of file product.class.php.

liste_photos()

Product::liste_photos	(		$dir,
			$nbmax = 0 )

Return an array with all photos of product found on disk.

There is no sorting criteria.

Parameters

string	$dir	Directory to scan
int	$nbmax	Number maximum of photos (0=no maximum)

Returns

array<array{photo:string,photo_vignette:string}> Array of photos

Definition at line 6457 of file product.class.php.

References dol_is_file(), dol_osencode(), image_format_supported(), and utf8_check().

load_stats_bom()

Product::load_stats_bom

(

$socid = 0

)

Charge tableau des stats OF pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_bom, <0 if ko or >0 if ok

Definition at line 3336 of file product.class.php.

References price2num().

load_stats_commande()

Product::load_stats_commande	(		$socid = 0,
			$filtrestatut = '',
			$forVirtualStock = 0 )

Charge tableau des stats commande client pour le produit/service.

Parameters

int	$socid	Id thirdparty to filter on a thirdparty
string	$filtrestatut	Id status to filter on a status
int	$forVirtualStock	Ignore rights filter for virtual stock calculation. Set when load_stats_commande is used for virtual stock calculation.

Returns

integer Array of stats in $this->stats_commande (nb=nb of order, qty=qty ordered), <0 if ko or >0 if ok

Definition at line 3536 of file product.class.php.

References dol_syslog(), getDolGlobalString(), getFather(), and Facture\STATUS_DRAFT.

Referenced by load_virtual_stock().

load_stats_commande_fournisseur()

Product::load_stats_commande_fournisseur	(		$socid = 0,
			$filtrestatut = '',
			$forVirtualStock = 0,
			$dateofvirtualstock = null )

Charge tableau des stats commande fournisseur pour le produit/service.

Parameters

int	$socid	Id thirdparty to filter on a thirdparty
string	$filtrestatut	Id of status to filter on status
int	$forVirtualStock	Ignore rights filter for virtual stock calculation.
int	$dateofvirtualstock	Date of virtual stock

Returns

int Array of stats in $this->stats_commande_fournisseur, <0 if ko or >0 if ok

Definition at line 3664 of file product.class.php.

References getDolGlobalString().

Referenced by load_virtual_stock().

load_stats_contrat()

Product::load_stats_contrat

(

$socid = 0

)

Charge tableau des stats contrat pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_contrat, <0 if ko or >0 if ok

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

References getDolGlobalString(), and getFather().

load_stats_facture()

Product::load_stats_facture

(

$socid = 0

)

Charge tableau des stats facture pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_facture, <0 if ko or >0 if ok

Definition at line 4070 of file product.class.php.

References getDolGlobalString(), and getFather().

load_stats_facture_fournisseur()

Product::load_stats_facture_fournisseur

(

$socid = 0

)

Charge tableau des stats facture pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_facture_fournisseur, <0 if ko or >0 if ok

Definition at line 4219 of file product.class.php.

load_stats_facturerec()

Product::load_stats_facturerec

(

$socid = 0

)

Charge tableau des stats facture recurrentes pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_facture, <0 if ko or >0 if ok

Definition at line 4145 of file product.class.php.

References getDolGlobalString(), and getFather().

load_stats_inproduction()

Product::load_stats_inproduction	(		$socid = 0,
			$filtrestatut = '',
			$forVirtualStock = 0,
			$dateofvirtualstock = null,
			$warehouseid = 0 )

Charge tableau des stats production pour le produit/service.

Parameters

int	$socid	Id thirdparty to filter on a thirdparty
string	$filtrestatut	Id status to filter on a status
int	$forVirtualStock	Ignore rights filter for virtual stock calculation.
int	$dateofvirtualstock	Date of virtual stock
int	$warehouseid	Filter by a warehouse. Warning: When a filter on a warehouse is set, it is not possible to calculate an accurate virtual stock because we can't know in which warehouse will be done virtual stock changes.

Returns

integer Array of stats in $this->stats_mrptoproduce (nb=nb of order, qty=qty ordered), <0 if ko or >0 if ok

Definition at line 3873 of file product.class.php.

References getDolGlobalString().

Referenced by load_virtual_stock().

load_stats_mo()

Product::load_stats_mo

(

$socid = 0

)

Charge tableau des stats OF pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_mo, <0 if ko or >0 if ok

Definition at line 3276 of file product.class.php.

References price2num().

load_stats_propale()

Product::load_stats_propale

(

$socid = 0

)

Charge tableau des stats propale pour le produit/service.

Parameters

int

$socid

Id societe

Returns

int Array of stats in $this->stats_propale, <0 if ko or >0 if ok

Definition at line 3405 of file product.class.php.

References getDolGlobalString(), and getFather().

load_stats_proposal_supplier()

Product::load_stats_proposal_supplier

(

$socid = 0

)

Charge tableau des stats propale pour le produit/service.

Parameters

int

$socid

Id thirdparty

Returns

int Array of stats in $this->stats_proposal_supplier, <0 if ko or >0 if ok

Definition at line 3480 of file product.class.php.

load_stats_reception()

Product::load_stats_reception	(		$socid = 0,
			$filtrestatut = '',
			$forVirtualStock = 0,
			$dateofvirtualstock = null )

Charge tableau des stats réception fournisseur pour le produit/service.

Parameters

int	$socid	Id thirdparty to filter on a thirdparty
string	$filtrestatut	Id status to filter on a status
int	$forVirtualStock	Ignore rights filter for virtual stock calculation.
int	$dateofvirtualstock	Date of virtual stock

Returns

int Array of stats in $this->stats_reception, <0 if ko or >0 if ok

Definition at line 3811 of file product.class.php.

References getDolGlobalString().

Referenced by load_virtual_stock().

load_stats_sending()

Product::load_stats_sending	(		$socid = 0,
			$filtrestatut = '',
			$forVirtualStock = 0,
			$filterShipmentStatus = '' )

Charge tableau des stats expedition client pour le produit/service.

Parameters

int	$socid	Id thirdparty to filter on a thirdparty
string	$filtrestatut	[=''] Ids order status separated by comma
int	$forVirtualStock	Ignore rights filter for virtual stock calculation.
string	$filterShipmentStatus	[=''] Ids shipment status separated by comma

Returns

int Array of stats in $this->stats_expedition, <0 if ko or >0 if ok

Definition at line 3725 of file product.class.php.

References getDolGlobalString(), and getFather().

Referenced by load_virtual_stock().

load_stock()

Product::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.

If you use it on list, use a cache to execute it once for each product id. If ENTREPOT_EXTRA_STATUS is set, filtering on warehouse status is possible.

Parameters

string	$option	'' = Load all stock info, also from closed and internal warehouses, 'nobatch' = do not load batch detail, 'novirtual' = do no load virtual detail You can also filter on 'warehouseclosed', 'warehouseopen', 'warehouseinternal'
int	$includedraftpoforvirtual	Include draft status of PO for virtual stock calculation
int	$dateofvirtualstock	Date of virtual stock

Returns

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

See also

load_virtual_stock(), loadBatchInfo()

Definition at line 6137 of file product.class.php.

References dol_syslog(), Productbatch\findAll(), getDolGlobalString(), hasbatch(), load_virtual_stock(), Entrepot\STATUS_CLOSED, Entrepot\STATUS_OPEN_ALL, and Entrepot\STATUS_OPEN_INTERNAL.

Referenced by update().

load_virtual_stock()

Product::load_virtual_stock	(		$includedraftpoforvirtual = null,
			$dateofvirtualstock = null )

Load value ->stock_theorique of a product.

Property this->id must be defined. This function need a lot of load. If you use it on list, use a cache to execute it one for each product id.

Parameters

int	$includedraftpoforvirtual	Include draft status and not yet approved Purchase Orders for virtual stock calculation
int	$dateofvirtualstock	Date of virtual stock

Returns

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

See also

load_stock(), loadBatchInfo()

Definition at line 6214 of file product.class.php.

References dol_print_error(), getDolGlobalString(), load_stats_commande(), load_stats_commande_fournisseur(), load_stats_inproduction(), load_stats_reception(), load_stats_sending(), Expedition\STATUS_CLOSED, and Expedition\STATUS_VALIDATED.

Referenced by load_stock().

loadBatchInfo()

Product::loadBatchInfo

(

$batch

)

Load existing information about a serial.

Parameters

string

$batch

Lot/serial number

Returns

array<array{batch:string,eatby:string,sellby:string,qty:float}> Array with record into product_batch

See also

load_stock(), load_virtual_stock()

Definition at line 6340 of file product.class.php.

References dol_print_error(), and dol_syslog().

loadStateBoard()

Product::loadStateBoard

(

)

Load indicators this->nb for the dashboard.

Returns

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

Definition at line 6565 of file product.class.php.

References dol_print_error().

log_price_delete()

Product::log_price_delete	(		$user,
			$rowid )

Delete a price line.

Parameters

User	$user	Object user
int	$rowid	Line id to delete

Returns

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

Definition at line 2264 of file product.class.php.

min_recommended_price()

Product::min_recommended_price

(

)

Return minimum product recommended price.

Returns

int Minimum recommended price that is higher price among all suppliers * PRODUCT_MINIMUM_RECOMMENDED_PRICE

Definition at line 6775 of file product.class.php.

References getDolGlobalString().

replaceThirdparty()

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

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Reimplemented in ProductFournisseur.

Definition at line 6824 of file product.class.php.

References CommonObject\commonReplaceThirdparty().

setAccountancyCode()

Product::setAccountancyCode	(		$type,
			$value )

Sets an accountancy code for a product.

Also calls PRODUCT_MODIFY trigger when modified

Parameters

string	$type	It can be 'buy', 'buy_intra', 'buy_export', 'sell', 'sell_intra' or 'sell_export'
string	$value	Accountancy code

Returns

int Return integer <0 KO >0 OK

Definition at line 2092 of file product.class.php.

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

setCategories()

Product::setCategories

(

$categories

)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters

int[] | int

$categories

Category or categories IDs

Returns

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

Definition at line 6810 of file product.class.php.

setMultiLangs()

Product::setMultiLangs

(

$user

)

Update or add a translation for a product.

Parameters

User

$user

Object user making update

Returns

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

Definition at line 1948 of file product.class.php.

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

Referenced by update().

setPriceExpression()

Product::setPriceExpression

(

$expression_id

)

Sets the supplier price expression.

Parameters

int

$expression_id

Expression

Returns

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

Deprecated

Use Product\update instead

Definition at line 2831 of file product.class.php.

References update().

update()

Product::update	(		$id,
			$user,
			$notrigger = 0,
			$action = 'update',
			$updatetype = false )

Update a record into database.

If batch flag is set to on, we create records into llx_product_batch

Parameters

int	$id	Id of product
User	$user	Object user making update
int	$notrigger	Disable triggers
string	$action	Current action for hookmanager ('add' or 'update')
boolean	$updatetype	Update product type

Returns

int 1 if OK, -1 if ref already exists, -2 if other error

Definition at line 1330 of file product.class.php.

References CommonObject\call_trigger(), correct_stock(), correct_stock_batch(), description, dol_clone(), dol_now(), dol_print_date(), dol_print_error(), dol_sanitizeFileName(), dol_string_nospecial(), dol_syslog(), get_barcode(), getDolGlobalInt(), getDolGlobalString(), hasbatch(), CommonObject\insertExtraFields(), isProduct(), isService(), load_stock(), measuring_units_cubed(), measuring_units_squared(), price2num(), ref, setMultiLangs(), status, type, and verify().

Referenced by create(), and setPriceExpression().

update_sousproduit()

Product::update_sousproduit	(		$id_pere,
			$id_fils,
			$qty,
			$incdec = 1,
			$notrigger = 0 )

Modify composed product.

Parameters

int	$id_pere	Id of parent product/service
int	$id_fils	Id of child product/service
float	$qty	Quantity
int	$incdec	1=Increase/decrease stock of child when parent stock increase/decrease
int	$notrigger	Disable triggers

Returns

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

Definition at line 4847 of file product.class.php.

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

updatePrice()

Product::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.

Parameters

double	$newprice	New price
string	$newpricebase	HT or TTC
User	$user	Object user that make change
?float	$newvat	New VAT Rate (For example 8.5. Should not be a string)
float | int	$newminprice	New price min
int	$level	0=standard, >0 = level if multilevel prices
	int<0,1>	$newnpr 0=Standard vat rate, 1=Special vat rate for French NPR VAT
	int<0,1>	$newpbq 1 if it has price by quantity
	int<0,1>	$ignore_autogen Used to avoid infinite loops
	array{}|array{0:string,1:int|string,2:string,3:string}|array{0:string,1:int|string,2:string,3:int|string,4:string,5:string}	$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
string	$price_label	Price Label
int	$notrigger	Disable triggers

Returns

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

Definition at line 2635 of file product.class.php.

References _log_price(), CommonObject\call_trigger(), dol_syslog(), generateMultiprices(), get_localtax(), getArrayForPriceCompare(), getDolGlobalString(), price(), and price2num().

Referenced by generateMultiprices().

verify()

Product::verify

(

)

Check properties of product are ok (like name, barcode, ...).

All properties must be already loaded on object (this->barcode, this->barcode_type_code, ...).

Returns

int 0 if OK, <0 if KO

Definition at line 1240 of file product.class.php.

References check_barcode(), and ref.

Referenced by create(), and update().

---

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

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