dolibarr  20.0.0-alpha
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:
Inheritance graph
[legend]
Collaboration diagram for CommandeFournisseur:
Collaboration graph
[legend]

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 ($status, $mode=0, $billed=0)
 Return label of a status. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0)
 Return clicable name (with picto eventually) More...
 
 getNextNumRef ($soc)
 Returns the next order reference not used, based on the numbering model 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...
 
 update (User $user, $notrigger=0)
 Update Supplier Order. More...
 
 createFromClone (User $user, $socid=0, $notrigger=0)
 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=0, $date_start=null, $date_end=null, $array_options=[], $fk_unit=null, $pu_ht_devise=0, $origin='', $origin_id=0, $rang=-1, $special_code=0)
 Add order line. More...
 
 dispatchProduct ($user, $product, $qty, $entrepot, $price=0, $comment='', $eatby='', $sellby='', $batch='', $fk_commandefourndet=0, $notrigger=0, $fk_reception=0)
 Save a receiving into the tracking table of receiving (receptiondet_batch) and add product into stock warehouse. More...
 
 deleteLine ($idline, $notrigger=0)
 Delete line. More...
 
 delete (User $user, $notrigger=0)
 Delete an order. 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, $delivery_date, $notrigger=0)
 Set delivery date. More...
 
 setDeliveryDate ($user, $delivery_date, $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 sales 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=0, $date_end=0, $array_options=[], $fk_unit=null, $pu_ht_devise=0, $ref_supplier='')
 Update line. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 info ($id)
 Charge les information d'ordre info dans l'objet facture. More...
 
 loadStateBoard ()
 Load the indicators this->nb for the state board. More...
 
 load_board ($user, $mode='opened')
 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? We suppose a purchase ordered as late if a the purchase order has been sent and the delivery date is set and before the delay. More...
 
 showDelay ()
 Show the customer delayed info. More...
 
 calcAndSetStatusDispatch (User $user, $closeopenorder=1, $comment='')
 Calc status regarding to dispatched stock. More...
 
 loadReceptions ($filtre_statut=-1)
 Load array this->receptions 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...
 
 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...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. 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...
 
 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=0, $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=0, $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='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. 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=0, $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 (by children). 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='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 getDataToShowPhoto 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, $cache='', $addphotorefcss='photoref')
 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...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed 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 $dbs, $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 if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch. 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 getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count 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

 $fields
 'type' field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]', 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:Sortfield]]]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'text:none', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key. More...
 
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.
 
const SOURCE_ID_REPLENISHMENT = 42
 The constant used into source field to track the order was generated by the replenishement feature.
 
- Public Attributes inherited from CommonObject
 $origin_object
 
 $fk_departement
 var int State ID More...
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements. More...
 
 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 return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage predefined suppliers products.

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

Constructor & Destructor Documentation

◆ __construct()

CommandeFournisseur::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 464 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 = 0,
  $date_start = null,
  $date_end = null,
  $array_options = [],
  $fk_unit = null,
  $pu_ht_devise = 0,
  $origin = '',
  $origin_id = 0,
  $rang = -1,
  $special_code = 0 
)

Add order line.

Parameters
string$descDescription
float$pu_htUnit price (used if $price_base_type is 'HT')
float$qtyQuantity
float$txtvaVAT Rate
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 (used if $price_base_type is 'TTC')
int$typeType of line (0=product, 1=service)
int$info_bitsMore information
int$notriggerDisable triggers
int$date_startDate start of service
int$date_endDate end of service
array$array_optionsextrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
int | string$pu_ht_deviseAmount in currency
string$origin'order', ...
int$origin_idId of origin object
int$rangRank
int$special_codeSpecial code
Returns
int Return integer <=0 if KO, >0 if OK

Definition at line 1939 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 Return integer <0 if KO, >0 if OK

Definition at line 1208 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 Return integer <0 if KO, 0 if not applicable, >0 if OK

Definition at line 3527 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 1398 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 Return integer <0 if KO, 0 if already billed, >0 if OK

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

References $sql, and STATUS_DRAFT.

◆ commande()

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

Submit a supplier order to supplier.

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

Definition at line 1453 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 Return integer <0 if KO, Id of supplier order if OK

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

◆ createFromClone()

CommandeFournisseur::createFromClone ( User  $user,
  $socid = 0,
  $notrigger = 0 
)

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

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

Definition at line 1831 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 Return integer <0 if KO, >0 if OK

