dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
CommandeFournisseur Class Reference

Class to manage predefined suppliers products. More...

+ Inheritance diagram for CommandeFournisseur:
+ Collaboration diagram for CommandeFournisseur:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 fetch ($id, $ref='')
 Get object and lines from database. More...
 
 fetch_lines ($only_product=0)
 Load array lines. More...
 
 valid ($user, $idwarehouse=0, $notrigger=0)
 Validate an order. More...
 
 getLibStatut ($mode=0)
 Return label of the status of object. More...
 
 LibStatut ($statut, $mode=0, $billed=0)
 Return label of a status. More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getNextNumRef ($soc)
 Returns the following order reference not used depending on the numbering model activated defined within COMMANDE_SUPPLIER_ADDON_NUMBER. More...
 
 classifyBilled (User $user)
 Class invoiced the supplier order. More...
 
 approve ($user, $idwarehouse=0, $secondlevel=0)
 Approve a supplier order. More...
 
 refuse ($user)
 Refuse an order. More...
 
 Cancel ($user, $idwarehouse=-1)
 Cancel an approved order. More...
 
 commande ($user, $date, $methode, $comment='')
 Submit a supplier order to supplier. More...
 
 create ($user, $notrigger=0)
 Create order with draft status. More...
 
 createFromClone ()
 Load an object from its id and create a new one in database. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $fk_product=0, $fk_prod_fourn_price=0, $ref_supplier='', $remise_percent=0.0, $price_base_type='HT', $pu_ttc=0.0, $type=0, $info_bits=0, $notrigger=false, $date_start=null, $date_end=null, $array_options=0, $fk_unit=null, $pu_ht_devise=0, $origin='', $origin_id=0)
 Add order line. More...
 
 dispatchProduct ($user, $product, $qty, $entrepot, $price=0, $comment='', $eatby='', $sellby='', $batch='', $fk_commandefourndet=0, $notrigger=0)
 Save a receiving into the tracking table of receiving (commande_fournisseur_dispatch) and add product into stock warehouse. More...
 
 deleteline ($idline, $notrigger=0)
 Delete line. More...
 
 delete (User $user, $notrigger=0)
 Delete an order. More...
 
 get_methodes_commande ()
 Get list of order methods. More...
 
 getDispachedLines ($status=-1)
 Return array of dispatched lines waiting to be approved for this order. More...
 
 Livraison ($user, $date, $type, $comment)
 Set a delivery in database for this supplier order. More...
 
 set_date_livraison ($user, $date_livraison, $notrigger=0)
 Set the planned delivery date. More...
 
 set_id_projet ($user, $id_projet, $notrigger=0)
 Set the id projet. More...
 
 updateFromCommandeClient ($user, $idc, $comclientid)
 Update a supplier order from a customer order. More...
 
 setStatus ($user, $status)
 Tag order with a particular status. More...
 
 updateline ($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0, $txlocaltax2=0, $price_base_type='HT', $info_bits=0, $type=0, $notrigger=0, $date_start='', $date_end='', $array_options=0, $fk_unit=null, $pu_ht_devise=0, $ref_supplier='')
 Update line. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet facture. More...
 
 load_state_board ()
 Charge indicateurs this->nb de tableau de bord. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getInputMethod ()
 Returns the translated input method of object (defined if $this->methode_commande_id > 0). More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template model. More...
 
 getMaxDeliveryTimeDay ($langs)
 Return the max number delivery delay in day. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 hasDelay ()
 Is the supplier order delayed? More...
 
 showDelay ()
 Show the customer delayed info. More...
 
 calcAndSetStatusDispatch (User $user, $closeopenorder=1, $comment='')
 Calc status regarding to dispatched stock. 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_livraison
 Delivery date.
 
 $note
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_ACCEPTED = 2
 Accepted.
 
const STATUS_ORDERSENT = 3
 Order sent, shipment on process.
 
const STATUS_RECEIVED_PARTIALLY = 4
 Received partially.
 
const STATUS_RECEIVED_COMPLETELY = 5
 Received completely.
 
const STATUS_CANCELED = 6
 Order canceled.
 
const STATUS_CANCELED_AFTER_ORDER = 7
 Order canceled/never received.
 
