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

Class to manage invoice templates. More...

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

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 create ($user, $facid, $notrigger=0, $onlylines=array())
 Create a predefined invoice. More...
 
 update (User $user, $notrigger=0)
 Update a line invoice_rec. More...
 
 fetch ($rowid, $ref='', $ref_ext='', $noextrafields=0, $nolines=0)
 Load object and lines. More...
 
 getLinesArray ()
 Create an array of invoice lines. More...
 
 fetch_lines ()
 Get lines of template invoices into this->lines. More...
 
 delete (User $user, $notrigger=0, $idwarehouse=-1)
 Delete template invoice. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $price_base_type='HT', $info_bits=0, $fk_remise_except=0, $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $label='', $fk_unit=null, $pu_ht_devise=0, $date_start_fill=0, $date_end_fill=0, $fk_fournprice=null, $pa_ht=0, $fk_parent_line=0)
 Add a line to invoice. More...
 
 updateline ($rowid, $desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $price_base_type='HT', $info_bits=0, $fk_remise_except=0, $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $label='', $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $date_start_fill=0, $date_end_fill=0, $fk_fournprice=null, $pa_ht=0, $fk_parent_line=0)
 Update a line to invoice. More...
 
 getNextDate ()
 Return the next date of. More...
 
 isMaxNbGenReached ()
 Return if maximum number of generation is reached. More...
 
 strikeIfMaxNbGenReached ($ret)
 Format string to output with by striking the string if max number of generation was reached. More...
 
 createRecurringInvoices ($restrictioninvoiceid=0, $forcevalidation=0, $notrigger=0)
 Create all recurrents invoices (for all entities if multicompany is used). More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($recur, $status, $mode=0, $alreadypaid=-1, $type=0)
 Return label of a status. More...
 
 getNextNumRef ($soc, $mode='next')
 Return next reference of invoice not already used (or last reference) More...
 
 info ($id)
 Load miscellaneous information for tab "Info". More...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 setFrequencyAndUnit ($frequency, $unit, $notrigger=0)
 Update frequency and unit. More...
 
 setNextDate ($date, $increment_nb_gen_done=0, $notrigger=0)
 Update the next date of execution. More...
 
 setMaxPeriod ($nb, $notrigger=0)
 Update the maximum period. More...
 
 setAutoValidate ($validate, $notrigger=0)
 Update the auto validate flag of invoice. More...
 
 setGeneratePdf ($validate, $notrigger=0)
 Update the auto generate documents. More...
 
 setModelPdf ($model, $notrigger=0)
 Update the model for documents. More...
 
- Public Member Functions inherited from CommonInvoice
 getRemainToPay ($multicurrency=0)
 Return remain amount to pay. More...
 
 getSommePaiement ($multicurrency=0)
 Return amount of payments already done. More...
 
 getSumDepositsUsed ($multicurrency=0)
 Return amount (with tax) of all deposits invoices used by invoice. More...
 
 getSumCreditNotesUsed ($multicurrency=0)
 Return amount (with tax) of all credit notes invoices + excess received used by invoice. More...
 
 getSumFromThisCreditNotesNotUsed ($multicurrency=0)
 Return amount (with tax) of all converted amount for this credit note. More...
 
 getListIdAvoirFromInvoice ()
 Returns array of credit note ids from the invoice. More...
 
 getIdReplacingInvoice ($option='')
 Returns the id of the invoice that replaces it. More...
 
 getListOfPayments ($filtertype='', $multicurrency=0)
 Return list of payments. More...
 
 is_erasable ()
 Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes (1) If hidden option INVOICE_CAN_NEVER_BE_REMOVED is on -> no (0) If invoice is dispatched in bookkeeping -> no (-1) If invoice has a definitive ref, is not last and INVOICE_CAN_ALWAYS_BE_REMOVED off -> no (-2) If invoice not last in a cycle -> no (-3) If there is payment -> no (-4) Otherwise -> yes (2) More...
 
 getVentilExportCompta ()
 Return if an invoice was dispatched into bookkeeping. More...
 
 getLibType ($withbadge=0)
 Return label of type of invoice. More...
 
 getSubtypeLabel ($table='')
 Return label of invoice subtype. More...
 
 getArrayOfInvoiceSubtypes ($mode=0)
 Retrieve a list of invoice subtype labels or codes. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Returns an invoice payment deadline based on the invoice settlement conditions and billing date. More...
 
 demande_prelevement ($fuser, $amount=0, $type='direct-debit', $sourcetype='facture', $checkduplicateamongall=0)
 Create a withdrawal request for a direct debit order or a credit transfer order. More...
 
 makeStripeCardRequest ($fuser, $id, $sourcetype='facture')
 Create a payment with Stripe card Must take amount using Stripe and record an event into llx_actioncomm Record bank payment Send email to customer ? More...
 
 makeStripeSepaRequest ($fuser, $did, $type='direct-debit', $sourcetype='facture', $service='', $forcestripe='')
 Create a direct debit order into prelevement_bons for a given prelevement_request, then Send the payment order to the service (for a direct debit order or a credit transfer order) and record an event in llx_actioncomm. More...
 
 demande_prelevement_delete ($fuser, $did)
 Remove a direct debit request or a credit transfer request. More...
 
 buildEPCQrCodeString ()
 Build string for EPC QR Code. More...
 
 buildZATCAQRString ()
 Build string for ZATCA QR Code (Arabi Saudia) More...
 
 buildSwitzerlandQRString ()
 Build string for QR-Bill (Switzerland) More...
 
