dolibarr 25.0.0-alpha
Mo Class Reference

Class for Mo. More...

Inheritance diagram for Mo:
Collaboration diagram for Mo:

Public Member Functions

 __construct (DoliDB $db)
 Constructor.
 
 create (User $user, $notrigger=0)
 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.
 
 fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND')
 Load list of objects in memory from the database.
 
 fetchLinesLinked ($role, $lineid=0)
 Get list of lines linked to current line for a defined role.
 
 hasConsumedOrProducedLines ()
 Return if consumption or production has started on the MO (it has consumed or produced lines).
 
 countMovements ()
 Count number of movement with origin of MO.
 
 update (User $user, $notrigger=0)
 Update object into database.
 
 createProduction (User $user, $notrigger=0)
 Erase and update the line to consume and to produce.
 
 processBOM (User $user, $role, $bom, $quantity)
 Recurse through BOM only adding products to the list of lines to consume/produce.
 
 updateProduction (User $user, $notrigger=0)
 Update quantities in lines to consume and/or lines to produce.
 
 delete (User $user, $notrigger=0, $also_cancel_consumed_and_produced_lines=false)
 Delete object in database.
 
 deleteLine (User $user, $idline, $notrigger=0, $fk_movement=0)
 Delete a line of object in database.
 
 getNextNumRef ($prod)
 Returns the reference to the following non used MO depending on the active numbering module defined into MRP_MO_ADDON.
 
 validate ($user, $notrigger=0)
 Validate Mo.
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 Set status of the MO and record the user who changed it.
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set status of the MO and record the user who changed it.
 
 setDraft ($user, $notrigger=0)
 Set draft status.
 
 cancel ($user, $notrigger=0, $also_cancel_consumed_and_produced_lines=false)
 Set cancel status.
 
 reopen ($user, $notrigger=0)
 Set back to validated status.
 
 setCategories ($categories)
 Sets object to given categories.
 
 cancelConsumedAndProducedLines ($user, $mode=0, $also_delete_lines=false, $notrigger=0)
 Cancel consumed and produced lines (movement stocks)
 
 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.
 
 initAsSpecimen ()
 Initialise object with example values Id must be 0 if object instance is a specimen.
 
 getLinesArray ($rolefilter='')
 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.
 
 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).
 
 getMoChilds ()
 Function used to return children of Mo.
 
 getAllMoChilds ($depth=0)
 Function used to return all child MOs recursively.
 
 getMoParent ()
 Function used to return children of Mo.
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate)
 
 hasDelay ()
 Is the manufactured delayed?
 
 getKanbanView ($option='', $arraydata=null)
 Return clickable link of object (with eventually picto)
 
