ExpenseReport Class Reference

Class to manage Trips and Expenses. More...

Inheritance diagram for ExpenseReport:

Collaboration diagram for ExpenseReport:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user, $notrigger=0)
	Create object in database.
	createFromClone (User $user, $fk_user_author)
	Load an object from its id and create a new one in database.
	update ($user, $notrigger=0, $userofexpensereport=null)
	update
ref}
Load an object from database Parameters int $id Id {@min 1} string $ref Ref { Returns int Return integer <0 if KO, >0 if OK
	set_paid ($id, $fuser, $notrigger=0)
	Classify the expense report as paid.
	setPaid ($id, $fuser, $notrigger=0)
	Classify the expense report as paid.
	getLibStatut ($mode=0)
	Returns the label status.
	LibStatut ($status, $mode=0)
	Returns the label of a status.
	info ($id)
	Load information on object.
	initAsSpecimen ()
	Initialise an instance with random values.
	fetch_line_by_project ($projectid, $user)
	fetch_line_by_project
	fetch_lines ()
	fetch_lines
	delete ($user=null, $notrigger=0)
	Delete object in database.
	setValidate ($fuser, $notrigger=0)
	Set to status validate.
	set_save_from_refuse ($fuser)
	set_save_from_refuse
	setApproved ($fuser, $notrigger=0)
	Set status to approved.
	setDeny ($fuser, $details, $notrigger=0)
	setDeny
	set_unpaid ($fuser, $notrigger=0)
	set_unpaid
	setUnpaid ($fuser, $notrigger=0)
	set_unpaid
	set_cancel ($fuser, $detail, $notrigger=0)
	set_cancel
	getNextNumRef ()
	Return next reference of expense report not already used.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $save_lastsearch_value=-1)
	Return clickable name (with picto eventually)
	update_totaux_add ($ligne_total_ht, $ligne_total_tva)
	Update total of an expense report when you add a line.
	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)
	Add expense report line.
	checkRules ($type=0, $seller='')
	Check constraint of rules and update price if needed.
	applyOffset ($type=0, $seller='')
	Method to apply the offset if needed.
	offsetAlreadyGiven ()
	If the sql find any rows then the ikoffset is already given (ikoffset is applied at the first expense report line)
	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, $notrigger=0)
	Update an expense report line.
	deleteLine ($rowid, $fuser='', $notrigger=0)
	deleteline
	periode_existe ($fuser, $date_debut, $date_fin)
	periode_existe
	fetch_users_approver_expensereport ()
	Return list of people with permission to validate expense reports.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	listOfTypes ($active=1)
	List of types.
	loadStateBoard ()
	Load the indicators this->nb for the state board.
	load_board ($user, $option='topay')
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	hasDelay ($option)
	Return if an expense report is late or not.
	getVentilExportCompta ()
	Return if object was dispatched into bookkeeping.
	getSumPayments ()
	Return amount of payments already done.
	computeTotalKm ($fk_cat, $qty, $tva)
	Compute the cost of the kilometers expense based on the number of kilometers and the vehicle category.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with optional picto)
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	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.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	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=0, $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=0, $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='auto', $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.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	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=0, $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.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	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='', $display_type='card')
	Function to show lines of extrafields with output data.
	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.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	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.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	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.

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_CLOSED = 6
	Classified paid.
const	STATUS_REFUSED = 99
	Classified refused.
Public Attributes inherited from CommonObject
	$origin_object

Additional Inherited Members
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.
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	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count 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.
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	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.

Detailed Description

Class to manage Trips and Expenses.

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

Constructor & Destructor Documentation

__construct()

ExpenseReport::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Handler access base de donnees

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

Member Function Documentation

addline()

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 )

Add expense report line.

Parameters

float	$qty	Qty
double	$up	Unit price (price with tax)
int	$fk_c_type_fees	Type payment
	int<-1,0>|string	$vatrate Vat rate (Can be '10' or '10 (ABC)')
string	$date	Date
string	$comments	Description
int	$fk_project	Project id
int	$fk_c_exp_tax_cat	Car category id
int	$type	Type line
int	$fk_ecm_files	Id of ECM file to link to this expensereport line

Returns

int Return integer <0 if KO, >0 if OK

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

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

applyOffset()

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

Method to apply the offset if needed.

Parameters

int	$type	Type of line
string	$seller	Seller, but actually he is unknown

Returns

boolean True=applied, False=not applied

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