- Public Member Functions inherited from CommonObject
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty More...
 
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContentArray ($params)
 Return array of data to show into a tooltip. 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...
 
 getExtraField ($key)
 Convenience method for retrieving the value of an extrafield without actually fetching it from the database. More...
 
 setExtraField ($key, $value)
 Convenience method for setting the value of an extrafield without actually updating it in the database. 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')
 
 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...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 Function used to get the logos or photos of an object. 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 in the 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

 $total
 
 $tva
 
- Public Attributes inherited from CommonInvoice
const TYPE_STANDARD = 0
 Standard invoice.
 
const TYPE_REPLACEMENT = 1
 Replacement invoice.
 
const TYPE_CREDIT_NOTE = 2
 Credit note invoice.
 
const TYPE_DEPOSIT = 3
 Deposit invoice.
 
const TYPE_PROFORMA = 4
 Proforma invoice. More...
 
const TYPE_SITUATION = 5
 Situation invoice.
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated (need to be paid)
 
const STATUS_CLOSED = 2
 Classified paid. More...
 
const STATUS_ABANDONED = 3
 Classified abandoned and no payment done. More...
 
- Public Attributes inherited from CommonObject
 $origin_object
 

Protected Attributes

 $table_ref_field = 'titre'
 {}
 

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 invoice templates.

Definition at line 43 of file facture-rec.class.php.

Constructor & Destructor Documentation

◆ __construct()

FactureRec::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 235 of file facture-rec.class.php.

Member Function Documentation

◆ addline()

FactureRec::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $fk_product = 0,
  $remise_percent = 0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $fk_remise_except = 0,
  $pu_ttc = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $label = '',
  $fk_unit = null,
  $pu_ht_devise = 0,
  $date_start_fill = 0,
  $date_end_fill = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $fk_parent_line = 0 
)

Add a line to invoice.

Parameters
string$descDescription de la ligne
double$pu_htPrix unitaire HT (> 0 even for credit note)
double$qtyQuantite
double$txtvaTaux de tva force, sinon -1
double$txlocaltax1Local tax 1 rate (deprecated)
double$txlocaltax2Local tax 2 rate (deprecated)
int$fk_productProduct/Service ID predefined
double$remise_percentPercentage discount of the line
string$price_base_typeHT or TTC
int$info_bitsVAT npr or not ?
int$fk_remise_exceptId remise
double$pu_ttcPrix unitaire TTC (> 0 even for credit note)
int$typeType of line (0=product, 1=service)
int$rangPosition of line
int$special_codeSpecial code
string$labelLabel of the line
string$fk_unitUnit
double$pu_ht_deviseUnit price in currency
int$date_start_fill1=Flag to fill start date when generating invoice
int$date_end_fill1=Flag to fill end date when generating invoice
int$fk_fournpriceSupplier price id (to calculate margin) or ''
int$pa_htBuying price of line (to calculate margin) or ''
int$fk_parent_lineId of parent line
Returns
int Return integer <0 if KO, Id of line if OK

Definition at line 883 of file facture-rec.class.php.

◆ create()

FactureRec::create (   $user,
  $facid,
  $notrigger = 0,
  $onlylines = array() 
)

Create a predefined invoice.

Parameters
User$userUser object
int$facidId of source invoice
int$notriggerNo trigger
array$onlylinesOnly the lines of the array
Returns
int Return integer <0 if KO, id of invoice created if OK

