dolibarr  18.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Commande Class Reference

Class to manage customers orders. More...

Inheritance diagram for Commande:
Inheritance graph
[legend]
Collaboration diagram for Commande:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNextNumRef ($soc)
 Returns the reference to the following non used Order depending on the active numbering module defined into COMMANDE_ADDON. More...
 
 valid ($user, $idwarehouse=0, $notrigger=0)
 Validate order. More...
 
 setDraft ($user, $idwarehouse=-1)
 Set draft status. More...
 
 set_reopen ($user)
 Tag the order as validated (opened) Function used when order is reopend after being closed. More...
 
 cloture ($user, $notrigger=0)
 Close order. More...
 
 cancel ($idwarehouse=-1)
 Cancel an order If stock is decremented on order validation, we must reincrement it. More...
 
 create ($user, $notrigger=0)
 Create order Note that this->ref can be set or empty. More...
 
 createFromClone (User $user, $socid=0)
 Load an object from its id and create a new one in database. More...
 
 createFromProposal ($object, User $user)
 Load an object from a proposal and create a new order into database. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $info_bits=0, $fk_remise_except=0, $price_base_type='HT', $pu_ttc=0, $date_start='', $date_end='', $type=0, $rang=-1, $special_code=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_options=0, $fk_unit=null, $origin='', $origin_id=0, $pu_ht_devise=0, $ref_ext='', $noupdateafterinsertline=0)
 Add an order line into database (linked to product/service or not) More...
 
 add_product ($idproduct, $qty, $remise_percent=0.0, $date_start='', $date_end='')
 Add line into array $this->client must be loaded. More...
 
 fetch ($id, $ref='', $ref_ext='', $notused='')
 Get object from database. More...
 
 insert_discount ($idremise)
 Adding line of fixed discount in the order in DB. More...
 
 fetch_lines ($only_product=0, $loadalsotranslation=0)
 Load array lines. More...
 
 getNbOfProductsLines ()
 Return number of line with type product. More...
 
 getNbOfServicesLines ()
 Return number of line with type service. More...
 
 getNbOfShipments ()
 Count number of shipments for this order. More...
 
 loadExpeditions ($filtre_statut=-1, $fk_product=0)
 Load array this->expeditions of lines of shipments with nb of products sent for each order line Note: For a dedicated shipment, the fetch_lines can be used to load the qty_asked and qty_shipped. More...
 
 countNbOfShipments ()
 Returns an array with expeditions lines number. More...
 
 stock_array ($filtre_statut=self::STATUS_CANCELED)
 Return a array with the pending stock by product. More...
 
 deleteline ($user=null, $lineid=0, $id=0)
 Delete an order line. More...
 
 set_remise ($user, $remise, $notrigger=0)
 Applique une remise relative. More...
 
 setDiscount ($user, $remise, $notrigger=0)
 Set a percentage discount. More...
 
 set_remise_absolue ($user, $remise, $notrigger=0)
 Set a fixed amount discount. More...
 
 set_date ($user, $date, $notrigger=0)
 Set the order date. More...
 
 set_date_livraison ($user, $delivery_date, $notrigger=0)
 Set delivery date. More...
 
 setDeliveryDate ($user, $delivery_date, $notrigger=0)
 Set the planned delivery date. More...
 
 liste_array ($shortlist=0, $draft=0, $excluser='', $socid=0, $limit=0, $offset=0, $sortfield='c.date_commande', $sortorder='DESC')
 Return list of orders (eventuelly filtered on a user) into an array. More...
 
 availability ($availability_id, $notrigger=0)
 Update delivery delay. More...
 
 demand_reason ($demand_reason_id, $notrigger=0)
 Update order demand_reason. More...
 
 set_ref_client ($user, $ref_client, $notrigger=0)
 Set customer ref. More...
 
 classifyBilled (User $user, $notrigger=0)
 Classify the order as invoiced. More...
 
 classifyUnBilled (User $user, $notrigger=0)
 Classify the order as not invoiced. More...
 
 updateline ($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $price_base_type='HT', $info_bits=0, $date_start='', $date_end='', $type=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_options=0, $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $ref_ext='', $rang=0)
 Update a line in database. More...
 
 update (User $user, $notrigger=0)
 Update database. More...
 
 delete ($user, $notrigger=0)
 Delete the sales order. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getLabelSource ()
 Return source label of order. More...
 
 getLibStatut ($mode)
 Return status label of Order. More...
 
 LibStatut ($status, $billed, $mode, $donotshowbilled=0)
 Return label of status. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0, $target='')
 Return clicable link of object (with eventually picto) More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet commande. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 load_state_board ()
 Charge indicateurs this->nb de tableau de bord. More...
 
 getLinesArray ()
 Create an array of order lines. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 hasDelay ()
 Is the sales order delayed? More...
 
 showDelay ()
 Show the customer delayed info. More...
 
