dolibarr  9.0.0
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:
+ Collaboration diagram for Commande:

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...
 
 set_draft ($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 ($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)
 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='', $ref_int='')
 Get object and lines from database. More...
 
 insert_discount ($idremise)
 Adding line of fixed discount in the order in DB. More...
 
 fetch_lines ($only_product=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 numbe rof shipments for this order. More...
 
 loadExpeditions ($filtre_statut=-1)
 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...
 
 nb_expedition ()
 Returns a 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)
 Delete an order line. More...
 
 set_remise ($user, $remise, $notrigger=0)
 Applique une remise relative. More...
 
 set_remise_absolue ($user, $remise, $notrigger=0)
 Applique une remise absolue. More...
 
 set_date ($user, $date, $notrigger=0)
 Set the order date. More...
 
 set_date_livraison ($user, $date_livraison, $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 ()
 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)
 Update a line in database. More...
 
 update (User $user, $notrigger=0)
 Update database. More...
 
 delete ($user, $notrigger=0)
 Delete the customer 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 ($statut, $billed, $mode, $donotshowbilled=0)
 Return label of status. More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $notooltip=0, $save_lastsearch_value=-1)
 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 customer order delayed? More...
 
 showDelay ()
 Show the customer delayed info. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 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. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 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...
 
 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->contactid 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_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)
 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)
 Change the 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)
 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)
 Add objects linked in 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...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 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)
 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...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 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='')
 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...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. 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...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 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, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. 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...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $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...
 
 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...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty 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 commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $date_commande
 
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
 
 $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...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage customers orders.

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

Constructor & Destructor Documentation

◆ __construct()

Commande::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

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 - 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)
Returns
void

TODO Remplacer les appels a cette fonction par generation objet Ligne insere dans tableau $this->products

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(! in_array($value[1],$this->products)) $this->add_product($value[1], $value[0]);

} }

}

Definition at line 1534 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 
)

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_percentPourcentage de remise de la ligne
int$info_bitsBits de type de lignes
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$origin'order', ...
int$origin_idId of origin object
double$pu_ht_deviseUnit price in currency
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 1305 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 2565 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 680 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 OK

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

◆ classifyUnBilled()

Commande::classifyUnBilled ( )

Classify the order as not invoiced.

Returns
int <0 if ko, >0 if ok

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

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

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

◆ createFromClone()

Commande::createFromClone (   $socid = 0)

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

Parameters
int$socidId of thirdparty
Returns
int New id of clone

Definition at line 1063 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 1148 of file commande.class.php.

◆ delete()

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

Delete the customer 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 3192 of file commande.class.php.

◆ deleteline()

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

Delete an order line.

Parameters
User$userUser object
int$lineidId of line to delete
Returns
int >0 if OK, 0 if nothing to do, <0 if KO

Definition at line 2146 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 2636 of file commande.class.php.

◆ fetch()

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

Get object and lines from database.

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

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

◆ fetch_lines()

Commande::fetch_lines (   $only_product = 0)

Load array lines.

Parameters
int$only_productReturn only physical products
Returns
int <0 if KO, >0 if OK

Definition at line 1848 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 3785 of file commande.class.php.

◆ getLabelSource()

Commande::getLabelSource ( )

Return source label of order.

Returns
string Label

Definition at line 3380 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 3396 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 3769 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 1964 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 1979 of file commande.class.php.

◆ getNbOfShipments()

Commande::getNbOfShipments ( )

Count numbe rof shipments for this order.

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

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

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

◆ getNomUrl()

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

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
Returns
string String with URL

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

◆ hasDelay()

Commande::hasDelay ( )

Is the customer order delayed?

Returns
bool true if late, false if not

Definition at line 3830 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 3581 of file commande.class.php.

◆ 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 3639 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 1769 of file commande.class.php.

◆ LibStatut()

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

Return label of status.

Parameters
int$statutId statut
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 3411 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 2497 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 3321 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 3727 of file commande.class.php.

◆ loadExpeditions()

Commande::loadExpeditions (   $filtre_statut = -1)

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
Returns
int <0 if KO, Nb of lines found if OK

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

◆ nb_expedition()

Commande::nb_expedition ( )

Returns a array with expeditions lines number.

Returns
int Nb of shipments

TODO deprecate, move to Shipping class

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

◆ replaceThirdparty()

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

◆ set_date_livraison()

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

Set the planned delivery date.

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

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

◆ set_draft()

Commande::set_draft (   $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 477 of file commande.class.php.

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

◆ set_remise()

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

Applique une remise relative.

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

◆ set_remise_absolue()

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

Applique une remise absolue.

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

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

◆ showDelay()

Commande::showDelay ( )

Show the customer delayed info.

Returns
string Show delayed information

Definition at line 3848 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 2106 of file commande.class.php.

◆ 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 3097 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 
)

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
Returns
int < 0 if KO, > 0 if OK

Definition at line 2907 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 316 of file commande.class.php.

Member Data Documentation

◆ $date_commande

Commande::$date_commande
Deprecated:
See also
date

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


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