Definition at line 249 of file facture-rec.class.php.

◆ createRecurringInvoices()

FactureRec::createRecurringInvoices (   $restrictioninvoiceid = 0,
  $forcevalidation = 0,
  $notrigger = 0 
)

Create all recurrents invoices (for all entities if multicompany is used).

A result may also be provided into this->output.

WARNING: This method change temporarily context $conf->entity to be in correct context for each recurring invoice found.

Parameters
int$restrictioninvoiceid0=All qualified template invoices found. > 0 = restrict action on invoice ID
int$forcevalidation1=Force validation of invoice whatever is template auto_validate flag.
int$notriggerDisable the trigger
Returns
int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)

Definition at line 1288 of file facture-rec.class.php.

◆ delete()

FactureRec::delete ( User  $user,
  $notrigger = 0,
  $idwarehouse = -1 
)

Delete template invoice.

Parameters
User$userUser that delete.
int$notrigger1=Does not execute triggers, 0= execute triggers
int$idwarehouseId warehouse to use for stock change.
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 800 of file facture-rec.class.php.

◆ fetch()

FactureRec::fetch (   $rowid,
  $ref = '',
  $ref_ext = '',
  $noextrafields = 0,
  $nolines = 0 
)

Load object and lines.

Parameters
int$rowidId of object to load
string$refReference of recurring invoice
string$ref_extExternal reference of invoice
int$noextrafields0=Default to load extrafields, 1=No extrafields
int$nolines0=Default to load lines, 1=No lines
Returns
int >0 if OK, <0 if KO, 0 if not found

Definition at line 556 of file facture-rec.class.php.

◆ fetch_lines()

FactureRec::fetch_lines ( )

Get lines of template invoices into this->lines.

Returns
int 1 if OK, < 0 if KO

Definition at line 688 of file facture-rec.class.php.

References $sql, and dol_syslog().

Referenced by getLinesArray().

◆ getLibStatut()

FactureRec::getLibStatut (   $mode = 0,
  $alreadypaid = -1 
)

Return label of object status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto
integer$alreadypaidNot used on recurring invoices
Returns
string Label of status

Reimplemented from CommonInvoice.

Definition at line 1519 of file facture-rec.class.php.

◆ getLinesArray()

FactureRec::getLinesArray ( )

Create an array of invoice lines.

Returns
int >0 if OK, <0 if KO

Definition at line 676 of file facture-rec.class.php.

References fetch_lines().

◆ getNextDate()

FactureRec::getNextDate ( )

Return the next date of.

Returns
int|false false if KO, timestamp if OK

Definition at line 1244 of file facture-rec.class.php.

References dol_time_plus_duree().

◆ getNextNumRef()

FactureRec::getNextNumRef (   $soc,
  $mode = 'next' 
)

Return next reference of invoice not already used (or last reference)

Parameters
Societe$socThirdparty object
string$mode'next' for next value or 'last' for last value
Returns
string free ref or last ref

Reimplemented from CommonInvoice.

Definition at line 1666 of file facture-rec.class.php.

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link
int$maxMaxlength of ref
int$short1=Return just URL
string$moretitleAdd more text to title tooltip
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 1446 of file facture-rec.class.php.

◆ info()

FactureRec::info (   $id)

Load miscellaneous information for tab "Info".

Parameters
int$idId of object to load
Returns
void

Definition at line 1678 of file facture-rec.class.php.

References $sql.

◆ initAsSpecimen()

FactureRec::initAsSpecimen (   $option = '')

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Parameters
string$option''=Create a specimen invoice with lines, 'nolines'=No lines
Returns
int

Definition at line 1711 of file facture-rec.class.php.

◆ isMaxNbGenReached()

FactureRec::isMaxNbGenReached ( )

Return if maximum number of generation is reached.

Returns
boolean False by default, True if maximum number of generation is reached

Definition at line 1257 of file facture-rec.class.php.

◆ LibStatut()

FactureRec::LibStatut (   $recur,
  $status,
  $mode = 0,
  $alreadypaid = -1,
  $type = 0 
)

Return label of a status.

Parameters
int$recurIs it a recurring invoice ?
int$statusId status (suspended or not)
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
integer$alreadypaidNot used for recurring invoices
int$typeType invoice
Returns
string Label of status

Reimplemented from CommonInvoice.

Definition at line 1535 of file facture-rec.class.php.

◆ replaceProduct()

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

Function used to replace a product 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 product id
int$dest_idNew product id
Returns
bool