- Public Member Functions inherited from CommonOrder
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 errorsToString ()
 Method to output saved errors. More...
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output. More...
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 setUpperOrLowerCase ()
 Set to upper or ucwords/lower if needed. More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contact_id into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_project ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms. More...
 
 setTransportMode ($id)
 Change the transport mode methods. More...
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id, $includealltree=0)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 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). More...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='', $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0, $entity=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 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. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 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. More...
 
 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) More...
 
 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). More...
 
 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). More...
 
 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. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. More...
 
 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. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 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. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0, $display_type='card')
 Function to show lines of extrafields with output datas. More...
 
 getJSListDependancies ($type='_extra')
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isDuration ($info)
 Function test if type is duration. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ($alias='')
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=false)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories. More...
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories. More...
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object. More...
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a product id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
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. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Public Attributes

 $module_source
 key of module source when order generated from a dedicated module ('cashdesk', 'takepos', ...)
 
 $pos_source
 key of pos source ('0', '1', ...)
 
const STOCK_NOT_ENOUGH_FOR_ORDER = -3
 ERR Not enough stock.
 
const STATUS_CANCELED = -1
 Canceled status.
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_SHIPMENTONPROCESS = 2
 Shipment on process.
 
const STATUS_CLOSED = 3
 Closed (Sent, billed or not)
 
- Public Attributes inherited from CommonObject
 $projet
 
 $fk_projet
 
 $note
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare a part of the query for insert by returning an array with all properties of object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage customers orders.

Definition at line 46 of file commande.class.php.

Constructor & Destructor Documentation

◆ __construct()

Commande::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 401 of file commande.class.php.

References db.

Member Function Documentation

◆ add_product()

Commande::add_product (   $idproduct,
  $qty,
  $remise_percent = 0.0,
  $date_start = '',
  $date_end = '' 
)

Add line into array $this->client must be loaded.

Parameters
int$idproductProduct Id
float$qtyQuantity
float$remise_percentProduct discount relative
int$date_startStart date of the line
int$date_endEnd date of the line
Returns
void

TODO Remplacer les appels a cette fonction par generation objet Ligne

