BOM Class Reference

Class for BOM. More...

Inheritance diagram for BOM:

Collaboration diagram for BOM:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	create (User $user, $notrigger=1)
	Create object into database.
	createFromClone (User $user, $fromid)
	Clone an object into another one.
	fetch ($id, $ref=null)
	Load object in memory from the database.
	fetchLines ()
	Load object lines in memory from the database.
	fetchLinesbytypeproduct ($typeproduct=0)
	Load object lines in memory from the database by type of product.
	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
	Load list of objects in memory from the database.
	update (User $user, $notrigger=1)
	Update object into database.
	delete (User $user, $notrigger=1)
	Delete object in database.
	addLine ($fk_product, $qty, $qty_frozen=0, $disable_stock_change=0, $efficiency=1.0, $position=-1, $fk_bom_child=null, $import_key=null, $fk_unit=0, $array_options=array(), $fk_default_workstation=null)
	Add an BOM line into database (linked to BOM)
	updateLine ($rowid, $qty, $qty_frozen=0, $disable_stock_change=0, $efficiency=1.0, $position=-1, $import_key=null, $fk_unit=0, $array_options=array(), $fk_default_workstation=null)
	Update an BOM line into database.
	deleteLine (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	getNextNumRef ($prod)
	Returns the reference to the following non used BOM depending on the active numbering module defined into BOM_ADDON.
	validate ($user, $notrigger=0)
	Validate bom.
	setDraft ($user, $notrigger=0)
	Set draft status.
	cancel ($user, $notrigger=0)
	Set cancel status.
	reopen ($user, $notrigger=0)
	Reopen if canceled.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return a link to the object card (with optionally the picto)
	getLibStatut ($mode=0)
	Return label of the status.
	LibStatut ($status, $mode=0)
	Return the status.
	info ($id)
	Load the info information in the object.
	getLinesArray ()
	Create an array of lines.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	is_photo_available ($sdir)
	Return if at least one photo is available.
	initAsSpecimen ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	doScheduledJob ()
	Action executed by scheduler CAN BE A CRON TASK.
	calculateCosts ()
	BOM costs calculation based on cost_price or pmp of each BOM line.
	getNetNeeds (&$TNetNeeds=array(), $qty=0)
	Get Net needs by product.
	getNetNeedsTree (&$TNetNeeds=array(), $qty=0, $level=0)
	Get/add Net needs Tree by product or bom.
	getParentBomTreeRecursive (&$TParentBom, $bom_id=0, $level=1)
	Recursively retrieves all parent bom in the tree that leads to the $bom_id bom.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
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.
	fetchBarCode ()
	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')
	getRights ()
	Returns the rights used for this class.
	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	replaceProduct (DoliDB $db, $origin_id, $dest_id)
	Function used to replace a product 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.

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

Detailed Description

Class for BOM.

Definition at line 41 of file bom.class.php.

Constructor & Destructor Documentation

__construct()

BOM::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 256 of file bom.class.php.

References $conf, and getDolGlobalString().

Member Function Documentation

addLine()

BOM::addLine	(		$fk_product,
			$qty,
			$qty_frozen = 0,
			$disable_stock_change = 0,
			$efficiency = 1.0,
			$position = -1,
			$fk_bom_child = null,
			$import_key = null,
			$fk_unit = 0,
			$array_options = array(),
			$fk_default_workstation = null )

Add an BOM line into database (linked to BOM)

Parameters

int	$fk_product	Id of product
float	$qty	Quantity
	int<0,1>	$qty_frozen If the qty is Frozen
int	$disable_stock_change	Disable stock change on using in MO
float	$efficiency	Efficiency in MO
	int<-1,max>	$position Position of BOM-Line in BOM-Lines
?int	$fk_bom_child	Id of BOM Child
?string	$import_key	Import Key
int	$fk_unit	Unit
	array<string,mixed>	$array_options extrafields array
?int	$fk_default_workstation	Default workstation

Returns

int<-3,max> Return integer <0 if KO, Id of created object if OK

Definition at line 594 of file bom.class.php.

References $conf, calculateCosts(), dol_syslog(), CommonObject\line_max(), price2num(), and CommonObject\setErrorsFromObject().

calculateCosts()

BOM::calculateCosts

(

)

BOM costs calculation based on cost_price or pmp of each BOM line.

Set the property ->total_cost and ->unit_cost of BOM.

Returns

int|string Return integer <0 if KO, >0 if OK, or printable error result from hook

Definition at line 1410 of file bom.class.php.

References $conf, convertDurationtoHour(), and price2num().

Referenced by addLine(), deleteLine(), and updateLine().

cancel()

BOM::cancel	(		$user,
			$notrigger = 0 )

Set cancel status.

Parameters

User	$user	Object user that modify
	int<0,1>	$notrigger 1=Does not execute triggers, 0=Execute triggers

Returns

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

Definition at line 1046 of file bom.class.php.

References CommonObject\setStatusCommon(), and status.

create()

BOM::create	(	User	$user,
			$notrigger = 1 )

Create object into database.

Parameters

User	$user	User that creates
int	$notrigger	false=launch triggers after, true=disable triggers

Returns

int Return integer <0 if KO, Id of created object if OK

Definition at line 296 of file bom.class.php.

References CommonObject\createCommon().

createFromClone()

BOM::createFromClone	(	User	$user,
			$fromid )

Clone an object into another one.

Parameters

User	$user	User that creates
int	$fromid	Id of object to clone

Returns

BOM|int<-1,-1> New object created, <0 if KO

Definition at line 312 of file bom.class.php.

References $object, CommonObject\copy_linked_contact(), and dol_syslog().

delete()

BOM::delete	(	User	$user,
			$notrigger = 1 )

Delete object in database.

Parameters

User	$user	User that deletes
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 572 of file bom.class.php.

References CommonObject\deleteCommon().

deleteLine()

BOM::deleteLine	(	User	$user,
			$idline,
			$notrigger = 0 )

Delete a line of object in database.

Parameters

User	$user	User that delete
int	$idline	Id of line to delete
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

int<-2,-1>|int<1,1> >0 if OK, <0 if KO

Definition at line 814 of file bom.class.php.

References calculateCosts(), dol_syslog(), CommonObject\setErrorsFromObject(), and status.

doScheduledJob()

BOM::doScheduledJob

(

)

Action executed by scheduler CAN BE A CRON TASK.

In such a case, parameters come from the schedule job setup field 'Parameters'

Returns

int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 1381 of file bom.class.php.

References $conf, dol_now(), and dol_syslog().

fetch()

BOM::fetch	(		$id,
			$ref = null )

Load object in memory from the database.

Parameters

int	$id	Id object
string	$ref	Ref

Returns

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

Definition at line 406 of file bom.class.php.

References CommonObject\fetchCommon(), and fetchLines().

fetchAll()

BOM::fetchAll	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
			$filter = '',
			$filtermode = 'AND' )