- Public Member Functions inherited from CommonObject
 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.
 
 fetchWarehouse ($force_warehouse_id=0)
 Load the warehouse of object, from id $this->warehouse_id or $this->fk_warehouse, into this->warehouse.
 
 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.
 
 setFieldValue (User $user, $fieldKey, $value, $byPassUserPermission=false)
 Set a value for a dynamic field on the current object.
 
 getFieldUiValue ($field)
 Return the value of a field of $fields, read in the property holding it (see getFieldPropertyName()).
 
 updateFieldFromUi (User $user, $field, $value)
 Update a field from the user interface (ajax edition of cards...) and save it into database.
 
 getFieldValueFromAjaxPost ($field)
 Return the value of a field posted by the user interface (ajax edition of fields).
 
 ajaxOutputField ($field)
 Return the output html of a field for the user interface (ajax edition of fields).
 
 ajaxInputField ($field)
 Return the input html of a field for the user interface (ajax edition of fields).
 
 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.
 
 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.
 
 roundQtyToPackaging ($qty, $packaging)
 Round a quantity up to the next multiple of a packaging quantity (options PRODUCT_USE_CUSTOMER_PACKAGING and PRODUCT_USE_SUPPLIER_PACKAGING).
 
 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.
 
 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.
 
 getObjectLinesDisplayContext ()
 Return the display context of the lines, as defined by the card of the object before printObjectLines() and formAddObjectLine().
 
 initObjectLinesDisplay ()
 Init the display of the lines: set the global variables used by the line templates (objectline_xxx.tpl.php) from getObjectLinesDisplayContext() To call in the card before printObjectLines() and formAddObjectLine().
 
 getObjectLineHtml ($lineid, $action='')
 Return the HTML of a line as printed in the card by printObjectLines(), hooks printObjectLine and printObjectSubLine included.
 
 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)
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0, $notrigger=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, $quality=50)
 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.
 
 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) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.
 
 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 languages 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.
 
 getRightsForUser (User $user)
 Returns the rights used for this class for a specific user.
 
 hasUserPermission (User $user, $mode='write')
 Check if user has a permission on this type of object.
 
 hasUserWritePermissionOnField (User $user, $field)
 Check if user has write permission on a field of this object.
 
 hasUserPermissionOnField (User $user, $field, $mode='write')
 Check if user has a permission on a field of this object.
 
 isFieldEditAllowed (User $user, $field, $byPassUserPermission=false)
 Check whether a given field is allowed to be edited on the current object.
 
 isFieldEditableFromUi (User $user, $field)
 Check whether a field can be edited from the user interface with generic tools (ajax edition of cards...), where the user chooses the field to modify.
 
 isFieldReadableFromUi (User $user, $field)
 Check whether the value of a field can be read from the user interface with generic tools (ajax refresh of the values displayed on a card...), by a user allowed to read the object.
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0, $qty=0)
 Get buy price to use for margin calculation.
 
 getLinkedBuyPriceDocuments ($user, $lineid, $oldbuyprice=null)
 Return the linked proposals, orders and invoices having, for the product of a line of this object, a cost price different from the one saved on the line (for a purchase order, the average net unit price of the product on the ordered purchase orders linked to the same documents, weighted by the quantities).
 
 updateLinkedBuyPrice ($user, $lineid, $elements)
 Apply the cost price of a line of this object to the lines of the same product of some linked documents.
 
 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.
 
 isLineOfObject ($lineid)
 Check that a line belongs to this object, using $this->table_element_line and $this->fk_element.
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database.
 
 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.
 
 checkActiveProductInLines ($status='onsale')
 Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order.
 
 setErrorWithoutLog ($message)
 Set the error message for the object without logging it.
 
 setErrorWithLog ($message, $loglevel=LOG_ERR)
 Set the error message for the object and logs it, including the file name and line number.
 
 showLastFilePreview ($rootdir='', $relativepath='')
 Show preview link of the element (last generate or *<ref>*.pdf) if found and authorized to show the preview (file type)
 

Static Public Member Functions