POUR AJOUTER AUTOMATIQUEMENT LES SOUSPRODUITS a LA COMMANDE if (!empty($conf->global->PRODUIT_SOUSPRODUITS)) { $prod = new Product($this->db); $prod->fetch($idproduct); $prod -> get_sousproduits_arbo(); $prods_arbo = $prod->get_arbo_each_prod(); if(count($prods_arbo) > 0) { foreach($prods_arbo as $key => $value) { print "id : ".$value[1].' :qty: '.$value[0].'
'; if not in lines { $this->add_product($value[1], $value[0]); } } }

Definition at line 1751 of file commande.class.php.

◆ addline()

Commande::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $fk_product = 0,
  $remise_percent = 0,
  $info_bits = 0,
  $fk_remise_except = 0,
  $price_base_type = 'HT',
  $pu_ttc = 0,
  $date_start = '',
  $date_end = '',
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $fk_parent_line = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $label = '',
  $array_options = 0,
  $fk_unit = null,
  $origin = '',
  $origin_id = 0,
  $pu_ht_devise = 0,
  $ref_ext = '',
  $noupdateafterinsertline = 0 
)

Add an order line into database (linked to product/service or not)

Parameters
string$descDescription of line
float$pu_htUnit price (without tax)
float$qtyQuantite
float$txtvaForce Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')
float$txlocaltax1Local tax 1 rate (deprecated, use instead txtva with code inside)
float$txlocaltax2Local tax 2 rate (deprecated, use instead txtva with code inside)
int$fk_productId of product
float$remise_percentPercentage discount of the line
int$info_bitsBits of type of lines
int$fk_remise_exceptId remise
string$price_base_typeHT or TTC
float$pu_ttcPrix unitaire TTC
int$date_startStart date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
int$date_endEnd date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
int$typeType of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.
int$rangPosition of line
int$special_codeSpecial code (also used by externals modules!)
int$fk_parent_lineParent line
int$fk_fournpriceId supplier price
int$pa_htBuying price (without tax)
string$labelLabel
array$array_optionsextrafields array. Example array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)
string$fk_unitCode of the unit to use. Null to use the default one
string$originDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be 'orderdet', 'propaldet'..., else 'order','propal,'....
int$origin_idDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be Id of origin object (aka line id), else object id
double$pu_ht_deviseUnit price in currency
string$ref_extline external reference
int$noupdateafterinsertlineNo update after insert of line
Returns
int >0 if OK, <0 if KO
See also
add_product()

Les parametres sont deja cense etre juste et avec valeurs finales a l'appel de cette methode. Aussi, pour le taux tva, il doit deja avoir ete defini par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,produit) et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue)

Definition at line 1498 of file commande.class.php.

◆ availability()

Commande::availability (   $availability_id,
  $notrigger = 0 
)

Update delivery delay.

Parameters
int$availability_idId du nouveau mode
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int >0 if OK, <0 if KO

Definition at line 2794 of file commande.class.php.

◆ cancel()

Commande::cancel (   $idwarehouse = -1)

Cancel an order If stock is decremented on order validation, we must reincrement it.

Parameters
int$idwarehouseId warehouse to use for stock change.
Returns
int <0 if KO, >0 if OK

Definition at line 818 of file commande.class.php.

◆ classifyBilled()

Commande::classifyBilled ( User  $user,
  $notrigger = 0 
)

Classify the order as invoiced.

Parameters
User$userObject user making the change
int$notrigger1=Does not execute triggers, 0=execute triggers
Returns
int <0 if KO, 0 if already billed, >0 if OK

Definition at line 2977 of file commande.class.php.

References $sql, db, dol_syslog(), and STATUS_DRAFT.

◆ classifyUnBilled()

Commande::classifyUnBilled ( User  $user,
  $notrigger = 0 
)

Classify the order as not invoiced.

Parameters
User$userObject user making the change
int$notrigger1=Does not execute triggers, 0=execute triggers
Returns
int <0 if ko, >0 if ok

Definition at line 3031 of file commande.class.php.

References $sql, db, dol_syslog(), and STATUS_DRAFT.

◆ cloture()

Commande::cloture (   $user,
  $notrigger = 0 
)

Close order.

Parameters
User$userObjet user that close
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 758 of file commande.class.php.

◆ countNbOfShipments()

Commande::countNbOfShipments ( )

Returns an array with expeditions lines number.

Returns
int Nb of shipments

Definition at line 2324 of file commande.class.php.

References $sql.

◆ create()

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

Create order Note that this->ref can be set or empty.

If empty, we will use "(PROV)"

Parameters
User$userObjet user that make creation
int$notriggerDisable all triggers
Returns
int <0 if KO, >0 if OK

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

◆ createFromClone()

Commande::createFromClone ( User  $user,
  $socid = 0 
)

Load an object from its id and create a new one in database.

Parameters
User$userUser making the clone
int$socidId of thirdparty
Returns
int New id of clone

Definition at line 1198 of file commande.class.php.

◆ createFromProposal()

Commande::createFromProposal (   $object,
User  $user 
)

Load an object from a proposal and create a new order into database.

Parameters
Object$objectObject source
User$userUser making creation
Returns
int <0 if KO, 0 if nothing done, 1 if OK

Definition at line 1308 of file commande.class.php.

◆ delete()

Commande::delete (   $user,
  $notrigger = 0 
)

Delete the sales order.

Parameters
User$userUser object
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <=0 if KO, >0 if OK

Definition at line 3426 of file commande.class.php.

◆ deleteline()

Commande::deleteline (   $user = null,
  $lineid = 0,
  $id = 0 
)

Delete an order line.

Parameters
User$userUser object
int$lineidId of line to delete
int$idId of object (for a check)
Returns
int >0 if OK, 0 if nothing to do, <0 if KO

Definition at line 2392 of file commande.class.php.

◆ demand_reason()

Commande::demand_reason (   $demand_reason_id,
  $notrigger = 0 
)

Update order demand_reason.

Parameters
int$demand_reason_idId of new demand
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int >0 if ok, <0 if ko

Definition at line 2857 of file commande.class.php.

◆ fetch()

Commande::fetch (   $id,
  $ref = '',
  $ref_ext = '',
  $notused = '' 
)

Get object from database.

Get also lines.

Parameters
int$idId of object to load
string$refRef of object
string$ref_extExternal reference of object
string$notusedInternal reference of other object
Returns
int >0 if OK, <0 if KO, 0 if not found

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

References $sql, and dol_syslog().

◆ fetch_lines()

Commande::fetch_lines (   $only_product = 0,
  $loadalsotranslation = 0 
)

Load array lines.

Parameters
int$only_productReturn only physical products, not services
int$loadalsotranslationReturn translation for products
Returns
int <0 if KO, >0 if OK

Definition at line 2076 of file commande.class.php.

Referenced by getLinesArray().

◆ generateDocument()

Commande::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$outputlangsobjet lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

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

◆ getLabelSource()

Commande::getLabelSource ( )

Return source label of order.

Returns
string Label

Definition at line 3615 of file commande.class.php.

◆ getLibStatut()

Commande::getLibStatut (   $mode)

Return status label of Order.

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 3633 of file commande.class.php.

◆ getLinesArray()

Commande::getLinesArray ( )

Create an array of order lines.

Returns
int >0 if OK, <0 if KO

Definition at line 4054 of file commande.class.php.

References fetch_lines().

◆ getNbOfProductsLines()

Commande::getNbOfProductsLines ( )

Return number of line with type product.

Returns
int <0 if KO, Nbr of product lines if OK

Definition at line 2207 of file commande.class.php.

◆ getNbOfServicesLines()

Commande::getNbOfServicesLines ( )

Return number of line with type service.

Returns
int <0 if KO, Nbr of service lines if OK

Definition at line 2223 of file commande.class.php.

◆ getNbOfShipments()

Commande::getNbOfShipments ( )

Count number of shipments for this order.

Returns
int <0 if KO, Nb of shipment found if OK

Definition at line 2239 of file commande.class.php.

References $sql, and dol_syslog().

◆ getNextNumRef()

Commande::getNextNumRef (   $soc)

Returns the reference to the following non used Order depending on the active numbering module defined into COMMANDE_ADDON.

Parameters
Societe$socObject thirdparty
Returns
string Order free reference

Definition at line 413 of file commande.class.php.

◆ getNomUrl()

Commande::getNomUrl (   $withpicto = 0,
  $option = '',
  $max = 0,
  $short = 0,
  $notooltip = 0,
  $save_lastsearch_value = -1,
  $addlinktonotes = 0,
  $target = '' 
)

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
int$maxMax length to show
int$short???
int$notooltip1=Disable tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$addlinktonotesAdd link to notes
string$targetattribute target for link
Returns
string String with URL

Definition at line 3771 of file commande.class.php.

◆ getTooltipContentArray()

Commande::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsparams to construct tooltip data
Since
v18
Returns
array

Reimplemented from CommonObject.

Definition at line 3721 of file commande.class.php.

◆ hasDelay()

Commande::hasDelay ( )

Is the sales order delayed?

Returns
bool true if late, false if not

Definition at line 4134 of file commande.class.php.

◆ info()

Commande::info (   $id)

Charge les informations d'ordre info dans l'objet commande.

Parameters
int$idId of order
Returns
void

Definition at line 3886 of file commande.class.php.

References $sql.

◆ initAsSpecimen()

Commande::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
void

Definition at line 3929 of file commande.class.php.

◆ insert_discount()

Commande::insert_discount (   $idremise)

Adding line of fixed discount in the order in DB.

Parameters
int$idremiseId de la remise fixe
Returns
int >0 si ok, <0 si ko

Definition at line 2006 of file commande.class.php.

◆ LibStatut()

Commande::LibStatut (   $status,
  $billed,
  $mode,
  $donotshowbilled = 0 
)

Return label of status.

Parameters
int$statusId status
int$billedIf invoiced
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
int$donotshowbilledDo not show billed status after order status
Returns
string Label of status

Definition at line 3648 of file commande.class.php.

◆ liste_array()

Commande::liste_array (   $shortlist = 0,
  $draft = 0,
  $excluser = '',
  $socid = 0,
  $limit = 0,
  $offset = 0,
  $sortfield = 'c.date_commande',
  $sortorder = 'DESC' 
)

Return list of orders (eventuelly filtered on a user) into an array.

Parameters
int$shortlist0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name)
int$draft0=not draft, 1=draft
User$excluserObjet user to exclude
int$socidId third pary
int$limitFor pagination
int$offsetFor pagination
string$sortfieldSort criteria
string$sortorderSort order
Returns
int -1 if KO, array with result if OK

