dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | List of all members
FactureRec Class Reference

Class to manage invoice templates. More...

+ Inheritance diagram for FactureRec:
+ Collaboration diagram for FactureRec:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user, $facid)
 Create a predefined invoice. More...
 
 fetch ($rowid, $ref='', $ref_ext='', $ref_int='')
 Load object and lines. More...
 
 getLinesArray ()
 Create an array of invoice lines. More...
 
 fetch_lines ()
 Recupere les lignes de factures predefinies dans 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='', $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $label='', $fk_unit=null, $pu_ht_devise=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='', $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $label='', $fk_unit=null, $pu_ht_devise=0, $notrigger=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 ()
 Create all recurrents invoices (for all entities if multicompany is used). More...
 
 getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip='', $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...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 setFrequencyAndUnit ($frequency, $unit)
 Update frequency and unit. More...
 
 setNextDate ($date, $increment_nb_gen_done=0)
 Update the next date of execution. More...
 
 setMaxPeriod ($nb)
 Update the maximum period. More...
 
 setAutoValidate ($validate)
 Update the auto validate invoice. More...
 
 setGeneratePdf ($validate)
 Update the auto generate documents. More...
 
 setModelPdf ($model)
 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 and deposits invoices used by invoice. More...
 
 getListIdAvoirFromInvoice ()
 Renvoie tableau des ids de facture avoir issus de la facture. More...
 
 getIdReplacingInvoice ($option='')
 Renvoie l'id de la facture qui la remplace. More...
 
 is_erasable ()
 Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes 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) More...
 
 getVentilExportCompta ()
 Return if an invoice was dispatched into bookkeeping. More...
 
 getLibType ()
 Return label of type of invoice. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Return label of object status. More...
 
 LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=0)
 Return label of a status. More...
 
 calculate_date_lim_reglement ($cond_reglement=0)
 Renvoi une date limite de reglement de facture en fonction des conditions de reglements de la facture et date de facturation. 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="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=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 ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. 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)
 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)
 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)
 Fetch array of objects linked to current object. 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='')
 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...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) 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'st 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. 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)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=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='')
 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...
 
 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)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 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...
 

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

Additional Inherited Members

- 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.
 
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
 $projet
 
 $note
 
- 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...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage invoice templates.

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

Constructor & Destructor Documentation

FactureRec::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

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 = '',
  $pu_ttc = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $label = '',
  $fk_unit = null,
  $pu_ht_devise = 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_productId du produit/service predefini
double$remise_percentPourcentage de remise de la ligne
string$price_base_typeHT or TTC
int$info_bitsBits de type de lignes
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
Returns
int <0 if KO, Id of line if OK

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

References calcul_price_total(), dol_syslog(), getLocalTaxesFromRate(), price2num(), and CommonObject\update_price().

Referenced by create().

FactureRec::create (   $user,
  $facid 
)

Create a predefined invoice.

Parameters
User$userUser object
int$facidId of source invoice
Returns
int <0 if KO, id of invoice created if OK

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

References CommonObject\add_object_linked(), addline(), and dol_now().

FactureRec::createRecurringInvoices ( )

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

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

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

Returns
int 0 if OK, < 0 if KO (this function is used also by cron so only 0 is OK)

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

References $resql, dol_getdate(), dol_mktime(), dol_now(), dol_print_error(), and dol_syslog().

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

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

References CommonObject\deleteObjectLinked(), and dol_syslog().

FactureRec::fetch (   $rowid,
  $ref = '',
  $ref_ext = '',
  $ref_int = '' 
)

Load object and lines.

Parameters
int$rowidId of object to load
string$refReference of recurring invoice
string$ref_extExternal reference of invoice
int$ref_intInternal reference of other object
Returns
int >0 if OK, <0 if KO, 0 if not found

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

References dol_syslog(), fetch_lines(), CommonObject\fetch_optionals(), getEntity(), and type.

FactureRec::fetch_lines ( )

Recupere les lignes de factures predefinies dans this->lines.

Returns
int 1 if OK, < 0 if KO

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

References dol_syslog().

Referenced by fetch(), and getLinesArray().

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

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

References LibStatut(), and type.

FactureRec::getLinesArray ( )

Create an array of invoice lines.

Returns
int >0 if OK, <0 if KO

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

References fetch_lines().

FactureRec::getNextDate ( )

Return the next date of.

Returns
timestamp false if KO, timestamp if OK

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

References dol_time_plus_duree().

FactureRec::getNomUrl (   $withpicto = 0,
  $option = '',
  $max = 0,
  $short = 0,
  $moretitle = '',
  $notooltip = '',
  $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 1076 of file facture-rec.class.php.

References dol_escape_htmltag(), and img_object().

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
void

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

References $resql, CommonInvoice\calculate_date_lim_reglement(), dol_getdate(), dol_mktime(), and dol_now().

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 928 of file facture-rec.class.php.

Referenced by strikeIfMaxNbGenReached().

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

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

References img_picto().

Referenced by getLibStatut().

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

References CommonObject\commonReplaceThirdparty().

FactureRec::setAutoValidate (   $validate)

Update the auto validate invoice.

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

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

References dol_print_error(), and dol_syslog().

FactureRec::setFrequencyAndUnit (   $frequency,
  $unit 
)

Update frequency and unit.

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

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

References dol_print_error(), and dol_syslog().

FactureRec::setGeneratePdf (   $validate)

Update the auto generate documents.

Parameters
int$validate0 no document, 1 to generate document
Returns
int <0 if KO, >0 if OK

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

References dol_print_error(), and dol_syslog().

FactureRec::setMaxPeriod (   $nb)

Update the maximum period.

Parameters
int$nbnumber of maximum period
Returns
int <0 if KO, >0 if OK

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

References dol_print_error(), and dol_syslog().

FactureRec::setModelPdf (   $model)

Update the model for documents.

Parameters
string$modelmodel of document generator
Returns
int <0 if KO, >0 if OK

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

References dol_print_error(), and dol_syslog().

FactureRec::setNextDate (   $date,
  $increment_nb_gen_done = 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
Returns
int <0 if KO, >0 if OK

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

References dol_print_error(), and dol_syslog().

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
boolean False by default, True if maximum number of generation is reached

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

References isMaxNbGenReached().

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 = '',
  $pu_ttc = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $label = '',
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 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_productId du produit/service predefini
double$remise_percentPourcentage de remise de la ligne
string$price_base_typeHT or TTC
int$info_bitsBits de type de lignes
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
Returns
int <0 if KO, Id of line if OK

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

References calcul_price_total(), dol_syslog(), getLocalTaxesFromRate(), price2num(), and CommonObject\update_price().


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