dolibarr  13.0.2
Public Member Functions | Public Attributes | List of all members
ExpenseReport Class Reference

Class to manage Trips and Expenses. More...

+ Inheritance diagram for ExpenseReport:
+ Collaboration diagram for ExpenseReport:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user, $notrigger=0)
 Create object in database. More...
 
 createFromClone (User $user, $fk_user_author)
 Load an object from its id and create a new one in database. More...
 
 update ($user, $notrigger=0, $userofexpensereport=null)
 update More...
 
ref}

Load an object from database

Parameters
int$idId { 1}
string$refRef {
Returns
int <0 if KO, >0 if OK
 fetch ($id, $ref= '')
 
 set_paid ($id, $fuser, $notrigger=0)
 Classify the expense report as paid. More...
 
 getLibStatut ($mode=0)
 Returns the label status. More...
 
 LibStatut ($status, $mode=0)
 Returns the label of a status. More...
 
 info ($id)
 Load information on object. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 fetch_line_by_project ($projectid, $user= '')
 fetch_line_by_project More...
 
 recalculer ($id)
 recalculer TODO Replace this with call to update_price if not already done More...
 
 fetch_lines ()
 fetch_lines More...
 
 delete (User $user=null, $notrigger=false)
 Delete object in database. More...
 
 setValidate ($fuser, $notrigger=0)
 Set to status validate. More...
 
 set_save_from_refuse ($fuser)
 set_save_from_refuse More...
 
 setApproved ($fuser, $notrigger=0)
 Set status to approved. More...
 
 setDeny ($fuser, $details, $notrigger=0)
 setDeny More...
 
 set_unpaid ($fuser, $notrigger=0)
 set_unpaid More...
 
 set_cancel ($fuser, $detail, $notrigger=0)
 set_cancel More...
 
 getNextNumRef ()
 Return next reference of expense report not already used. More...
 
 getNomUrl ($withpicto=0, $max=0, $short=0, $moretitle= '', $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 update_totaux_add ($ligne_total_ht, $ligne_total_tva)
 Update total of an expense report when you add a line. More...
 
 update_totaux_del ($ligne_total_ht, $ligne_total_tva)
 Update total of an expense report when you delete a line. More...
 
 addline ($qty=0, $up=0, $fk_c_type_fees=0, $vatrate=0, $date= '', $comments= '', $fk_project=0, $fk_c_exp_tax_cat=0, $type=0, $fk_ecm_files=0)
 addline More...
 
 checkRules ($type=0, $seller= '')
 Check constraint of rules and update price if needed. More...
 
 applyOffset ()
 Method to apply the offset if needed. More...
 
 offsetAlreadyGiven ()
 If the sql find any rows then the ikoffset is already given (ikoffset is applied at the first expense report line) More...
 
 updateline ($rowid, $type_fees_id, $projet_id, $vatrate, $comments, $qty, $value_unit, $date, $expensereport_id, $fk_c_exp_tax_cat=0, $fk_ecm_files=0)
 Update an expense report line. More...
 
 deleteline ($rowid, $fuser= '')
 deleteline More...
 
 periode_existe ($fuser, $date_debut, $date_fin)
 periode_existe More...
 
 fetch_users_approver_expensereport ()
 Return list of people with permission to validate expense reports. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk accordign to template module. More...
 
 listOfTypes ($active=1)
 List of types. More...
 
 load_state_board ()
 Charge indicateurs this->nb pour le tableau de bord. More...
 
 load_board ($user, $option= 'topay')
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 hasDelay ($option)
 Return if an expense report is late or not. More...
 
 getVentilExportCompta ()
 Return if object was dispatched into bookkeeping. More...
 
 getSumPayments ()
 Return amount of payments already done. More...
 
- Public Member Functions inherited from CommonObject
 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...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 setUpperOrLowerCase ()
 Set to upper or ucwords/lower if needed. More...
 
 getKanbanView ($option= '')
 Return clicable link of object (with eventually picto) More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode= '')
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source= 'external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source= 'internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source= '', $code= '')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($status=-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...
 
 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_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table= '', $id=null, $format= '', $id_field= '', $fuser=null, $trigkey= '', $fk_user_field= 'fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source= 'external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 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=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder= 'ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id, $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= '')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust= 'none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $clause= 'OR', $alsosametype=1, $orderby= 'sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $rowid= '')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType= '', $trigkey= '')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref= '')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 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...
 
 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 ($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...
 
 showOutputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss= '')
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode= 'view', $params=null, $keysuffix= '', $keyprefix= '', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 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...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 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...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere= '')
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere= '')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField= '')
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=false)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode= '')
 Set to a 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)
 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...
 