const STATUS_REFUSED = 9
 Refused.
 
- 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 predefined suppliers products.

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

Constructor & Destructor Documentation

◆ __construct()

CommandeFournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 236 of file fournisseur.commande.class.php.

Member Function Documentation

◆ addline()

CommandeFournisseur::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0.0,
  $txlocaltax2 = 0.0,
  $fk_product = 0,
  $fk_prod_fourn_price = 0,
  $ref_supplier = '',
  $remise_percent = 0.0,
  $price_base_type = 'HT',
  $pu_ttc = 0.0,
  $type = 0,
  $info_bits = 0,
  $notrigger = false,
  $date_start = null,
  $date_end = null,
  $array_options = 0,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $origin = '',
  $origin_id = 0 
)

Add order line.

Parameters
string$descDescription
float$pu_htUnit price
float$qtyQuantity
float$txtvaTaux tva
float$txlocaltax1Localtax1 tax
float$txlocaltax2Localtax2 tax
int$fk_productId product
int$fk_prod_fourn_priceId supplier price
string$ref_supplierSupplier reference price
float$remise_percentRemise
string$price_base_typeHT or TTC
float$pu_ttcUnit price TTC
int$typeType of line (0=product, 1=service)
int$info_bitsMore information
bool$notriggerDisable triggers
int$date_startDate start of service
int$date_endDate end of service
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
string$pu_ht_deviseAmount in currency
string$origin'order', ...
int$origin_idId of origin object
Returns
int <=0 if KO, >0 if OK

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

◆ approve()

CommandeFournisseur::approve (   $user,
  $idwarehouse = 0,
  $secondlevel = 0 
)

Approve a supplier order.

Parameters
User$userObject user
int$idwarehouseId of warhouse for stock change
int$secondlevel0=Standard approval, 1=Second level approval (used when option SUPPLIER_ORDER_3_STEPS_TO_BE_APPROVED is set)
Returns
int <0 if KO, >0 if OK

Definition at line 882 of file fournisseur.commande.class.php.

◆ calcAndSetStatusDispatch()

CommandeFournisseur::calcAndSetStatusDispatch ( User  $user,
  $closeopenorder = 1,
  $comment = '' 
)

Calc status regarding to dispatched stock.

Parameters
User$userUser action
int$closeopenorderClose if received
string$commentComment
Returns
int <0 if KO, 0 if not applicable, >0 if OK

Definition at line 3017 of file fournisseur.commande.class.php.

◆ Cancel()

CommandeFournisseur::Cancel (   $user,
  $idwarehouse = -1 
)

Cancel an approved order.

The cancellation is done after approval

Parameters
User$userUser making action
int$idwarehouseId warehouse to use for stock change (not used for supplier orders).
Returns
int >0 if Ok, <0 if Ko

Definition at line 1091 of file fournisseur.commande.class.php.

◆ classifyBilled()

CommandeFournisseur::classifyBilled ( User  $user)

Class invoiced the supplier order.

Parameters
User$userObject user making the change
Returns
int <0 if KO, >0 if KO

Definition at line 835 of file fournisseur.commande.class.php.

◆ commande()

CommandeFournisseur::commande (   $user,
  $date,
  $methode,
  $comment = '' 
)

Submit a supplier order to supplier.

Parameters
User$userUser making change
date$dateDate
int$methodeMethod
string$commentComment
Returns
int <0 if KO, >0 if OK

Definition at line 1153 of file fournisseur.commande.class.php.

◆ create()

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

Create order with draft status.

Parameters
User$userUser making creation
int$notriggerDisable all triggers
Returns
int <0 if KO, Id of supplier order if OK

Definition at line 1211 of file fournisseur.commande.class.php.

◆ createFromClone()

CommandeFournisseur::createFromClone ( )

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

Returns
int New id of clone

Definition at line 1414 of file fournisseur.commande.class.php.

◆ delete()

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

Delete an order.

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

Definition at line 1895 of file fournisseur.commande.class.php.

◆ deleteline()

CommandeFournisseur::deleteline (   $idline,
  $notrigger = 0 
)

Delete line.