Definition at line 1858 of file facture-rec.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

static FactureRec::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 1841 of file facture-rec.class.php.

References CommonObject\commonReplaceThirdparty().

◆ setAutoValidate()

FactureRec::setAutoValidate (   $validate,
  $notrigger = 0 
)

Update the auto validate flag of invoice.

Parameters
int$validate0 to create in draft, 1 to create and validate invoice
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2015 of file facture-rec.class.php.

References $sql, and dol_syslog().

◆ setFrequencyAndUnit()

FactureRec::setFrequencyAndUnit (   $frequency,
  $unit,
  $notrigger = 0 
)

Update frequency and unit.

Parameters
int$frequencyvalue of frequency
string$unitunit of frequency (d, m, y)
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1875 of file facture-rec.class.php.

References $sql, and dol_syslog().

◆ setGeneratePdf()

FactureRec::setGeneratePdf (   $validate,
  $notrigger = 0 
)

Update the auto generate documents.

Parameters
int$validate0 no document, 1 to generate document
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2055 of file facture-rec.class.php.

References $sql, and dol_syslog().

◆ setMaxPeriod()

FactureRec::setMaxPeriod (   $nb,
  $notrigger = 0 
)

Update the maximum period.

Parameters
int$nbnumber of maximum period
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1971 of file facture-rec.class.php.

References $sql, and dol_syslog().

◆ setModelPdf()

FactureRec::setModelPdf (   $model,
  $notrigger = 0 
)

Update the model for documents.

Parameters
string$modelmodel of document generator
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2095 of file facture-rec.class.php.

◆ setNextDate()

FactureRec::setNextDate (   $date,
  $increment_nb_gen_done = 0,
  $notrigger = 0 
)

Update the next date of execution.

Parameters
datetime$datedate of execution
int$increment_nb_gen_done0 do nothing more, >0 increment nb_gen_done
int$notriggerDisable the trigger
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1927 of file facture-rec.class.php.

References $sql, and dol_syslog().

◆ strikeIfMaxNbGenReached()

FactureRec::strikeIfMaxNbGenReached (   $ret)

Format string to output with by striking the string if max number of generation was reached.

Parameters
string$retDefault value to output
Returns
string html formatted string

Definition at line 1272 of file facture-rec.class.php.

◆ update()

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

Update a line invoice_rec.

Parameters
User$userUser
int$notriggerNo trigger
Returns
int Return integer <0 if KO, Id of line if OK

Definition at line 498 of file facture-rec.class.php.

References $sql.

◆ updateline()

FactureRec::updateline (   $rowid,
  $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $fk_product = 0,
  $remise_percent = 0,
  $price_base_type = 'HT',
  $info_bits = 0,
  $fk_remise_except = 0,
  $pu_ttc = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $label = '',
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 0,
  $date_start_fill = 0,
  $date_end_fill = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $fk_parent_line = 0 
)

Update a line to invoice.

Parameters
int$rowidId of line to update
string$descDescription de la ligne
double$pu_htPrix unitaire HT (> 0 even for credit note)
double$qtyQuantite
double$txtvaTaux de tva force, sinon -1
double$txlocaltax1Local tax 1 rate (deprecated)
double$txlocaltax2Local tax 2 rate (deprecated)
int$fk_productProduct/Service ID predefined
double$remise_percentPercentage discount of the line
string$price_base_typeHT or TTC
int$info_bitsBits of type of lines
int$fk_remise_exceptId remise
double$pu_ttcPrix unitaire TTC (> 0 even for credit note)
int$typeType of line (0=product, 1=service)
int$rangPosition of line
int$special_codeSpecial code
string$labelLabel of the line
string$fk_unitUnit
double$pu_ht_deviseUnit price in currency
int$notriggerdisable line update trigger
int$date_start_fill1=Flag to fill start date when generating invoice
int$date_end_fill1=Flag to fill end date when generating invoice
int$fk_fournpriceId of origin supplier price
int$pa_htPrice (without tax) of product for margin calculation
int$fk_parent_lineId of parent line
Returns
int Return integer <0 if KO, Id of line if OK

Definition at line 1090 of file facture-rec.class.php.

Member Data Documentation

◆ $total

FactureRec::$total
Deprecated:
See also
$total_ht

Definition at line 107 of file facture-rec.class.php.

◆ $tva

FactureRec::$tva
Deprecated:
See also
$total_tva

Definition at line 113 of file facture-rec.class.php.


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