Public Attributes

const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 2
 Validated (need to be paid)
 
const STATUS_CANCELED = 4
 Classified canceled.
 
const STATUS_APPROVED = 5
 Classified approved.
 
const STATUS_REFUSED = 99
 Classified refused.
 
const STATUS_CLOSED = 6
 Classified paid.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- 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...
 
- 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...
 
 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 prepare a part of the query for insert. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage Trips and Expenses.

Definition at line 35 of file expensereport.class.php.

Constructor & Destructor Documentation

ExpenseReport::__construct (   $db)

Constructor.

Parameters
DoliDB$dbHandler acces base de donnees

Definition at line 210 of file expensereport.class.php.

References db.

Member Function Documentation

ExpenseReport::addline (   $qty = 0,
  $up = 0,
  $fk_c_type_fees = 0,
  $vatrate = 0,
  $date = '',
  $comments = '',
  $fk_project = 0,
  $fk_c_exp_tax_cat = 0,
  $type = 0,
  $fk_ecm_files = 0 
)

addline

Parameters
float$qtyQty
double$upValue init
int$fk_c_type_feesType payment
string$vatrateVat rate (Can be '10' or '10 (ABC)')
string$dateDate
string$commentsDescription
int$fk_projectProject id
int$fk_c_exp_tax_catCar category id
int$typeType line
int$fk_ecm_filesId of ECM file to link to this expensereport line
Returns
int <0 if KO, >0 if OK

Definition at line 1800 of file expensereport.class.php.

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

ExpenseReport::applyOffset ( )

Method to apply the offset if needed.

Returns
boolean true=applied, false=not applied

Definition at line 1959 of file expensereport.class.php.

References calcul_price_total(), db, ExpenseReportIk\getRangeByUser(), and offsetAlreadyGiven().

Referenced by addline(), and updateline().

ExpenseReport::checkRules (   $type = 0,
  $seller = '' 
)

Check constraint of rules and update price if needed.

Parameters
int$typetype of line
string$sellerseller, but actually he is unknown
Returns
true or false

Definition at line 1893 of file expensereport.class.php.

References calcul_price_total(), ExpenseReportRule\getAllRule(), and price().

Referenced by addline(), and updateline().

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

Create object in database.

Parameters
User$userUser that create
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 231 of file expensereport.class.php.

References $resql, CommonObject\call_trigger(), db, dol_now(), dol_syslog(), CommonObject\insertExtraFields(), and CommonObject\update_price().

Referenced by createFromClone().

ExpenseReport::createFromClone ( User  $user,
  $fk_user_author 
)

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

Parameters
User$userUser making the clone
int$fk_user_authorId of new user
Returns
int New id of clone

Definition at line 402 of file expensereport.class.php.

References create(), and db.

ExpenseReport::delete ( User  $user = null,
  $notrigger = false 
)

Delete object in database.

Parameters
User$userUser that delete
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1103 of file expensereport.class.php.

References CommonObject\call_trigger(), db, CommonObject\delete_linked_contact(), CommonObject\deleteEcmFiles(), CommonObject\deleteExtraFields(), CommonObject\deleteObjectLinked(), dol_delete_dir_recursive(), dol_delete_file(), dol_delete_preview(), dol_sanitizeFileName(), and dol_syslog().

ExpenseReport::deleteline (   $rowid,
  $fuser = '' 
)

deleteline

Parameters
int$rowidRow id
User$fuserUser
Returns
int <0 if KO, >0 if OK

Definition at line 2154 of file expensereport.class.php.

References db, and dol_syslog().

ExpenseReport::fetch_line_by_project (   $projectid,
  $user = '' 
)

fetch_line_by_project

Parameters
int$projectidProject id
User$userUser
Returns
int <0 if KO, >0 if OK

Definition at line 871 of file expensereport.class.php.

References db, dol_syslog(), img_picto(), price(), and print.

ExpenseReport::fetch_lines ( )