Parameters
int$idlineId of line to delete
int$notrigger1=Disable call to triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1859 of file fournisseur.commande.class.php.

◆ dispatchProduct()

CommandeFournisseur::dispatchProduct (   $user,
  $product,
  $qty,
  $entrepot,
  $price = 0,
  $comment = '',
  $eatby = '',
  $sellby = '',
  $batch = '',
  $fk_commandefourndet = 0,
  $notrigger = 0 
)

Save a receiving into the tracking table of receiving (commande_fournisseur_dispatch) and add product into stock warehouse.

Parameters
User$userUser object making change
int$productId of product to dispatch
double$qtyQty to dispatch
int$entrepotId of warehouse to add product
double$priceUnit Price for PMP value calculation (Unit price without Tax and taking into account discount)
string$commentComment for stock movement
date$eatbyeat-by date
date$sellbysell-by date
string$batchLot number
int$fk_commandefourndetId of supplier order line
int$notrigger1 = notrigger
Returns
int <0 if KO, >0 if OK

Definition at line 1757 of file fournisseur.commande.class.php.

◆ fetch()

CommandeFournisseur::fetch (   $id,
  $ref = '' 
)

Get object and lines from database.

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

Definition at line 251 of file fournisseur.commande.class.php.

◆ fetch_lines()

CommandeFournisseur::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 385 of file fournisseur.commande.class.php.

◆ generateDocument()

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

Create a document onto disk according to template model.

Parameters
string$modeleForce template to use ('' to not force)
Translate$outputlangsObject lang to use for 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 2892 of file fournisseur.commande.class.php.

◆ get_methodes_commande()

CommandeFournisseur::get_methodes_commande ( )

Get list of order methods.

Returns
int 0 if OK, <0 if KO

Definition at line 2015 of file fournisseur.commande.class.php.

◆ getDispachedLines()

CommandeFournisseur::getDispachedLines (   $status = -1)

Return array of dispatched lines waiting to be approved for this order.

Since
8.0 Return dispatched quantity (qty).
Parameters
int$statusFilter on stats (-1 = no filter, 0 = lines draft to be approved, 1 = approved lines)
Returns
array Array of lines

Definition at line 2052 of file fournisseur.commande.class.php.

◆ getInputMethod()

CommandeFournisseur::getInputMethod ( )

Returns the translated input method of object (defined if $this->methode_commande_id > 0).

This function make a sql request to get translation. No cache yet, try to not use it inside a loop.

Returns
string

Definition at line 2850 of file fournisseur.commande.class.php.

◆ getLibStatut()

CommandeFournisseur::getLibStatut (   $mode = 0)

Return label of the status of object.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto
Returns
string Label

Definition at line 614 of file fournisseur.commande.class.php.

◆ getMaxDeliveryTimeDay()

CommandeFournisseur::getMaxDeliveryTimeDay (   $langs)

Return the max number delivery delay in day.

Parameters
Translate$langsLanguage object
Returns
Translated string

Definition at line 2920 of file fournisseur.commande.class.php.

◆ getNextNumRef()

CommandeFournisseur::getNextNumRef (   $soc)

Returns the following order reference not used depending on the numbering model activated defined within COMMANDE_SUPPLIER_ADDON_NUMBER.

Parameters
Company$soccompany object
Returns
string free reference for the invoice

Definition at line 782 of file fournisseur.commande.class.php.

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
string$optionOn what the link points
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 Chain with URL

Definition at line 722 of file fournisseur.commande.class.php.

◆ getRights()

CommandeFournisseur::getRights ( )

Returns the rights used for this class.

Returns
stdClass

Definition at line 2948 of file fournisseur.commande.class.php.

◆ hasDelay()

CommandeFournisseur::hasDelay ( )

Is the supplier order delayed?

Returns
bool

Definition at line 2978 of file fournisseur.commande.class.php.

◆ info()

CommandeFournisseur::info (   $id)

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

Parameters
int$idId de la facture a charger
Returns
void

Definition at line 2708 of file fournisseur.commande.class.php.

◆ initAsSpecimen()

CommandeFournisseur::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 2626 of file fournisseur.commande.class.php.

◆ LibStatut()

CommandeFournisseur::LibStatut (   $statut,
  $mode = 0,
  $billed = 0 
)