Definition at line 2361 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 Return integer <0 if KO, >0 if OK

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

◆ dispatchProduct()

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

Save a receiving into the tracking table of receiving (receptiondet_batch) 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
int | string$eatbyeat-by date
int | string$sellbysell-by date
string$batchLot number
int$fk_commandefourndetId of supplier order line
int$notrigger1 = notrigger
int$fk_receptionId of reception to link
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2225 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 477 of file fournisseur.commande.class.php.

References $sql, and dol_syslog().

◆ fetch_lines()

CommandeFournisseur::fetch_lines (   $only_product = 0)

Load array lines.

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

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

References $sql, and dol_syslog().

◆ 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 Return integer < 0 if KO, 0 = no doc generated, > 0 if OK

Definition at line 3352 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 2493 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 3313 of file fournisseur.commande.class.php.

◆ getKanbanView()

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

Return clicable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array$arraydataArray of data
Returns
string HTML Code for Kanban thumb.

Reimplemented from CommonOrder.

Definition at line 3708 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 875 of file fournisseur.commande.class.php.

◆ getMaxDeliveryTimeDay()

CommandeFournisseur::getMaxDeliveryTimeDay (   $langs)

Return the max number delivery delay in day.

Parameters
Translate$langsLanguage object
Returns
string Translated string

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

◆ getNextNumRef()

CommandeFournisseur::getNextNumRef (   $soc)

Returns the next order reference not used, based on the numbering model defined within COMMANDE_SUPPLIER_ADDON_NUMBER.

Parameters
Societe$soccompany object
Returns
string|int free reference for the invoice. '', -1 or -2 if error.

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

◆ getNomUrl()

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

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
int$addlinktonotesAdd link to show notes
Returns
string Chain with URL

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

◆ getRights()

CommandeFournisseur::getRights ( )

Returns the rights used for this class.

Returns
int

Reimplemented from CommonObject.

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

◆ getTooltipContentArray()

CommandeFournisseur::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsex option, infologin
Since
v18
Returns
array

Reimplemented from CommonObject.

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

◆ hasDelay()

CommandeFournisseur::hasDelay ( )

Is the supplier order delayed? We suppose a purchase ordered as late if a the purchase order has been sent and the delivery date is set and before the delay.

If order has not been sent, we use the order date.

Returns
bool True if object is delayed

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

◆ info()

CommandeFournisseur::info (   $id)

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

Parameters
int$idId de la facture a charger
Returns
void

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

References $sql.

◆ 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
int

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

◆ LibStatut()

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

Return label of a status.

Parameters
int$statusId statut
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$billed1=Billed
Returns
string Label of status

Definition at line 889 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
integer$dateDate of reception
string$typeType of receipt ('tot' = total/done, 'par' = partial, 'nev' = never, 'can' = cancel)
string$commentComment
Returns
int Return integer <0 if KO, >0 if OK

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

◆ load_board()

CommandeFournisseur::load_board (   $user,
  $mode = 'opened' 
)

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

Parameters
User$userObject user
string$mode"opened", "awaiting" for orders awaiting reception
Returns
WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

◆ loadReceptions()

CommandeFournisseur::loadReceptions (   $filtre_statut = -1)

Load array this->receptions 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 Return integer <0 if KO, Nb of lines found if OK

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

References $sql, and dol_syslog().

◆ loadStateBoard()

CommandeFournisseur::loadStateBoard ( )

Load the indicators this->nb for the state board.

Returns
int Return integer <0 si ko, >0 si ok

Definition at line 3211 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 1349 of file fournisseur.commande.class.php.

◆ replaceProduct()

static CommandeFournisseur::replaceProduct ( DoliDB  $dbs,
  $origin_id,
  $dest_id 
)
static

Function used to replace a product id with another one.

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

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

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

References CommonObject\commonReplaceThirdparty().

◆ set_date_livraison()

CommandeFournisseur::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 Return integer <0 if ko, >0 if ok
Deprecated:
Use setDeliveryDate

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

References setDeliveryDate().

◆ set_id_projet()

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

Set the id projet.

Parameters
User$userObject utilisateur qui modifie
int$id_projetDelivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 si ko, >0 si ok

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

References $sql, and dol_syslog().

◆ setDeliveryDate()

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

Set the planned delivery date.

Parameters
User$userObject user making change
integer$delivery_datePlanned delivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

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

References $sql, and dol_syslog().

Referenced by set_date_livraison().