fetch_lines

Returns
int <0 if OK, >0 if KO

Definition at line 1020 of file expensereport.class.php.

References $resql, db, and dol_syslog().

ExpenseReport::fetch_users_approver_expensereport ( )

Return list of people with permission to validate expense reports.

Search for permission "approve expense report"

Returns
array Array of user ids

Definition at line 2236 of file expensereport.class.php.

References db, and dol_syslog().

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

Create a document onto disk accordign to template module.

Parameters
string$modeleForce le mnodele a utiliser ('' to not force)
Translate$outputlangsobjet lang a utiliser pour traduction
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

Definition at line 2280 of file expensereport.class.php.

References CommonObject\commonGenerateDocument(), and dol_strlen().

ExpenseReport::getLibStatut (   $mode = 0)

Returns the label status.

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 699 of file expensereport.class.php.

References LibStatut().

ExpenseReport::getNextNumRef ( )

Return next reference of expense report not already used.

Returns
string free ref

Definition at line 1610 of file expensereport.class.php.

References dol_buildpath(), and dol_print_error().

Referenced by setValidate().

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

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
int$maxMax length of shown 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 1666 of file expensereport.class.php.

References $_SERVER, dol_trunc(), img_object(), img_picto(), and price().

ExpenseReport::getSumPayments ( )

Return amount of payments already done.

Returns
int Amount of payment already done, <0 if KO

Definition at line 2506 of file expensereport.class.php.

References $resql, db, and dol_syslog().

ExpenseReport::getVentilExportCompta ( )

Return if object was dispatched into bookkeeping.

Returns
int <0 if KO, 0=no, 1=yes

Definition at line 2474 of file expensereport.class.php.

References $resql, and db.

ExpenseReport::hasDelay (   $option)

Return if an expense report is late or not.

Parameters
string$option'topay' or 'toapprove'
Returns
boolean True if late, False if not late

Definition at line 2453 of file expensereport.class.php.

References dol_now().

ExpenseReport::info (   $id)

Load information on object.

Parameters
int$idId of object
Returns
void

Definition at line 732 of file expensereport.class.php.

References $resql, db, and dol_print_error().

ExpenseReport::initAsSpecimen ( )

Initialise an instance with random values.

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

Returns
void

Definition at line 807 of file expensereport.class.php.

References db, and dol_now().

ExpenseReport::LibStatut (   $status,
  $mode = 0 
)

Returns the label of a status.

Parameters
int$statusID status
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
Returns
string Label

Definition at line 712 of file expensereport.class.php.

References dolGetStatus().

Referenced by getLibStatut().

ExpenseReport::listOfTypes (   $active = 1)

List of types.

Parameters
int$activeActive or not
Returns
array

Definition at line 2311 of file expensereport.class.php.

References db, dol_print_error(), and dol_syslog().

ExpenseReport::load_board (   $user,
  $option = 'topay' 
)

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

Parameters
User$userObjet user
string$option'topay' or 'toapprove'
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 2382 of file expensereport.class.php.

References $resql, db, dol_now(), dol_print_error(), and img_object().

ExpenseReport::load_state_board ( )

Charge indicateurs this->nb pour le tableau de bord.

Returns
int <0 if KO, >0 if OK

Definition at line 2342 of file expensereport.class.php.

References $resql, db, and dol_print_error().

ExpenseReport::offsetAlreadyGiven ( )

If the sql find any rows then the ikoffset is already given (ikoffset is applied at the first expense report line)

Returns
bool

Definition at line 2007 of file expensereport.class.php.

References $resql, db, dol_print_date(), dol_print_error(), and dol_syslog().

Referenced by applyOffset().

ExpenseReport::periode_existe (   $fuser,
  $date_debut,
  $date_fin 
)

periode_existe

Parameters
User$fuserUser
integer$date_debutStart date
integer$date_finEnd date
Returns
int <0 if KO, >0 if OK

Definition at line 2185 of file expensereport.class.php.

References db, and dol_syslog().

ExpenseReport::recalculer (   $id)

recalculer TODO Replace this with call to update_price if not already done

Parameters
int$idId of expense report
Returns
int <0 if KO, >0 if OK

Definition at line 972 of file expensereport.class.php.

References db, and dol_syslog().