Return label of a status.

Parameters
int$statutId statut
int$mode0=Long label, 1=Short label, 2=Picto + Short label, 3=Picto, 4=Picto + Long label, 5=Short label + Picto
int$billed1=Billed
Returns
string Label of status

Definition at line 628 of file fournisseur.commande.class.php.

◆ Livraison()

CommandeFournisseur::Livraison (   $user,
  $date,
  $type,
  $comment 
)

Set a delivery in database for this supplier order.

Parameters
User$userUser that input data
date$dateDate of reception
string$typeType of receipt ('tot' = total/done, 'par' = partial, 'nev' = never, 'can' = cancel)
string$commentComment
Returns
int <0 if KO, >0 if OK

Definition at line 2106 of file fournisseur.commande.class.php.

◆ load_board()

CommandeFournisseur::load_board (   $user)

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

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

Definition at line 2792 of file fournisseur.commande.class.php.

◆ load_state_board()

CommandeFournisseur::load_state_board ( )

Charge indicateurs this->nb de tableau de bord.

Returns
int <0 si ko, >0 si ok

Definition at line 2748 of file fournisseur.commande.class.php.

◆ refuse()

CommandeFournisseur::refuse (   $user)

Refuse an order.

Parameters
User$userUser making action
Returns
int 0 if Ok, <0 if Ko

Definition at line 1034 of file fournisseur.commande.class.php.

◆ replaceThirdparty()

static CommandeFournisseur::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 2964 of file fournisseur.commande.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_date_livraison()

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

Set the planned delivery date.

Parameters
User$userObjet user making change
timestamp$date_livraisonPlanned delivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 2222 of file fournisseur.commande.class.php.

◆ set_id_projet()

CommandeFournisseur::set_id_projet (   $user,
  $id_projet,
  $notrigger = 0 
)

Set the id projet.

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

Definition at line 2288 of file fournisseur.commande.class.php.

◆ setStatus()

CommandeFournisseur::setStatus (   $user,
  $status 
)

Tag order with a particular status.

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

Definition at line 2396 of file fournisseur.commande.class.php.

◆ showDelay()

CommandeFournisseur::showDelay ( )

Show the customer delayed info.

Returns
string Show delayed information

Definition at line 2995 of file fournisseur.commande.class.php.

◆ updateFromCommandeClient()

CommandeFournisseur::updateFromCommandeClient (   $user,
  $idc,
  $comclientid 
)

Update a supplier order from a customer order.

Parameters
User$userUser that create
int$idcId of supplier order to update
int$comclientidId of customer order to use as template
Returns
int <0 if KO, >0 if OK

Definition at line 2353 of file fournisseur.commande.class.php.

◆ updateline()

CommandeFournisseur::updateline (   $rowid,
  $desc,
  $pu,
  $qty,
  $remise_percent,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $type = 0,
  $notrigger = 0,
  $date_start = '',
  $date_end = '',
  $array_options = 0,
  $fk_unit = null,
  $pu_ht_devise = 0,
  $ref_supplier = '' 
)

Update line.

Parameters
int$rowidId de la ligne de facture
string$descDescription de la ligne
double$puPrix unitaire
double$qtyQuantity
double$remise_percentPercent discount on line
double$txtvaVAT rate
double$txlocaltax1Localtax1 tax
double$txlocaltax2Localtax2 tax
double$price_base_typeType of price base
int$info_bitsMiscellaneous informations
int$typeType of line (0=product, 1=service)
int$notriggerDisable triggers
timestamp$date_startDate start of service
timestamp$date_endDate end of service
array$array_optionsExtrafields array
string$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseUnit price in currency
string$ref_supplierSupplier ref
Returns
int < 0 if error, > 0 if ok

Definition at line 2470 of file fournisseur.commande.class.php.

◆ valid()

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

Validate an order.

Parameters
User$userValidator User
int$idwarehouseId of warehouse to use for stock decrease
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 495 of file fournisseur.commande.class.php.

Member Data Documentation

◆ $note

CommandeFournisseur::$note
Deprecated:
See also
note_private, note_public

Definition at line 128 of file fournisseur.commande.class.php.


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