◆ setStatus()

CommandeFournisseur::setStatus (   $user,
  $status 
)

Tag order with a particular status.

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

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

◆ showDelay()

CommandeFournisseur::showDelay ( )

Show the customer delayed info.

We suppose a purchase ordered as late if a the purchase order has been sent and the delivery date is set and before the delay. If order has not been sent, we use the order date.

Returns
string Show delayed information

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

◆ update()

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

Update Supplier Order.

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

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

◆ updateFromCommandeClient()

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

Update a supplier order from a sales order.

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

Definition at line 2790 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 = 0,
  $date_end = 0,
  $array_options = [],
  $fk_unit = null,
  $pu_ht_devise = 0,
  $ref_supplier = '' 
)

Update line.

Parameters
int$rowidID de la ligne de facture
string$descLine description
int | float$puUnit price
int | float$qtyQuantity
int | float$remise_percentPercent discount on line
int | float$txtvaVAT rate
int | float$txlocaltax1Localtax1 tax
int | float$txlocaltax2Localtax2 tax
string$price_base_typeType of price base
int$info_bitsMiscellaneous information
int$typeType of line (0=product, 1=service)
int$notriggerDisable triggers
integer$date_startDate start of service
integer$date_endDate end of service
array$array_optionsExtrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
int | float$pu_ht_deviseUnit price in currency
string$ref_supplierSupplier ref
Returns
int Return integer < 0 if error, > 0 if ok

Definition at line 2901 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 Return integer <0 if KO, >0 if OK

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

Member Data Documentation

◆ $fields

CommandeFournisseur::$fields

'type' field format ('integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]', 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:Sortfield]]]]', 'varchar(x)', 'double(24,8)', 'real', 'price', 'text', 'text:none', 'html', 'date', 'datetime', 'timestamp', 'duration', 'mail', 'phone', 'url', 'password') Note: Filter can be a string like "(t.ref:like:'SO-%') or (t.date_creation:<:'20160101') or (t.nature:is:NULL)" 'label' the translation key.

'picto' is code of a picto to show before value in forms 'enabled' is a condition when the field must be managed (Example: 1 or 'getDolGlobalString("MY_SETUP_PARAM")' or 'isModEnabled("multicurrency")' ...) 'position' is the sort order of field. 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0). 'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view forms, 2=Visible on list only, 3=Visible on create/update/view form only (not list), 4=Visible on list and update/view form only (not create). 5=Visible on list and view only (not create/not update). Using a negative value means field is not shown by default on list but can be selected for viewing) 'noteditable' says if field is not editable (1 or 0) 'default' is a default value for creation (can still be overwrote by the Setup of Default Values if field is editable in creation form). Note: If default is set to '(PROV)' and field is 'ref', the default value will be set to '(PROVid)' where id is rowid when a new record is created. 'index' if we want an index in database. 'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...). 'searchall' is 1 if we want to search in this field when making a search from the quick search button. 'isameasure' must be set to 1 or 2 if field can be used for measure. Field type must be summable like integer or double(24,8). Use 1 in most cases, or 2 if you don't want to see the column total into list (for example for percentage) 'css' and 'cssview' and 'csslist' is the CSS style to use on field. 'css' is used in creation and update. 'cssview' is used in view mode. 'csslist' is used for columns in lists. For example: 'css'=>'minwidth300 maxwidth500 widthcentpercentminusx', 'cssview'=>'wordbreak', 'csslist'=>'tdoverflowmax200' 'help' is a 'TranslationString' to use to show a tooltip on field. You can also use 'TranslationString:keyfortooltiponlick' for a tooltip on click. 'showoncombobox' if value of the field must be visible into the label of the combobox that list record 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute. In most cases, this is never set into the definition of $fields into class, but is set dynamically by some part of code. 'arrayofkeyval' to set a list of values if type is a list of predefined values. For example: array("0"=>"Draft","1"=>"Active","-1"=>"Cancel"). Note that type can be 'integer' or 'varchar' 'autofocusoncreate' to have field having the focus on a create form. Only 1 field should have this property set to 1. 'comment' is not used. You can store here any text of your choice. It is not used by application. 'validate' is 1 if need to validate with $this->validateField() 'copytoclipboard' is 1 or 2 to allow to add a picto to copy value into clipboard (1=picto after label, 2=picto after value)

Note: To have value dynamic, you can set value to 0 in definition and edit the value on the fly into the constructor.

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


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