dolibarr 18.0.6
|
Classe de gestion des factures recurrentes/Modeles. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
getLibStatut ($mode=0) | |
Returns the label status. | |
create ($user, $notrigger=0) | |
Create a predefined fichinter. | |
fetch ($rowid=0, $ref='', $ref_ext='') | |
Get the template of intervention object and lines. | |
fetch_lines ($sall=0) | |
Load all lines of template of intervention into this->lines. | |
delete (User $user, $notrigger=0) | |
Delete template fichinter rec. | |
addline ($desc, $duration, $date, $rang=-1, $pu_ht=0, $qty=0, $txtva=0, $fk_product=0, $remise_percent=0, $price_base_type='HT', $info_bits=0, $fk_remise_except='', $pu_ttc=0, $type=0, $special_code=0, $label='', $fk_unit=null) | |
Add a line to fichinter rec. | |
set_auto ($user, $freq, $courant) | |
Rend la fichinter automatique. | |
getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='') | |
Return clicable name (with picto eventually) | |
initAsSpecimen () | |
Initialise an instance with random values. | |
setFrequencyAndUnit ($frequency, $unit) | |
Update frequency and unit. | |
setNextDate ($date, $increment_nb_gen_done=0) | |
Update the next date of execution. | |
setMaxPeriod ($nb) | |
Update the maximum period. | |
setAutoValidate ($validate) | |
Update the auto validate fichinter. | |
updateNbGenDone () | |
Update the Number of Generation Done. | |
Public Member Functions inherited from Fichinter | |
load_state_board () | |
Load indicators into this->nb for board. | |
update ($user, $notrigger=0) | |
Update an intervention. | |
fetch ($rowid, $ref='') | |
Fetch a intervention. | |
setDraft ($user) | |
Set status to draft. | |
setValid ($user, $notrigger=0) | |
Validate a intervention. | |
getAmount () | |
Returns amount based on user thm. | |
generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null) | |
Create a document onto disk according to template module. | |
LibStatut ($status, $mode=0) | |
Returns the label of a status. | |
getTooltipContentArray ($params) | |
getTooltipContentArray | |
getNextNumRef ($soc) | |
Returns the next non used reference of intervention depending on the module numbering assets within FICHEINTER_ADDON. | |
info ($id) | |
Load information on object. | |
set_date_delivery ($user, $date_delivery) | |
Defines a delivery date of intervention. | |
set_description ($user, $description) | |
Define the label of the intervention. | |
set_contrat ($user, $contractid) | |
Link intervention to a contract. | |
createFromClone (User $user, $socid=0) | |
Load an object from its id and create a new one in database. | |
addline ($user, $fichinterid, $desc, $date_intervention, $duration, $array_options='') | |
Adding a line of intervention into data base. | |
fetch_lines () | |
Load array lines ->lines. | |
setRefClient ($user, $ref_client, $notrigger=0) | |
Set customer reference number. | |
getKanbanView ($option='', $arraydata=null) | |
Return clicable link of object (with eventually picto) | |
Public Member Functions inherited from CommonObject | |
setErrorsFromObject ($object) | |
setErrorsFromObject | |
getTooltipContent ($params) | |
getTooltipContent | |
errorsToString () | |
Method to output saved errors. | |
getFormatedCustomerRef ($objref) | |
Return customer ref for screen output. | |
getFormatedSupplierRef ($objref) | |
Return supplier ref for screen output. | |
getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='') | |
Return full address of contact. | |
getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0) | |
Return the link of last main doc file for direct public download. | |
add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0) | |
Add a link between element $this->element and a contact. | |
copy_linked_contact ($objFrom, $source='internal') | |
Copy contact from one element to current. | |
update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0) | |
Update a link to contact line. | |
delete_contact ($rowid, $notrigger=0) | |
Delete a link to contact line. | |
delete_linked_contact ($source='', $code='') | |
Delete all links between an object $this and all its contacts in llx_element_contact. | |
liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array()) | |
Get array of all contacts for an object. | |
swapContactStatus ($rowid) | |
Update status of a contact linked to object. | |
liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='') | |
Return array with list of possible values for type of contacts. | |
listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='') | |
Return array with list of possible values for type of contacts. | |
getIdContact ($source, $code, $status=0) | |
Return id of contacts for a source and a contact code. | |
fetch_contact ($contactid=null) | |
Load object contact with id=$this->contact_id into $this->contact. | |
fetch_thirdparty ($force_thirdparty_id=0) | |
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. | |
fetchOneLike ($ref) | |
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. | |
fetch_barcode () | |
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. | |
fetch_project () | |
Load the project with id $this->fk_project into this->project. | |
fetch_projet () | |
Load the project with id $this->fk_project into this->project. | |
fetch_product () | |
Load the product with id $this->fk_product into this->product. | |
fetch_user ($userid) | |
Load the user with id $userid into this->user. | |
fetch_origin () | |
Read linked origin object. | |
fetchObjectFrom ($table, $field, $key, $element=null) | |
Load object from specific field. | |
getValueFrom ($table, $id, $field) | |
Getter generic. | |
setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif') | |
Setter generic. | |
load_previous_next_ref ($filter, $fieldid, $nodbprefix=0) | |
Load properties id_previous and id_next by comparing $fieldid with $this->ref. | |
getListContactId ($source='external') | |
Return list of id of contacts of object. | |
setProject ($projectid, $notrigger=0) | |
Link element with a project. | |
setPaymentMethods ($id) | |
Change the payments methods. | |
setMulticurrencyCode ($code) | |
Change the multicurrency code. | |
setPaymentTerms ($id, $deposit_percent=null) | |
Change the payments terms. | |
setTransportMode ($id) | |
Change the transport mode methods. | |
setRetainedWarrantyPaymentTerms ($id) | |
Change the retained warranty payments terms. | |
setDeliveryAddress ($id) | |
Define delivery address. | |
setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null) | |
Change the shipping method. | |
setWarehouse ($warehouse_id) | |
Change the warehouse. | |
setDocModel ($user, $modelpdf) | |
Set last model used by doc generator. | |
setBankAccount ($fk_account, $notrigger=false, $userused=null) | |
Change the bank account. | |
line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true) | |
Save a new position (field rang) for details lines. | |
getChildrenOfLine ($id, $includealltree=0) | |
Get children of line. | |
line_up ($rowid, $fk_parent_line=true) | |
Update a line to have a lower rank. | |
line_down ($rowid, $fk_parent_line=true) | |
Update a line to have a higher rank. | |
updateRangOfLine ($rowid, $rang) | |
Update position of line (rang) | |
line_ajaxorder ($rows) | |
Update position of line with ajax (rang) | |
updateLineUp ($rowid, $rang) | |
Update position of line up (rang) | |
updateLineDown ($rowid, $rang, $max) | |
Update position of line down (rang) | |
getRangOfLine ($rowid) | |
Get position of line (rang) | |
getIdOfLine ($rang) | |
Get rowid of the line relative to its position. | |
line_max ($fk_parent_line=0) | |
Get max value used for position of line (rang) | |
update_ref_ext ($ref_ext) | |
Update external ref of element. | |
update_note ($note, $suffix='', $notrigger=0) | |
Update note of element. | |
update_note_public ($note) | |
Update public note (kept for backward compatibility) | |
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). | |
add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0) | |
Add an object link into llx_element_element. | |
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). | |
clearObjectLinkedCache () | |
Clear the cache saying that all linked object were already loaded. | |
updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0) | |
Update object linked of a current object. | |
deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='', $f_user=null, $notrigger=0) | |
Delete all links between an object $this. | |
setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut') | |
Set status of an object. | |
getCanvas ($id=0, $ref='') | |
Load type of canvas of an object if it exists. | |
getSpecialCode ($lineid) | |
Get special code of a line. | |
isObjectUsed ($id=0, $entity=0) | |
Function to check if an object is used by others (by children). | |
hasProductsOrServices ($predefined=-1) | |
Function to say how many lines object contains. | |
getTotalDiscount () | |
Function that returns the total amount HT of discounts applied for all lines. | |
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. | |
setExtraParameters () | |
Set extra parameters. | |
formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl') | |
Show add free and predefined products/services form. | |
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. | |
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) | |
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). | |
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). | |
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. | |
delete_resource ($rowid, $element, $notrigger=0) | |
Delete a link to resource line. | |
__clone () | |
Overwrite magic function to solve problem of cloning object that are kept as references. | |
indexFile ($destfull, $update_main_doc_field) | |
Index a file into the ECM database. | |
addThumbs ($file) | |
Build thumb. | |
delThumbs ($file) | |
Delete thumbs. | |
getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml') | |
Return the default value to use for a field when showing the create form of object. | |
call_trigger ($triggerName, $user) | |
Call trigger based on this instance. | |
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. | |
setValuesForExtraLanguages ($onlykey='') | |
Fill array_options property of object by extrafields value (using for data sent by forms) | |
fetchNoCompute ($id) | |
Function to make a fetch but set environment to avoid to load computed values before. | |
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. | |
deleteExtraFields () | |
Delete all extra fields values for the current object. | |
insertExtraFields ($trigger='', $userused=null) | |
Add/Update all extra fields values for the current object. | |
insertExtraLanguages ($trigger='', $userused=null) | |
Add/Update all extra fields values for the current object. | |
updateExtraField ($key, $trigger=null, $userused=null) | |
Update 1 extra field value for the current object. | |
updateExtraLanguages ($key, $trigger=null, $userused=null) | |
Update an extra language value for the current object. | |
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. | |
clearFieldError ($fieldKey) | |
clear validation message result for a field | |
setFieldError ($fieldKey, $msg='') | |
set validation error message a field | |
getFieldError ($fieldKey) | |
get field error message | |
validateField ($fields, $fieldKey, $fieldValue) | |
Return validation test result for a field. | |
showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0, $display_type='card') | |
Function to show lines of extrafields with output datas. | |
getJSListDependancies ($type='_extra') | |
getRights () | |
Returns the rights used for this class. | |
defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0) | |
Get buy price to use for margin calculation. | |
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. | |
isDate ($info) | |
Function test if type is date. | |
isDuration ($info) | |
Function test if type is duration. | |
isInt ($info) | |
Function test if type is integer. | |
isFloat ($info) | |
Function test if type is float. | |
isText ($info) | |
Function test if type is text. | |
setVarsFromFetchObj (&$obj) | |
Function to load data from a SQL pointer into properties of current object $this. | |
getFieldList ($alias='', $excludefields=array()) | |
Function to concat keys of fields. | |
createCommon (User $user, $notrigger=false) | |
Create object into database. | |
fetchCommon ($id, $ref=null, $morewhere='') | |
Load object in memory from the database. | |
fetchLinesCommon ($morewhere='') | |
Load object in memory from the database. | |
updateCommon (User $user, $notrigger=false) | |
Update object into database. | |
deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0) | |
Delete object in database. | |
deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND") | |
Delete all child object from a parent ID. | |
deleteLineCommon (User $user, $idline, $notrigger=false) | |
Delete a line of object in database. | |
setStatusCommon ($user, $status, $notrigger=0, $triggercode='') | |
Set to a status. | |
initAsSpecimenCommon () | |
Initialise object with example values Id must be 0 if object instance is a specimen. | |
fetchComments () | |
Load comments linked with current task. | |
getNbComments () | |
Return nb comments already posted. | |
trimParameters ($parameters) | |
Trim object parameters. | |
getCategoriesCommon ($type_categ) | |
Sets object to given categories. | |
setCategoriesCommon ($categories, $type_categ='', $remove_existing=true) | |
Sets object to given categories. | |
cloneCategories ($fromId, $toId, $type='') | |
Copy related categories to another object. | |
deleteEcmFiles ($mode=0) | |
Delete related files of object in database. | |
Static Public Member Functions | |
static | replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id) |
Function used to replace a thirdparty id with another one. | |
static | replaceProduct (DoliDB $db, $origin_id, $dest_id) |
Function used to replace a product id with another one. | |
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. | |
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. | |
static | deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element) |
Function used to remove all items linked to an object id in association table. | |
static | commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
Function used to replace a thirdparty id with another one. | |
static | commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0) |
Function used to replace a product id with another one. | |
Public Attributes | |
$rang | |
int rank | |
Public Attributes inherited from Fichinter | |
const | STATUS_DRAFT = 0 |
Draft status. | |
const | STATUS_VALIDATED = 1 |
Validated status. | |
const | STATUS_BILLED = 2 |
Billed. | |
const | STATUS_CLOSED = 3 |
Closed. | |
Public Attributes inherited from CommonObject | |
$fk_projet | |
$note | |
$date_modification | |
Protected Attributes | |
$table_ref_field = 'titre' | |
{} | |
Protected Attributes inherited from Fichinter | |
$table_ref_field = 'ref' | |
{} | |
Additional Inherited Members | |
Protected Member Functions inherited from CommonObject | |
commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null) | |
Common function for all objects extending CommonObject for generating documents. | |
isArray ($info) | |
Function test if type is array. | |
canBeNull ($info) | |
Function test if field can be null. | |
isForcedToNullIfZero ($info) | |
Function test if field is forced to null if zero or empty. | |
isIndex ($info) | |
Function test if is indexed. | |
setSaveQuery () | |
Function to return the array of data key-value from the ->fields and all the ->properties of an object. | |
quote ($value, $fieldsentry) | |
Add quote to field value if necessary. | |
Classe de gestion des factures recurrentes/Modeles.
Definition at line 39 of file fichinterrec.class.php.
FichinterRec::__construct | ( | $db | ) |
FichinterRec::addline | ( | $desc, | |
$duration, | |||
$date, | |||
$rang = -1, | |||
$pu_ht = 0, | |||
$qty = 0, | |||
$txtva = 0, | |||
$fk_product = 0, | |||
$remise_percent = 0, | |||
$price_base_type = 'HT', | |||
$info_bits = 0, | |||
$fk_remise_except = '', | |||
$pu_ttc = 0, | |||
$type = 0, | |||
$special_code = 0, | |||
$label = '', | |||
$fk_unit = null ) |
Add a line to fichinter rec.
string | $desc | Description de la ligne |
integer | $duration | Durée |
string | $date | Date |
int | $rang | Position of line |
double | $pu_ht | Unit price without tax (> 0 even for credit note) |
double | $qty | Quantity |
double | $txtva | Forced VAT rate, otherwise -1 |
int | $fk_product | Id of predefined product/service |
double | $remise_percent | Percentage of discount on line |
string | $price_base_type | HT or TTC |
int | $info_bits | Bits for type of lines |
int | $fk_remise_except | Id discount |
double | $pu_ttc | Unit price with tax (> 0 even for credit note) |
int | $type | Type of line (0=product, 1=service) |
int | $special_code | Special code |
string | $label | Label of the line |
string | $fk_unit | Unit |
Definition at line 474 of file fichinterrec.class.php.
References $rang, calcul_price_total(), dol_syslog(), and price2num().
Referenced by create().
FichinterRec::create | ( | $user, | |
$notrigger = 0 ) |
Create a predefined fichinter.
Reimplemented from Fichinter.
Definition at line 135 of file fichinterrec.class.php.
References addline(), description, and dol_now().
FichinterRec::delete | ( | User | $user, |
$notrigger = 0 ) |
Delete template fichinter rec.
User | $user | Object user who delete |
int | $notrigger | Disable trigger |
Reimplemented from Fichinter.
Definition at line 419 of file fichinterrec.class.php.
References dol_syslog().
FichinterRec::fetch | ( | $rowid = 0, | |
$ref = '', | |||
$ref_ext = '' ) |
Get the template of intervention object and lines.
int | $rowid | Id of object to load |
string | $ref | Reference of fichinter |
string | $ref_ext | External reference of fichinter |
Definition at line 273 of file fichinterrec.class.php.
References description, dol_syslog(), Fichinter\fetch_lines(), ref, and statut.
FichinterRec::fetch_lines | ( | $sall = 0 | ) |
Load all lines of template of intervention into this->lines.
int | $sall | sall |
Definition at line 348 of file fichinterrec.class.php.
References dol_syslog().
FichinterRec::getLibStatut | ( | $mode = 0 | ) |
Returns the label status.
int | $mode | 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto |
Reimplemented from Fichinter.
Definition at line 122 of file fichinterrec.class.php.
References Fichinter\LibStatut(), and statut.
FichinterRec::getNomUrl | ( | $withpicto = 0, | |
$option = '', | |||
$max = 0, | |||
$short = 0, | |||
$moretitle = '' ) |
Return clicable name (with picto eventually)
int | $withpicto | Add picto into link |
string | $option | Where point the link |
int | $max | Maxlength of ref |
int | $short | 1=Return just URL |
string | $moretitle | Add more text to title tooltip |
Reimplemented from Fichinter.
Definition at line 624 of file fichinterrec.class.php.
References dol_escape_htmltag().
FichinterRec::initAsSpecimen | ( | ) |
Initialise an instance with random values.
Used to build previews or test instances. id must be 0 if object instance is a specimen.
Reimplemented from Fichinter.
Definition at line 671 of file fichinterrec.class.php.
|
static |
Function used to replace a product id with another one.
Definition at line 705 of file fichinterrec.class.php.
References CommonObject\commonReplaceProduct().
|
static |
Function used to replace a thirdparty id with another one.
DoliDB | $dbs | Database handler, because function is static we name it $dbs not $db to avoid breaking coding test |
int | $origin_id | Old thirdparty id |
int | $dest_id | New thirdparty id |
Reimplemented from Fichinter.
Definition at line 690 of file fichinterrec.class.php.
References CommonObject\commonReplaceThirdparty().
FichinterRec::set_auto | ( | $user, | |
$freq, | |||
$courant ) |
Rend la fichinter automatique.
Definition at line 590 of file fichinterrec.class.php.
References dol_print_error().
FichinterRec::setAutoValidate | ( | $validate | ) |
Update the auto validate fichinter.
int | $validate | 0 to create in draft, 1 to create and validate fichinter |
Definition at line 823 of file fichinterrec.class.php.
References dol_print_error(), and dol_syslog().
FichinterRec::setFrequencyAndUnit | ( | $frequency, | |
$unit ) |
Update frequency and unit.
int | $frequency | value of frequency |
string | $unit | unit of frequency (d, m, y) |
Definition at line 721 of file fichinterrec.class.php.
References dol_print_error(), and dol_syslog().
FichinterRec::setMaxPeriod | ( | $nb | ) |
Update the maximum period.
int | $nb | number of maximum period |
Definition at line 792 of file fichinterrec.class.php.
References dol_print_error(), and dol_syslog().
FichinterRec::setNextDate | ( | $date, | |
$increment_nb_gen_done = 0 ) |
Update the next date of execution.
datetime | $date | date of execution |
int | $increment_nb_gen_done | 0 do nothing more, >0 increment nb_gen_done |
Definition at line 760 of file fichinterrec.class.php.
References dol_print_error(), and dol_syslog().
FichinterRec::updateNbGenDone | ( | ) |
Update the Number of Generation Done.
Definition at line 849 of file fichinterrec.class.php.
References dol_now(), dol_print_error(), and dol_syslog().