ExpenseReport::set_cancel (   $fuser,
  $detail,
  $notrigger = 0 
)

set_cancel

Parameters
User$fuserUser
string$detailDetail
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1556 of file expensereport.class.php.

References CommonObject\call_trigger(), db, dol_now(), and dol_syslog().

ExpenseReport::set_paid (   $id,
  $fuser,
  $notrigger = 0 
)

Classify the expense report as paid.

Parameters
int$idId of expense report
user$fuserUser making change
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 646 of file expensereport.class.php.

References $resql, CommonObject\call_trigger(), db, dol_print_error(), and dol_syslog().

ExpenseReport::set_save_from_refuse (   $fuser)

set_save_from_refuse

Parameters
User$fuserUser
Returns
int <0 if KO, >0 if OK

Definition at line 1340 of file expensereport.class.php.

References db, and dol_syslog().

ExpenseReport::set_unpaid (   $fuser,
  $notrigger = 0 
)

set_unpaid

Parameters
User$fuserUser
int$notriggerDisable triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1500 of file expensereport.class.php.

References CommonObject\call_trigger(), db, and dol_syslog().

ExpenseReport::setApproved (   $fuser,
  $notrigger = 0 
)

Set status to approved.

Parameters
User$fuserUser
int$notriggerDisable triggers
Returns
int <0 if KO, 0 if nothing done, >0 if OK

Definition at line 1383 of file expensereport.class.php.

References CommonObject\call_trigger(), db, dol_now(), and dol_syslog().

ExpenseReport::setDeny (   $fuser,
  $details,
  $notrigger = 0 
)

setDeny

Parameters
User$fuserUser
string$detailsDetails
int$notriggerDisable triggers
Returns
int

Definition at line 1440 of file expensereport.class.php.

References CommonObject\call_trigger(), db, dol_now(), and dol_syslog().

ExpenseReport::setValidate (   $fuser,
  $notrigger = 0 
)

Set to status validate.

Parameters
User$fuserUser
int$notriggerDisable triggers
Returns
int <0 if KO, 0 if nothing done, >0 if OK

Definition at line 1218 of file expensereport.class.php.

References $resql, CommonObject\call_trigger(), db, dol_dir_list(), dol_now(), dol_sanitizeFileName(), dol_syslog(), and getNextNumRef().

ExpenseReport::update (   $user,
  $notrigger = 0,
  $userofexpensereport = null 
)

update

Parameters
User$userUser making change
int$notriggerDisable triggers
User$userofexpensereportNew user we want to have the expense report on.
Returns
int <0 if KO, >0 if OK

Definition at line 480 of file expensereport.class.php.

References CommonObject\call_trigger(), db, and dol_syslog().

ExpenseReport::update_totaux_add (   $ligne_total_ht,
  $ligne_total_tva 
)

Update total of an expense report when you add a line.

Parameters
string$ligne_total_htAmount without taxes
string$ligne_total_tvaAmount of all taxes
Returns
void

Definition at line 1733 of file expensereport.class.php.

References db.

ExpenseReport::update_totaux_del (   $ligne_total_ht,
  $ligne_total_tva 
)

Update total of an expense report when you delete a line.

Parameters
string$ligne_total_htAmount without taxes
string$ligne_total_tvaAmount of all taxes
Returns
void

Definition at line 1763 of file expensereport.class.php.

References db.

ExpenseReport::updateline (   $rowid,
  $type_fees_id,
  $projet_id,
  $vatrate,
  $comments,
  $qty,
  $value_unit,
  $date,
  $expensereport_id,
  $fk_c_exp_tax_cat = 0,
  $fk_ecm_files = 0 
)

Update an expense report line.

Parameters
int$rowidLine to edit
int$type_fees_idType payment
int$projet_idProject id
double$vatrateVat rate. Can be '8.5' or '8.5* (8.5NPROM...)'
string$commentsDescription
float$qtyQty
double$value_unitValue init
int$dateDate
int$expensereport_idExpense report id
int$fk_c_exp_tax_catId of category of car
int$fk_ecm_filesId of ECM file to link to this expensereport line
Returns
int <0 if KO, >0 if OK

Definition at line 2045 of file expensereport.class.php.

References $resql, applyOffset(), calcul_price_total(), checkRules(), db, getLocalTaxesFromRate(), and price2num().


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