References calcul_price_total(), getDolGlobalString(), and offsetAlreadyGiven().

Referenced by addline(), and updateline().

checkRules()

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

Check constraint of rules and update price if needed.

Parameters

int	$type	Type of line
string	$seller	Seller, but actually he is unknown

Returns

boolean true or false

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

References calcul_price_total(), and price().

Referenced by addline(), and updateline().

computeTotalKm()

ExpenseReport::computeTotalKm	(		$fk_cat,
			$qty,
			$tva )

Compute the cost of the kilometers expense based on the number of kilometers and the vehicle category.

Parameters

int	$fk_cat	Category of the vehicle used
float	$qty	Number of kilometers
float	$tva	VAT rate

Returns

int Return integer <0 if KO, total ttc if OK

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

References dol_getdate(), dol_now(), dol_syslog(), price2num(), and STATUS_VALIDATED.

create()

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

Create object in database.

Parameters

User	$user	User that create
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References CommonObject\call_trigger(), dol_now(), dol_syslog(), CommonObject\insertExtraFields(), ref, and CommonObject\update_price().

Referenced by createFromClone().

createFromClone()

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

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

Parameters

User	$user	User making the clone
int	$fk_user_author	Id of new user

Returns

int New id of clone

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

References create(), ref, CommonObject\setErrorsFromObject(), and status.

delete()

ExpenseReport::delete	(		$user = null,
			$notrigger = 0 )

Delete object in database.

Parameters

?User	$user	User that delete
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

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

deleteLine()

ExpenseReport::deleteLine	(		$rowid,
			$fuser = '',
			$notrigger = 0 )

deleteline

Parameters

int	$rowid	Row id
User | string	$fuser	User
	int<0,1>	$notrigger 1=No trigger

Returns

int<-1,1> Return integer <0 if KO, >0 if OK

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

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

fetch_line_by_project()

ExpenseReport::fetch_line_by_project	(		$projectid,
			$user )

fetch_line_by_project

Parameters

int	$projectid	Project id
User	$user	User

Returns

int Return integer <0 if KO, >0 if OK

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

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

fetch_lines()

ExpenseReport::fetch_lines

(

)

fetch_lines

Returns

int Return integer <0 if OK, >0 if KO

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

References dol_syslog(), and getDolGlobalString().

fetch_users_approver_expensereport()

ExpenseReport::fetch_users_approver_expensereport

(

)

Return list of people with permission to validate expense reports.

Search for permission "approve expense report"

Returns

int[]|int<-1,-1> Array of user ids, <0 if KO

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

References dol_syslog().

generateDocument()

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

Create a document onto disk according to template module.

Parameters

string	$modele	Force le mnodele a utiliser ('' to not force)
Translate	$outputlangs	object lang a utiliser pour traduction
	int<0,1>	$hidedetails Hide details of lines
	int<0,1>	$hidedesc Hide description
	int<0,1>	$hideref Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int 0 if KO, 1 if OK

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

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

getKanbanView()

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

Return clickable link of object (with optional picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

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

References getNomUrl(), and img_picto().

getLibStatut()

ExpenseReport::getLibStatut

(

$mode = 0

)

Returns the label status.

Parameters

int

$mode

0=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 855 of file expensereport.class.php.

References LibStatut(), and status.

getNextNumRef()

ExpenseReport::getNextNumRef

(

)

Return next reference of expense report not already used.

Returns

string|int<-2,-1> free ref, or <0 if error

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

References dol_buildpath(), dol_print_error(), and getDolGlobalString().

Referenced by setValidate().

getNomUrl()

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

Return clickable name (with picto eventually)

Parameters

	int<0,2>	$withpicto 0=No picto, 1=Include picto into link, 2=Only picto
string	$option	Where points the link ('', 'document', ..)
int	$max	Max length of shown ref
	int<0,1>	$short 1=Return just URL
string	$moretitle	Add more text to title tooltip
	int<0,1>	$notooltip 1=Disable tooltip
	int<-1,1>	$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 1813 of file expensereport.class.php.

References dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), and img_object().

Referenced by getKanbanView().

getSumPayments()

ExpenseReport::getSumPayments

(

)

Return amount of payments already done.

Returns

int Amount of payment already done, <0 if KO

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

References dol_syslog().

getTooltipContentArray()

ExpenseReport::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

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

References img_picto(), price(), ref, and status.

Referenced by getNomUrl().

