MouvementStock Class Reference

Class to manage stock movements. More...

Inheritance diagram for MouvementStock:

Collaboration diagram for MouvementStock:

Public Member Functions
	__construct ($db)
	Constructor.
	_create ($user, $fk_product, $entrepot_id, $qty, $type, $price=0, $label='', $inventorycode='', $datem='', $eatby='', $sellby='', $batch='', $skip_batch=false, $id_product_batch=0, $disablestockchangeforsubproduct=0, $donotcleanemptylines=0, $force_update_batch=false)
	Add a movement of stock (in one direction only).
	fetch ($id)
	Load object in memory from the database.
	livraison ($user, $fk_product, $entrepot_id, $qty, $price=0, $label='', $datem='', $eatby='', $sellby='', $batch='', $id_product_batch=0, $inventorycode='', $donotcleanemptylines=0)
	Decrease stock for product and subproducts.
	reception ($user, $fk_product, $entrepot_id, $qty, $price=0, $label='', $eatby='', $sellby='', $batch='', $datem='', $id_product_batch=0, $inventorycode='', $donotcleanemptylines=0)
	Increase stock for product and subproducts.
	calculateBalanceForProductBefore ($productidselected, $datebefore)
	Count number of product in stock before a specific date.
	get_origin ($origin_id, $origin_type)
	Return Url link of origin object.
	setOrigin ($origin_element, $origin_id, $line_id_object_src=0, $line_id_object_origin=0)
	Set attribute origin_type and fk_origin to object.
	initAsSpecimen ()
	Initialise an instance with random values.
	getTypeMovement ($withlabel=0)
	Return html string with picto for type of movement.
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $maxlen=24, $morecss='')
	Return a link (with optionally the picto) Use this->id,this->lastname, this->firstname.
	getLibStatut ($mode=0)
	Return label statut.
	LibStatut ($mode=0)
	Return the label of the status.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create object on disk.
	delete (User $user, $notrigger=0)
	Delete object in database.
	reverseMouvement ()
	reverse movement for object by updating infos
	getDateLastMovementProductBatch ($fk_entrepot, $fk_product, $batch)
	Retrieve date of last stock movement for.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContentArray ($params)
	Return array of data to show into a tooltip.
	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.

Private Member Functions
	_createSubProduct ($user, $idProduct, $entrepot_id, $qty, $type, $price=0, $label='', $inventorycode='', $datem='')
	Create movement in database for all subproducts.
	createBatch ($dluo, $qty)
	Create or update batch record (update table llx_product_batch).
	getBatchCount ($fk_product, $batch)
	Retrieve number of equipment for a product lot/serial.

Additional Inherited Members
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 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 to manage stock movements.

Definition at line 33 of file mouvementstock.class.php.

Constructor & Destructor Documentation

__construct()

MouvementStock::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 189 of file mouvementstock.class.php.

Member Function Documentation

_create()

MouvementStock::_create	(		$user,
			$fk_product,
			$entrepot_id,
			$qty,
			$type,
			$price = 0,
			$label = '',
			$inventorycode = '',
			$datem = '',
			$eatby = '',
			$sellby = '',
			$batch = '',
			$skip_batch = false,
			$id_product_batch = 0,
			$disablestockchangeforsubproduct = 0,
			$donotcleanemptylines = 0,
			$force_update_batch = false )

Add a movement of stock (in one direction only).

This is the lowest level method to record a stock change. There is no control if warehouse is open or not. $this->origin_type and $this->origin_id can be also be set to save the source object of movement.

Parameters

User	$user	User object
int	$fk_product	Id of product
int	$entrepot_id	Id of warehouse
float	$qty	Qty of movement (can be <0 or >0 depending on parameter type)
int	$type	Direction of movement: 0=input (stock increase by a stock transfer), 1=output (stock decrease by a stock transfer), 2=output (stock decrease), 3=input (stock increase) Note that qty should be > 0 with 0 or 3, < 0 with 1 or 2.
int	$price	Unit price HT of product, used to calculate average weighted price (AWP or PMP in french). If 0, average weighted price is not changed.
string	$label	Label of stock movement
string	$inventorycode	Inventory code
integer | string	$datem	Force date of movement
integer | string	$eatby	eat-by date. Will be used if lot does not exists yet and will be created.
integer | string	$sellby	sell-by date. Will be used if lot does not exists yet and will be created.
string	$batch	batch number
boolean	$skip_batch	If set to true, stock movement is done without impacting batch record
int	$id_product_batch	Id product_batch (when skip_batch is false and we already know which record of product_batch to use)
int	$disablestockchangeforsubproduct	Disable stock change for sub-products of kit (useful only if product is a subproduct)
int	$donotcleanemptylines	Do not clean lines in stock table with qty=0 (because we want to have this done by the caller)
boolean	$force_update_batch	Allows to add batch stock movement even if $product doesn't use batch anymore