Load list of objects in memory from the database.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
	int<0,max>	$limit Limit
	int<0,max>	$offset Offset
string	$filter	Filter USF
string	$filtermode	Filter mode (AND or OR)

Returns

BOM[]|int<-1,-1> int <0 if KO, array of pages if OK

Definition at line 497 of file bom.class.php.

References dol_syslog(), forgeSQLFromUniversalSearchCriteria(), and CommonObject\getFieldList().

fetchLines()

BOM::fetchLines

(

)

Load object lines in memory from the database.

Returns

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

Definition at line 423 of file bom.class.php.

References CommonObject\fetchLinesCommon().

Referenced by fetch().

fetchLinesbytypeproduct()

BOM::fetchLinesbytypeproduct

(

$typeproduct = 0

)

Load object lines in memory from the database by type of product.

Parameters

int<0,1>

$typeproduct 0 type product, 1 type service

Returns

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

Definition at line 438 of file bom.class.php.

generateDocument()

BOM::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0,
			$moreparams = null )

Create a document onto disk according to template module.

Parameters

string	$modele	Force template to use ('' to not force)
Translate	$outputlangs	object lang a utiliser pour traduction
	int<0,1>	$hidedetails Hide details of lines
	int<0,1>	$hidedesc Hide description
	int<0,1>	$hideref Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int<0,1> 0 if KO, 1 if OK

Definition at line 1302 of file bom.class.php.

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

getKanbanView()

BOM::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{prod:?Product,selected:int<-1,1>}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

Definition at line 1648 of file bom.class.php.

References getNomUrl(), and img_picto().

getLibStatut()

BOM::getLibStatut

(

$mode = 0

)

Return 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

Returns

string Label of status

Definition at line 1203 of file bom.class.php.

References LibStatut(), and status.

getLinesArray()

BOM::getLinesArray

(

)

Create an array of lines.

Returns

BOMLine[]|int array of lines if OK, <0 if KO

Definition at line 1274 of file bom.class.php.

getNetNeeds()

BOM::getNetNeeds	(	&	$TNetNeeds = array(),
			$qty = 0 )

Get Net needs by product.

Parameters

	array<int,array{qty:float,fk_unit:?int}>	$TNetNeeds Array of ChildBom and infos linked to
float	$qty	qty needed (used as a factor to produce 1 unit)

Returns

void

Definition at line 1543 of file bom.class.php.

getNetNeedsTree()

BOM::getNetNeedsTree	(	&	$TNetNeeds = array(),
			$qty = 0,
			$level = 0 )

Get/add Net needs Tree by product or bom.

Parameters

	array<int,array{product:array,bom:BOM,parentid:int,qty:float,level:int,fk_unit:?int}>	$TNetNeeds Array of ChildBom and infos linked to
float	$qty	qty needed (used as a factor to produce 1 unit)
	int<0,1000>	$level level of recursivity

Returns

void

Definition at line 1572 of file bom.class.php.

getNextNumRef()