getVentilExportCompta()

ExpenseReport::getVentilExportCompta

(

)

Return if object was dispatched into bookkeeping.

Returns

int Return integer <0 if KO, 0=no, 1=yes

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

hasDelay()

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

References dol_now(), and status.

info()

ExpenseReport::info

(

$id

)

Load information on object.

Parameters

int

$id

Id of object

Returns

void

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

References dol_print_error().

initAsSpecimen()

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

int

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

References dol_now(), ref, and status.

LibStatut()

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

Returns the label of a status.

Parameters

int	$status	ID status
int	$mode	0=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 868 of file expensereport.class.php.

Referenced by getLibStatut().

listOfTypes()

ExpenseReport::listOfTypes

(

$active = 1

)

List of types.

Parameters

int<0,1>

$active Active or not

Returns

array<string,string>

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

References dol_print_error(), and dol_syslog().

load_board()

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

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

Parameters

User	$user	Object user
string	$option	'topay' or 'toapprove'

Returns

WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

References dol_now(), dol_print_error(), img_object(), STATUS_APPROVED, and STATUS_VALIDATED.

loadStateBoard()

ExpenseReport::loadStateBoard

(

)

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

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_print_error().

offsetAlreadyGiven()

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

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

Referenced by applyOffset().

periode_existe()

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

periode_existe

Parameters

User	$fuser	User
integer	$date_debut	Start date
integer	$date_fin	End date

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog().

set_cancel()

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

set_cancel

Parameters

User	$fuser	User
string	$detail	Detail
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

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

set_paid()

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

Classify the expense report as paid.

Deprecated

See also

setPaid()

Parameters

int	$id	Id of expense report
user	$fuser	User making change
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setPaid().

set_save_from_refuse()

ExpenseReport::set_save_from_refuse

(

$fuser

)

set_save_from_refuse

Parameters

User

$fuser

User

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and status.

set_unpaid()

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

set_unpaid

Deprecated

See also

setUnpaid()

Parameters

User	$fuser	User
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References dol_syslog(), and setUnpaid().

setApproved()

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

Set status to approved.

Parameters

User	$fuser	User
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, 0 if nothing done, >0 if OK

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

References CommonObject\call_trigger(), dol_now(), dol_syslog(), ref, and status.

setDeny()

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

setDeny

Parameters

User	$fuser	User
string	$details	Details
int	$notrigger	Disable triggers

Returns

int

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

References CommonObject\call_trigger(), dol_now(), dol_syslog(), ref, and status.

setPaid()

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

Classify the expense report as paid.

Parameters

int	$id	Id of expense report
user	$fuser	User making change
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References CommonObject\call_trigger(), dol_print_error(), dol_syslog(), and STATUS_APPROVED.

Referenced by set_paid().

setUnpaid()

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

set_unpaid

Parameters

User	$fuser	User
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

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

Referenced by set_unpaid().

setValidate()

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

Set to status validate.

Parameters

User	$fuser	User
int	$notrigger	Disable triggers

Returns

int Return integer <0 if KO, 0 if nothing done, >0 if OK

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

References CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_sanitizeFileName(), dol_syslog(), getNextNumRef(), ref, status, and STATUS_VALIDATED.

update()

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

update

Parameters

User	$user	User making change
int	$notrigger	Disable triggers
User	$userofexpensereport	New user we want to have the expense report on.

Returns

int Return integer <0 if KO, >0 if OK

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

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

update_totaux_add()

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_ht	Amount without taxes
string	$ligne_total_tva	Amount of all taxes

Returns

int

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

updateline()

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,
			$notrigger = 0 )

Update an expense report line.

Parameters

int	$rowid	Line to edit
int	$type_fees_id	Type payment
int	$projet_id	Project id
double	$vatrate	Vat rate. Can be '8.5' or '8.5* (8.5NPROM...)'
string	$comments	Description
float	$qty	Qty
double	$value_unit	Unit price (with taxes)
int	$date	Date
int	$expensereport_id	Expense report id
int	$fk_c_exp_tax_cat	Id of category of car
int	$fk_ecm_files	Id of ECM file to link to this expensereport line
int	$notrigger	1=No trigger

Returns

int Return integer <0 if KO, >0 if OK

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

References applyOffset(), calcul_price_total(), checkRules(), getLocalTaxesFromRate(), price2num(), and status.

---

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

• dolibarr_dev/htdocs/expensereport/class/expensereport.class.php