Definition at line 2727 of file commande.class.php.

◆ load_board()

Commande::load_board (   $user)

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

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

Definition at line 3556 of file commande.class.php.

◆ load_state_board()

Commande::load_state_board ( )

Charge indicateurs this->nb de tableau de bord.

Returns
int <0 si ko, >0 si ok

Definition at line 4017 of file commande.class.php.

◆ loadExpeditions()

Commande::loadExpeditions (   $filtre_statut = -1,
  $fk_product = 0 
)

Load array this->expeditions of lines of shipments with nb of products sent for each order line Note: For a dedicated shipment, the fetch_lines can be used to load the qty_asked and qty_shipped.

This function is use to return qty_shipped cumulated for the order

Parameters
int$filtre_statutFilter on shipment status
int$fk_productAdd a filter on a product
Returns
int <0 if KO, Nb of lines found if OK

Definition at line 2275 of file commande.class.php.

◆ replaceProduct()

static Commande::replaceProduct ( DoliDB  $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 4120 of file commande.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 4103 of file commande.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_date()

Commande::set_date (   $user,
  $date,
  $notrigger = 0 
)

Set the order date.

Parameters
User$userObject user making change
int$dateDate
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2591 of file commande.class.php.

References $sql, db, and dol_syslog().

◆ set_date_livraison()

Commande::set_date_livraison (   $user,
  $delivery_date,
  $notrigger = 0 
)

Set delivery date.

Parameters
User$userObject user that modify
int$delivery_dateDelivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if ko, >0 if ok
Deprecated:
Use setDeliveryDate

Definition at line 2650 of file commande.class.php.

References setDeliveryDate().

◆ set_ref_client()

Commande::set_ref_client (   $user,
  $ref_client,
  $notrigger = 0 
)

Set customer ref.

Parameters
User$userUser that make change
string$ref_clientCustomer ref
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2922 of file commande.class.php.

References $sql, db, and dol_syslog().

◆ set_remise()

Commande::set_remise (   $user,
  $remise,
  $notrigger = 0 
)

Applique une remise relative.

Deprecated:
See also
setDiscount()
Parameters
User$userUser qui positionne la remise
float$remiseDiscount (percent)
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2447 of file commande.class.php.

References dol_syslog(), and setDiscount().

◆ set_remise_absolue()

Commande::set_remise_absolue (   $user,
  $remise,
  $notrigger = 0 
)

Set a fixed amount discount.

Parameters
User$userUser qui positionne la remise
float$remiseDiscount
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2525 of file commande.class.php.

References $sql, db, dol_syslog(), price2num(), and STATUS_DRAFT.

◆ set_reopen()

Commande::set_reopen (   $user)

Tag the order as validated (opened) Function used when order is reopend after being closed.

Parameters
User$userObject user that change status
Returns
int <0 if KO, 0 if nothing is done, >0 if OK

Definition at line 703 of file commande.class.php.

References $sql, db, and dol_syslog().

◆ setDeliveryDate()

Commande::setDeliveryDate (   $user,
  $delivery_date,
  $notrigger = 0 
)

Set the planned delivery date.

Parameters
User$userObjet utilisateur qui modifie
int$delivery_dateDelivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 si ko, >0 si ok

Definition at line 2664 of file commande.class.php.

References $sql, db, and dol_syslog().

Referenced by set_date_livraison().

◆ setDiscount()

Commande::setDiscount (   $user,
  $remise,
  $notrigger = 0 
)

Set a percentage discount.

Parameters
User$userUser setting the discount
float$remiseDiscount (percent)
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2462 of file commande.class.php.

References $sql, db, dol_syslog(), and price2num().

Referenced by set_remise().

◆ setDraft()

Commande::setDraft (   $user,
  $idwarehouse = -1 
)

Set draft status.

Parameters
User$userObject user that modify
int$idwarehouseWarehouse ID to use for stock change (Used only if option STOCK_CALCULATE_ON_VALIDATE_ORDER is on)
Returns
int <0 if KO, >0 if OK

Definition at line 617 of file commande.class.php.

◆ showDelay()

Commande::showDelay ( )

Show the customer delayed info.

Returns
string Show delayed information

Definition at line 4152 of file commande.class.php.

◆ stock_array()

Commande::stock_array (   $filtre_statut = self::STATUS_CANCELED)

Return a array with the pending stock by product.

Parameters
int$filtre_statutFiltre sur statut
Returns
int 0 si OK, <0 si KO

TODO FONCTION NON FINIE A FINIR

Definition at line 2354 of file commande.class.php.

References $sql.

◆ update()

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

Update database.

Parameters
User$userUser that modify
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 3319 of file commande.class.php.

◆ updateline()

Commande::updateline (   $rowid,
  $desc,
  $pu,
  $qty,
  $remise_percent,
  $txtva,
  $txlocaltax1 = 0.0,
  $txlocaltax2 = 0.0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $date_start = '',
  $date_end = '',
  $type = 0,
  $fk_parent_line = 0,
  $skip_update_total = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $label = '',
  $special_code = 0,
  $array_options = 0,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 0,
  $ref_ext = '',
  $rang = 0 
)

Update a line in database.

Parameters
int$rowidId of line to update
string$descDescription of line
float$puUnit price
float$qtyQuantity
float$remise_percentPercent of discount
float$txtvaTaux TVA
float$txlocaltax1Local tax 1 rate
float$txlocaltax2Local tax 2 rate
string$price_base_typeHT or TTC
int$info_bitsMiscellaneous informations on line
int$date_startStart date of the line
int$date_endEnd date of the line
int$typeType of line (0=product, 1=service)
int$fk_parent_lineId of parent line (0 in most cases, used by modules adding sublevels into lines).
int$skip_update_totalKeep fields total_xxx to 0 (used for special lines by some modules)
int$fk_fournpriceId of origin supplier price
int$pa_htPrice (without tax) of product when it was bought
string$labelLabel
int$special_codeSpecial code (also used by externals modules!)
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseAmount in currency
int$notriggerdisable line update trigger
string$ref_extexternal reference
integer$rangline rank
Returns
int < 0 if KO, > 0 if OK

Definition at line 3107 of file commande.class.php.

◆ valid()

Commande::valid (   $user,
  $idwarehouse = 0,
  $notrigger = 0 
)

Validate order.

Parameters
User$userUser making status change
int$idwarehouseId of warehouse to use for stock decrease
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <=0 if OK, 0=Nothing done, >0 if KO

Definition at line 463 of file commande.class.php.


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