BOM::getNextNumRef

(

$prod

)

Returns the reference to the following non used BOM depending on the active numbering module defined into BOM_ADDON.

Parameters

Product

$prod

Object product

Returns

string BOM free reference

Definition at line 861 of file bom.class.php.

References $conf, dol_buildpath(), dol_print_error(), and getDolGlobalString().

Referenced by validate().

getNomUrl()

BOM::getNomUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$morecss = '',
			$save_lastsearch_value = -1 )

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

Parameters

	int<0,2>	$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<0,1>	$notooltip 1=Disable tooltip
string	$morecss	Add more css on link
	int<-1,1>	$save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string String with URL

Definition at line 1121 of file bom.class.php.

References $conf, getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

getParentBomTreeRecursive()

BOM::getParentBomTreeRecursive	(	&	$TParentBom,
			$bom_id = 0,
			$level = 1 )

Recursively retrieves all parent bom in the tree that leads to the $bom_id bom.

Parameters

BOM[]	$TParentBom	We put all found parent bom in $TParentBom
int	$bom_id	ID of bom from which we want to get parent bom ids
	int<0,1000>	$level Protection against infinite loop

Returns

void

Definition at line 1615 of file bom.class.php.

References getParentBomTreeRecursive().

Referenced by getParentBomTreeRecursive().

getTooltipContentArray()

BOM::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

Definition at line 1079 of file bom.class.php.

References $conf, getDolGlobalString(), img_picto(), and status.

Referenced by getNomUrl().

info()

BOM::info

(

$id

)

Load the info information in the object.

Parameters

int

$id

Id of object

Returns

void

Definition at line 1244 of file bom.class.php.

References dol_print_error().

initAsSpecimen()

BOM::initAsSpecimen

(

)

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns

int<1,1>

Definition at line 1365 of file bom.class.php.

References dol_now(), CommonObject\initAsSpecimenCommon(), and ref.

is_photo_available()

BOM::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 1334 of file bom.class.php.

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

LibStatut()

BOM::LibStatut	(		$status,
			$mode = 0 )

Return the status.

Parameters

int	$status	Id status
	int<0,6>	$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

Returns

string Label of status

Definition at line 1216 of file bom.class.php.

References dolGetStatus().

Referenced by getLibStatut().

reopen()

BOM::reopen	(		$user,
			$notrigger = 0 )

Reopen if canceled.

Parameters

User	$user	Object user that modify
	int<0,1>	$notrigger 1=Does not execute triggers, 0=Execute triggers

Returns

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

Definition at line 1063 of file bom.class.php.

References CommonObject\setStatusCommon(), and status.

replaceProduct()

static BOM::replaceProduct ( DoliDB $db, $origin_id, $dest_id )

static

Function used to replace a product id with another one.

Parameters

DoliDB	$db	Database handler
int	$origin_id	Old product id
int	$dest_id	New product id

Returns

bool

Definition at line 1527 of file bom.class.php.

References CommonObject\commonReplaceProduct().

setDraft()

BOM::setDraft	(		$user,
			$notrigger = 0 )

Set draft status.

Parameters

User	$user	Object user that modify
	int<0,1>	$notrigger 1=Does not execute triggers, 0=Execute triggers

Returns

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

Definition at line 1029 of file bom.class.php.

References CommonObject\setStatusCommon(), and status.

update()

BOM::update	(	User	$user,
			$notrigger = 1 )

Update object into database.

Parameters

User	$user	User that modifies
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

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

Definition at line 556 of file bom.class.php.

References CommonObject\updateCommon().

updateLine()

BOM::updateLine	(		$rowid,
			$qty,
			$qty_frozen = 0,
			$disable_stock_change = 0,
			$efficiency = 1.0,
			$position = -1,
			$import_key = null,
			$fk_unit = 0,
			$array_options = array(),
			$fk_default_workstation = null )

Update an BOM line into database.

Parameters

int	$rowid	Id of line to update
float	$qty	Quantity
float	$qty_frozen	Frozen quantity
int	$disable_stock_change	Disable stock change on using in MO
float	$efficiency	Efficiency in MO
	int<-1,max>	$position Position of BOM-Line in BOM-Lines
?string	$import_key	Import Key
int	$fk_unit	Unit of line
	array<string,mixed>	$array_options extrafields array
?int	$fk_default_workstation	Default workstation

Returns

int<-3,max> Return integer <0 if KO, Id of updated BOM-Line if OK

Definition at line 702 of file bom.class.php.

References calculateCosts(), dol_syslog(), price2num(), and CommonObject\setErrorsFromObject().

validate()

BOM::validate	(		$user,
			$notrigger = 0 )

Validate bom.

Parameters

User	$user	User making status change
	int<0,1>	$notrigger 1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 910 of file bom.class.php.

References $conf, CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), CommonObject\fetch_product(), getNextNumRef(), ref, and status.

---

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

• dolibarr_dev/htdocs/bom/class/bom.class.php