static replaceThirdparty ($db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one.
 
static replaceProduct ($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.
 
static commonReplaceContact (DoliDB $dbs, $origin_id, $dest_id, array $tables, $fieldname='fk_socpeople', $ignoreerrors=0)
 Function used to replace a contact id with another one.
 

Private Member Functions

 setUserModif ($user)
 Record the user of the last change, as the generic status setters only update the status.
 

Additional Inherited Members

- Public Attributes inherited from CommonObject
 $origin_object
 
- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements.
 
 onFieldValueChanged ($fieldKey, $value)
 Hook called by setFieldValue() after a field has been successfully assigned.
 
 getFieldPropertyName ($field)
 Return the name of the property of the object holding the value of a field of $fields.
 
 persistFieldValue (User $user, $field)
 Save into database the current value of one field, called by updateFieldFromUi().
 
 prepareObjectLinesDisplay ()
 Prepare the display of the lines: global $usemargins and line extrafields used by the line templates (objectline_xxx.tpl.php) Used by printObjectLines() and getObjectLineHtml()
 
 printObjectLineWithHooks ($action, $line, $num, $i, $dateSelector, $seller, $buyer, $selected, $extrafields, $defaulttpldir)
 Print a line of the lines table: hooks printObjectLine or printObjectSubLine, then printObjectLine() if no hook replaced it Used by printObjectLines() and getObjectLineHtml()
 
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents.
 
 isFieldDefined ($field)
 Check if the field is defined in the object's field metadata.
 
 isFieldDisabled ($field)
 Check if the field is explicitly marked as disabled.
 
 isFieldValidationRequired ($field)
 Check if the field requires validation.
 
 isFieldEnabled ($field)
 Check if the field is enabled.
 
 isFieldMarkedNotEditable ($field)
 Check if the field is explicitly marked as not editable.
 
 isFieldBlockedByObjectState ($field)
 Check if the field is blocked by the current object state.
 
 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 Mo.

Definition at line 34 of file mo.class.php.

Constructor & Destructor Documentation

◆ __construct()

Mo::__construct ( DoliDB $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 290 of file mo.class.php.

References getDolGlobalString(), and isModEnabled().

Member Function Documentation

◆ cancel()

Mo::cancel ( $user,
$notrigger = 0,
$also_cancel_consumed_and_produced_lines = false )

Set cancel status.

Parameters
User$userObject user that modify
int$notrigger1=Does not execute triggers, 0=Execute triggers
bool$also_cancel_consumed_and_produced_linestrue if the consumed and produced lines will be deleted (and stocks incremented/decremented back) (false by default)
Returns
int Return integer <0 if KO, 0=Nothing done, >0 if OK

Definition at line 1406 of file mo.class.php.

References cancelConsumedAndProducedLines(), setStatusCommon(), and status.

◆ cancelConsumedAndProducedLines()

Mo::cancelConsumedAndProducedLines ( $user,
$mode = 0,
$also_delete_lines = false,
$notrigger = 0 )

Cancel consumed and produced lines (movement stocks)

Parameters
User$userObject user that modify
int$modeType line supported (0 by default) (0: consumed and produced lines; 1: consumed lines; 2: produced lines)
bool$also_delete_linestrue if the consumed/produced lines is deleted (false by default)
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int Return integer <0 if KO, 0=Nothing done, >0 if OK

Definition at line 1496 of file mo.class.php.

References CommonObject\deleteLineCommon(), dol_now(), fetchLinesLinked(), and isModEnabled().

Referenced by cancel(), and delete().

◆ countMovements()

Mo::countMovements ( )

Count number of movement with origin of MO.

Returns
int Number of movements

Definition at line 683 of file mo.class.php.

◆ create()

Mo::create ( User $user,
$notrigger = 0 )

Create object into database.

Parameters
User$userUser that creates
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
Returns
int Return integer <=0 if KO, Id of created object if OK

Definition at line 332 of file mo.class.php.

References CommonObject\createCommon(), createProduction(), and getDolGlobalString().

◆ createFromClone()

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

Clone an object into another one.

Parameters
User$userUser that creates
int$fromidId of object to clone
Returns
self|int<-1,1> New object created, <0 if KO

Definition at line 389 of file mo.class.php.

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

◆ createProduction()

Mo::createProduction ( User $user,
$notrigger = 0 )

Erase and update the line to consume and to produce.

Parameters
User$userUser that modifies
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 752 of file mo.class.php.

References dol_syslog(), hasConsumedOrProducedLines(), processBOM(), CommonObject\setErrorsFromObject(), and status.

Referenced by create().

◆ delete()

Mo::delete ( User $user,
$notrigger = 0,
$also_cancel_consumed_and_produced_lines = false )

Delete object in database.

Parameters
User$userUser that deletes
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
bool$also_cancel_consumed_and_produced_linestrue if the consumed and produced lines will be deleted (and stocks incremented/decremented back) (false by default)
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 965 of file mo.class.php.

References cancelConsumedAndProducedLines(), and CommonObject\deleteCommon().

◆ deleteLine()

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

Delete a line of object in database.

Parameters
User$userUser that delete
int$idlineId of line to delete
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
int$fk_movementMovement
Returns
int Return >0 if OK, <0 if KO

Definition at line 1014 of file mo.class.php.

References CommonObject\deleteLineCommon(), dol_now(), fetchLinesLinked(), CommonObject\setErrorsFromObject(), and status.

◆ fetch()

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

Load object in memory from the database.

Parameters
int$idId object
?string$refRef
Returns
int<-1,1> Return integer <0 if KO, 0 if not found, >0 if OK

Definition at line 492 of file mo.class.php.

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

◆ fetchAll()

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

Load list of objects in memory from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitLimit
int$offsetOffset
string|array<string,string>$filter Filter USF.
'AND'|'OR'$filtermode Filter mode (AND or OR)
Returns
self[]|int int <0 if KO, array of pages if OK

Definition at line 529 of file mo.class.php.

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

◆ fetchLines()

Mo::fetchLines ( )

Load object lines in memory from the database.

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

Definition at line 509 of file mo.class.php.

References CommonObject\fetchLinesCommon().

Referenced by fetch().

◆ fetchLinesLinked()

Mo::fetchLinesLinked ( $role,
$lineid = 0 )

Get list of lines linked to current line for a defined role.

Parameters
string$roleGet lines linked to current line with the selected role ('consumed', 'produced', ...)
int$lineidId of production line to filter children
Returns
array<array{rowid:int,date:int|string,qty:float,role:string,fk_product:int,fk_warehouse:int,batch:string,fk_stock_movement:int,fk_unit:int}> Array of lines

Definition at line 613 of file mo.class.php.

Referenced by cancelConsumedAndProducedLines(), deleteLine(), and hasConsumedOrProducedLines().

◆ generateDocument()

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

Create a document onto disk according to template module.

Parameters
string$modeleForce template to use ('' to not force)
Translate$outputlangsobject 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 if KO, 1 if OK

Definition at line 1873 of file mo.class.php.

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

◆ getAllMoChilds()

Mo::getAllMoChilds ( $depth = 0)

Function used to return all child MOs recursively.

Parameters
int$depthDepth for recursing loop count
Returns
Mo[]|int[]|int array of MOs if OK, -1 if KO

Definition at line 2104 of file mo.class.php.

References getMoChilds().

◆ getKanbanView()

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

Return clickable link of object (with eventually picto)

Parameters
string$optionWhere 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 2261 of file mo.class.php.

References getNomUrl().

◆ getLibStatut()

Mo::getLibStatut ( $mode = 0)

Return label of the status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
Returns
string Label of status

Definition at line 1739 of file mo.class.php.

References LibStatut(), and status.

◆ getLinesArray()

Mo::getLinesArray ( $rolefilter = '')

Create an array of lines.

Parameters
string$rolefilterstring lines role filter
Returns
MoLine[]|int array of lines if OK, <0 if KO

Definition at line 1840 of file mo.class.php.

◆ getMoChilds()

Mo::getMoChilds ( )

Function used to return children of Mo.

Returns
Mo[]|int array if OK, -1 if KO

Definition at line 2063 of file mo.class.php.

Referenced by getAllMoChilds().

◆ getMoParent()

Mo::getMoParent ( )

Function used to return children of Mo.

Returns
Mo|int MO object if OK, -1 if KO, 0 if not exist

Definition at line 2149 of file mo.class.php.

◆ getNextNumRef()

Mo::getNextNumRef ( $prod)

Returns the reference to the following non used MO depending on the active numbering module defined into MRP_MO_ADDON.

Parameters
Product$prodObject product
Returns
string MO free reference

Definition at line 1143 of file mo.class.php.

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

Referenced by validate().

◆ getNomUrl()

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

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

Parameters
int$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string$optionOn what the link point to ('nolink', '', 'production', ...)
int$notooltip1=Disable tooltip
string$morecssAdd more css on link
int$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 1651 of file mo.class.php.

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

Referenced by getKanbanView().

◆ getTooltipContentArray()

Mo::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 1602 of file mo.class.php.

References status.

Referenced by getNomUrl().

◆ hasConsumedOrProducedLines()

Mo::hasConsumedOrProducedLines ( )

Return if consumption or production has started on the MO (it has consumed or produced lines).

If yes, $this->error is set with the message to show.

Returns
bool True if the MO has consumed or produced lines

Definition at line 665 of file mo.class.php.

References fetchLinesLinked().

Referenced by createProduction(), and setDraft().

◆ hasDelay()

Mo::hasDelay ( )

Is the manufactured delayed?

Returns
bool

Definition at line 2240 of file mo.class.php.

References $conf, dol_now(), and status.

◆ info()

Mo::info ( $id)

Load the info information in the object.

Parameters
int$idId of object
Returns
void

Definition at line 1794 of file mo.class.php.

◆ initAsSpecimen()

Mo::initAsSpecimen ( )

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

Returns
int

Definition at line 1825 of file mo.class.php.

References CommonObject\initAsSpecimenCommon().

◆ LibStatut()

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

Return the status.

Parameters
int$statusId 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 1752 of file mo.class.php.

Referenced by getLibStatut().

◆ load_board()

Mo::load_board ( $user)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters
User$userObject user
Returns
WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

References $conf, and dol_now().

◆ printOriginLine()

Mo::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).

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.

Parameters
CommonObjectLine$lineLine
string$varVar
string$restrictlist''=All lines, 'services'=Restrict to services only (strike line if not)
string$defaulttpldirDirectory where to find the template
int[]$selectedLinesArray of lines id for selected lines
Returns
void

Reimplemented from CommonObject.

Definition at line 1986 of file mo.class.php.

References $conf, and dol_syslog().

Referenced by printOriginLinesList().

◆ printOriginLinesList()

Mo::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).

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, so we keep the method available on overloaded objects.

Parameters
''|'services'$restrictlist ''=All lines, 'services'=Restrict to services only
int[]$selectedLinesArray of lines id for selected lines
Returns
void

Reimplemented from CommonObject.

Definition at line 1909 of file mo.class.php.

References getDolGlobalString(), and printOriginLine().

◆ processBOM()

Mo::processBOM ( User $user,
$role,
$bom,
$quantity )

Recurse through BOM only adding products to the list of lines to consume/produce.

Parameters
User$userUser that modifies
string$roleMoLine Role that products are added as ('toproduce', 'toconsume', 'produced', 'consumed')
BOM$bomBOM to parse lines from
float$quantityQuantity modifier for sub products/BOM
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 841 of file mo.class.php.

References price2num(), and processBOM().

Referenced by createProduction(), and processBOM().

◆ reopen()

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

Set back to validated status.

Parameters
User$userObject user that modify
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int Return integer <0 if KO, 0=Nothing done, >0 if OK

Definition at line 1453 of file mo.class.php.

References setStatusCommon(), and status.

◆ replaceProduct()

static Mo::replaceProduct ( $db,
$origin_id,
$dest_id )
static

Function used to replace a product id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld product id
int$dest_idNew product id
Returns
bool

Definition at line 2050 of file mo.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

static Mo::replaceThirdparty ( $db,
$origin_id,
$dest_id )
static

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 2035 of file mo.class.php.

References CommonObject\commonReplaceThirdparty().

◆ setCategories()

Mo::setCategories ( $categories)

Sets object to given categories.

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

Parameters
int[] | int$categoriesCategory ID or array of Categories IDs
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1481 of file mo.class.php.

◆ setDraft()

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

Set draft status.

Parameters
User$userObject user that modify
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1377 of file mo.class.php.

References hasConsumedOrProducedLines(), setStatusCommon(), and status.

◆ setStatusCommon()

Mo::setStatusCommon ( $user,
$status,
$notrigger = 0,
$triggercode = '' )

Set status of the MO and record the user who changed it.

Parameters
User$userObject user that modify
int$statusNew status to set (often a constant like self\STATUS_XXX)
int$notrigger1=Does not execute triggers, 0=Execute triggers
string$triggercodeTrigger code to use
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented from CommonObject.

Definition at line 1344 of file mo.class.php.

References setUserModif().

Referenced by cancel(), reopen(), and setDraft().

◆ setStatut()

Mo::setStatut ( $status,
$elementId = null,
$elementType = '',
$trigkey = '',
$fieldstatus = 'fk_statut' )

Set status of the MO and record the user who changed it.

Parameters
int$statusStatus to set
?int$elementIdId of element to force (use this->id by default if null)
string$elementTypeType of element to force (use this->table_element by default)
string$trigkeyTrigger key to use for trigger
string$fieldstatusName of status field in this->table_element
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented from CommonObject.

Definition at line 1323 of file mo.class.php.

References setUserModif().

◆ setUserModif()

Mo::setUserModif ( $user)
private

Record the user of the last change, as the generic status setters only update the status.

Parameters
User$userUser who made the change
Returns
void

Definition at line 1360 of file mo.class.php.

Referenced by setStatusCommon(), and setStatut().

◆ update()

Mo::update ( User $user,
$notrigger = 0 )

Update object into database.

Parameters
User$userUser that modifies
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 718 of file mo.class.php.

References CommonObject\updateCommon(), and updateProduction().

◆ updateProduction()

Mo::updateProduction ( User $user,
$notrigger = 0 )

Update quantities in lines to consume and/or lines to produce.

Parameters
User$userUser that modifies
int<0,1>$notrigger 0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 911 of file mo.class.php.

References price2num(), and status.

Referenced by update().

◆ validate()

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

Validate Mo.

Parameters
User$userUser making status change
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <=0 if OK, 0=Nothing done, >0 if KO

Definition at line 1192 of file mo.class.php.

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


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