Returns

int Return integer <0 if KO, 0 if fk_product is null or product id does not exists, >0 if OK

Definition at line 222 of file mouvementstock.class.php.

References $conf, _createSubProduct(), CommonObject\call_trigger(), createBatch(), dol_getdate(), dol_mktime(), dol_now(), dol_print_date(), dol_print_error(), dol_syslog(), getBatchCount(), getDolGlobalInt(), getDolGlobalString(), price(), price2num(), type, and Product\TYPE_SERVICE.

Referenced by livraison(), and reception().

_createSubProduct()

MouvementStock::_createSubProduct ( $user, $idProduct, $entrepot_id, $qty, $type, $price = 0, $label = '', $inventorycode = '', $datem = '' )

private

Create movement in database for all subproducts.

Parameters

User	$user	Object user
int	$idProduct	Id product
int	$entrepot_id	Warehouse id
float	$qty	Quantity
int	$type	Type
int	$price	Price
string	$label	Label of movement
string	$inventorycode	Inventory code
integer | string	$datem	Force date of movement

Returns

int Return integer <0 if KO, 0 if OK

Definition at line 793 of file mouvementstock.class.php.

References dol_clone(), and dol_syslog().

Referenced by _create().

calculateBalanceForProductBefore()

MouvementStock::calculateBalanceForProductBefore	(		$productidselected,
			$datebefore )

Count number of product in stock before a specific date.

Parameters

int	$productidselected	Id of product to count
integer	$datebefore	Date limit

Returns

int Number

Definition at line 903 of file mouvementstock.class.php.

References dol_print_error(), and dol_syslog().

createBatch()

MouvementStock::createBatch ( $dluo, $qty )

private

Create or update batch record (update table llx_product_batch).

No check is done here, done by parent.

Parameters

	array{fk_product_stock:int,batchnumber:string}|int	$dluo Could be either int if row id of product_batch table (for update) or complete array('fk_product_stock'=>, 'batchnumber'=>)
float	$qty	Quantity of product with batch number. May be a negative amount.

Returns

int<-2,-1>|int<1,max> Return integer <0 if KO, -2 if we try to update a product_batchid that does not exist, else return productbatch id

Definition at line 934 of file mouvementstock.class.php.

References dol_syslog().

Referenced by _create().

delete()

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

Delete object in database.

Parameters

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

Returns

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

Definition at line 1294 of file mouvementstock.class.php.

References CommonObject\deleteCommon().

fetch()

MouvementStock::fetch

(

$id

)

Load object in memory from the database.

Parameters

int

$id

Id object

Returns

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

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

References dol_syslog(), CommonObject\fetch_optionals(), price(), and type.

generateDocument()

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

Create object on disk.

Parameters

string	$modele	force le modele a utiliser ('' 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 1265 of file mouvementstock.class.php.

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

get_origin()

MouvementStock::get_origin	(		$origin_id,
			$origin_type )

Return Url link of origin object.

Parameters

int	$origin_id	Id origin
string	$origin_type	Type origin ('project', 'xxx@MODULENAME', etc)

Returns

string

Definition at line 1007 of file mouvementstock.class.php.

References dol_include_once().

getBatchCount()

MouvementStock::getBatchCount ( $fk_product, $batch )

private

Retrieve number of equipment for a product lot/serial.

Parameters

int	$fk_product	Product id
string	$batch	batch number

Returns

int Return integer <0 if KO, number of equipment found if OK

Definition at line 1307 of file mouvementstock.class.php.

References dol_print_error().

Referenced by _create().

getDateLastMovementProductBatch()

MouvementStock::getDateLastMovementProductBatch	(		$fk_entrepot,
			$fk_product,
			$batch )

Retrieve date of last stock movement for.

Parameters

int	$fk_entrepot	Warehouse id
int	$fk_product	Product id
string	$batch	Batch number

Returns

string Date of last stock movement if found else empty string

Definition at line 1371 of file mouvementstock.class.php.

References dol_print_error().

getLibStatut()

MouvementStock::getLibStatut

(

$mode = 0

)

Return label statut.

Parameters

int

$mode

0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto

Returns

string Label of status

Definition at line 1223 of file mouvementstock.class.php.

References LibStatut().

getNomUrl()

MouvementStock::getNomUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$maxlen = 24,
			$morecss = '' )

Return a link (with optionally the picto) Use this->id,this->lastname, this->firstname.

Parameters

int	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('' = Tab of stock movement of warehouse, 'movements' = list of movements)
integer	$notooltip	1=Disable tooltip
int	$maxlen	Max length of visible user name
string	$morecss	Add more css on link

Returns

string String with URL

Definition at line 1172 of file mouvementstock.class.php.

References $conf, and img_picto().

getTypeMovement()

MouvementStock::getTypeMovement

(

$withlabel = 0

)

Return html string with picto for type of movement.

Parameters

int

$withlabel

With label

Returns

string String with URL

Definition at line 1126 of file mouvementstock.class.php.

References type.

initAsSpecimen()

MouvementStock::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 1110 of file mouvementstock.class.php.

LibStatut()

MouvementStock::LibStatut

(

$mode = 0

)

Return the label of the status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

Definition at line 1235 of file mouvementstock.class.php.

References img_picto().

Referenced by getLibStatut().

livraison()

MouvementStock::livraison	(		$user,
			$fk_product,
			$entrepot_id,
			$qty,
			$price = 0,
			$label = '',
			$datem = '',
			$eatby = '',
			$sellby = '',
			$batch = '',
			$id_product_batch = 0,
			$inventorycode = '',
			$donotcleanemptylines = 0 )

Decrease stock for product and subproducts.

Parameters

User	$user	Object user
int	$fk_product	Id product
int	$entrepot_id	Warehouse id
float	$qty	Quantity
int	$price	Price
string	$label	Label of stock movement
int | string	$datem	Force date of movement
int | string	$eatby	eat-by date
int | string	$sellby	sell-by date
string	$batch	batch number
int	$id_product_batch	Id product_batch
string	$inventorycode	Inventory code
int	$donotcleanemptylines	Do not clean lines that remains in stock table with qty=0 (because we want to have this done by the caller)

Returns

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

Definition at line 860 of file mouvementstock.class.php.

References $conf, and _create().

reception()

MouvementStock::reception	(		$user,
			$fk_product,
			$entrepot_id,
			$qty,
			$price = 0,
			$label = '',
			$eatby = '',
			$sellby = '',
			$batch = '',
			$datem = '',
			$id_product_batch = 0,
			$inventorycode = '',
			$donotcleanemptylines = 0 )

Increase stock for product and subproducts.

Parameters

User	$user	Object user
int	$fk_product	Id product
int	$entrepot_id	Warehouse id
float	$qty	Quantity
int	$price	Price
string	$label	Label of stock movement
integer | string	$eatby	eat-by date
integer | string	$sellby	sell-by date
string	$batch	batch number
integer | string	$datem	Force date of movement
int	$id_product_batch	Id product_batch
string	$inventorycode	Inventory code
int	$donotcleanemptylines	Do not clean lines that remains in stock table with qty=0 (because we want to have this done by the caller)

Returns

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

Definition at line 887 of file mouvementstock.class.php.

References $conf, and _create().

reverseMouvement()

MouvementStock::reverseMouvement

(

)

reverse movement for object by updating infos

Returns

int 1 if OK,-1 if KO

Definition at line 1337 of file mouvementstock.class.php.

setOrigin()

MouvementStock::setOrigin	(		$origin_element,
			$origin_id,
			$line_id_object_src = 0,
			$line_id_object_origin = 0 )

Set attribute origin_type and fk_origin to object.

Parameters

string	$origin_element	Type of element
int	$origin_id	Id of element
int	$line_id_object_src	Id line of element Source
int	$line_id_object_origin	Id line of element Origin

Returns

void

Definition at line 1091 of file mouvementstock.class.php.

---

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

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