WebPortalInvoice Class Reference

Class for WebPortalInvoice. More...

Inheritance diagram for WebPortalInvoice:

Collaboration diagram for WebPortalInvoice:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $max=0, $short=0, $moretitle='', $notooltip=0, $addlinktonotes=0, $save_lastsearch_value=-1, $target='')
	Return clickable link of object (with eventually picto)
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
	getLabelStatus ($mode=0)
	Return the label of the status.
	getLibStatut ($mode=0, $alreadypaid=-1)
	Return label of object status.
	LibStatut ($paye, $status, $mode=0, $alreadypaid=-1, $type=-1)
	Return label of a status.
Public Member Functions inherited from Facture
	create (User $user, $notrigger=0, $forceduedate=0)
	Create invoice in database.
	createFromCurrent (User $user, $invertdetail=0)
	Create a new invoice in database from current invoice.
	createFromClone (User $user, $fromid=0)
	Load an object from its id and create a new one in database.
	createFromOrder ($object, User $user)
	Load an object from an order and create a new invoice into database.
	createFromContract ($object, User $user, $lines=array())
	Load an object from a contract and create a new invoice into database.
	fetch ($rowid, $ref='', $ref_ext='', $notused=0, $fetch_situation=false)
	Get object from database.
	fetch_lines ($only_product=0, $loadalsotranslation=0)
	Load all detailed lines into this->lines.
	fetchPreviousNextSituationInvoice ()
	Fetch previous and next situations invoices.
	update (User $user, $notrigger=0)
	Update database.
	insert_discount ($idremise)
	Add a discount line into an invoice (as an invoice line) using an existing absolute discount (Consume the discount)
	set_ref_client ($ref_client, $notrigger=0)
	Set customer ref.
	delete ($user, $notrigger=0, $idwarehouse=-1)
	Delete invoice.
	set_paid ($user, $close_code='', $close_note='')
	Tag the invoice as paid completely (if close_code is filled) => this->fk_statut=2, this->paye=1 or partially (if close_code filled) + appel trigger BILL_PAYED => this->fk_statut=2, this->paye stay 0.
	setPaid ($user, $close_code='', $close_note='')
	Tag the invoice as :
	set_unpaid ($user)
	Tags the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.
	setUnpaid ($user)
	Tag the invoice as incompletely paid and call the trigger BILL_UNPAYED This method is used when a direct debit (fr:prelevement) is refused or when a canceled invoice is reopened.
	set_canceled ($user, $close_code='', $close_note='')
	Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent).
	setCanceled ($user, $close_code='', $close_note='')
	Tag invoice as canceled, with no payment on it (example for replacement invoice or payment never received) + call trigger BILL_CANCEL Warning, if option to decrease stock on invoice was set, this function does not change stock (it might be a cancel because of no payment even if merchandises were sent).
	validate ($user, $force_number='', $idwarehouse=0, $notrigger=0, $batch_rule=0)
	Tag invoice as validated + call trigger BILL_VALIDATE Object must have lines loaded with fetch_lines.
	updatePriceNextInvoice (&$langs)
	Update price of next invoice.
	setDraft ($user, $idwarehouse=-1)
	Set draft status.
	addline ( $desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $date_start='', $date_end='', $fk_code_ventilation=0, $info_bits=0, $fk_remise_except=0, $price_base_type='HT', $pu_ttc=0, $type=0, $rang=-1, $special_code=0, $origin='', $origin_id=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_options=array(), $situation_percent=100, $fk_prev_id=0, $fk_unit=null, $pu_ht_devise=0, $ref_ext='', $noupdateafterinsertline=0)
	Add an invoice line into database (linked to product/service or not).
	updateline ($rowid, $desc, $pu, $qty, $remise_percent, $date_start, $date_end, $txtva, $txlocaltax1=0, $txlocaltax2=0, $price_base_type='HT', $info_bits=0, $type=self::TYPE_STANDARD, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_options=array(), $situation_percent=100, $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $ref_ext='', $rang=0)
	Update a detail line.
	checkProgressLine ($idline, $situation_percent)
	Check if the percent edited is lower of next invoice line.
	update_percent ($line, $percent, $update_price=true)
	Update invoice line with percentage.
	deleteLine ($rowid, $id=0)
	Delete line in database.
	set_remise ($user, $remise, $notrigger=0)
	Set percent discount.
	setDiscount ($user, $remise, $notrigger=0)
	Set percent discount.
	getNextNumRef ($soc, $mode='next')
	Set absolute discount.
	info ($id)
	Load miscellaneous information for tab "Info".
	liste_array ($shortlist=0, $draft=0, $excluser=null, $socid=0, $limit=0, $offset=0, $sortfield='f.datef, f.rowid', $sortorder='DESC')
	Return list of invoices (eventually filtered on a user) into an array.
	list_replacable_invoices ($socid=0)
	Return list of invoices qualified to be replaced by another invoice.
	list_qualified_avoir_invoices ($socid=0)
	Return list of invoices qualified to be corrected by a credit note.
	load_board ($user)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	getIdBillingContact ()
	Retourne id des contacts clients de facturation.
	getIdShippingContact ()
	Retourne id des contacts clients de livraison.
	initAsSpecimen ($option='')
	Initialise an instance with random values.
	loadStateBoard ()
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	getLinesArray ()
	Create an array of invoice lines.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	newCycle ()
	Gets the smallest reference available for a new cycle.
	is_first ()
	Checks if the invoice is the first of a cycle.
	get_prev_sits ()
	Returns an array containing the previous situations as Facture objects.
	setFinal (User $user, $notrigger=0)
	Sets the invoice as a final situation.
	is_last_in_cycle ()
	Checks if the invoice is the last in its cycle.
	hasDelay ()
	Is the customer invoice delayed?
	displayRetainedWarranty ()
	Currently used for documents generation : to know if retained warranty need to be displayed.
	getRetainedWarrantyAmount ($rounding=-1)
	setRetainedWarranty ($value)
	Change the retained warranty.
	setRetainedWarrantyDateLimit ($timestamp, $dateYmd='')
	Change the retained_warranty_date_limit.
	sendEmailsRemindersOnInvoiceDueDate ($nbdays=0, $paymentmode='all', $template='', $datetouse='duedate', $forcerecipient='')
	Send reminders by emails for invoices validated that are due.
	willBeLastOfSameType ($allow_validated_drafts=false)
	See if current invoice date is posterior to the last invoice date among validated invoices of same type.
Public Member Functions inherited from CommonInvoice
	getRemainToPay ($multicurrency=0)
	Return remain amount to pay.
	getSommePaiement ($multicurrency=0)
	Return amount of payments already done.
	getSumDepositsUsed ($multicurrency=0)
	Return amount (with tax) of all deposits invoices used by invoice.
	getSumCreditNotesUsed ($multicurrency=0)
	Return amount (with tax) of all credit notes invoices + excess received used by invoice.
	getSumFromThisCreditNotesNotUsed ($multicurrency=0)
	Return amount (with tax) of all converted amount for this credit note.
	getListIdAvoirFromInvoice ()
	Returns array of credit note ids from the invoice.
	getIdReplacingInvoice ($option='')
	Returns the id of the invoice that replaces it.
	getListOfPayments ($filtertype='', $multicurrency=0, $mode=0)
	Return list of payments.
	is_erasable ()
	Return if an invoice can be deleted Rule is: If invoice is draft and has a temporary ref -> yes (1) If hidden option INVOICE_CAN_NEVER_BE_REMOVED is on -> no (0) If invoice is dispatched in bookkeeping -> no (-1) If invoice has a definitive ref, is not last and INVOICE_CAN_ALWAYS_BE_REMOVED off -> no (-2) If invoice not last in a cycle -> no (-3) If there is payment -> no (-4) Otherwise -> yes (2)
	getVentilExportCompta ()
	Return if an invoice was transferred into accountnancy.
	getLibType ($withbadge=0)
	Return label of type of invoice.
	getSubtypeLabel ($table='')
	Return label of invoice subtype.
	getArrayOfInvoiceSubtypes ($mode=0)
	Retrieve a list of invoice subtype labels or codes.
	calculate_date_lim_reglement ($cond_reglement=0)
	Returns an invoice payment deadline based on the invoice settlement conditions and billing date.
	demande_prelevement (User $fuser, float $amount=0, string $type='direct-debit', string $sourcetype='facture', int $checkduplicateamongall=0, int $ribId=0)
	Create a withdrawal request for a direct debit order or a credit transfer order.
	makeStripeCardRequest ($fuser, $id, $sourcetype='facture')
	Create a payment with Stripe card Must take amount using Stripe and record an event into llx_actioncomm Record bank payment Send email to customer ?
	makeStripeSepaRequest ($fuser, $did, $type='direct-debit', $sourcetype='facture', $service='', $forcestripe='')
	Create a direct debit order into prelevement_bons for a given prelevement_request, then Send the payment order to the service (for a direct debit order or a credit transfer order) and record an event in llx_actioncomm.
	demande_prelevement_delete ($fuser, $did)
	Remove a direct debit request or a credit transfer request.
	buildEPCQrCodeString ()
	Build string for EPC QR Code.
	buildZATCAQRString ()
	Build string for ZATCA QR Code (Arabi Saudia)
	buildSwitzerlandQRString ()
	Build string for QR-Bill (Switzerland)
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.
	fetchBarCode ()
	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	ARRAY_STATUS_LABEL
	Status list (short label)
Public Attributes inherited from Facture
const	TYPE_STANDARD = 0
	Standard invoice.
const	TYPE_REPLACEMENT = 1
	Replacement invoice.
const	TYPE_CREDIT_NOTE = 2
	Credit note invoice.
const	TYPE_DEPOSIT = 3
	Deposit invoice.
const	TYPE_PROFORMA = 4
	Proforma invoice (should not be used.
const	TYPE_SITUATION = 5
	Situation invoice.
const	STATUS_DRAFT = 0
	Draft status.
const	STATUS_VALIDATED = 1
	Validated (need to be paid)
const	STATUS_CLOSED = 2
	Classified paid.
const	STATUS_ABANDONED = 3
	Classified abandoned and no payment done.
Public Attributes inherited from CommonInvoice
const	TYPE_STANDARD = 0
	Standard invoice.
const	TYPE_REPLACEMENT = 1
	Replacement invoice.
const	TYPE_CREDIT_NOTE = 2
	Credit note invoice.
const	TYPE_DEPOSIT = 3
	Deposit invoice.
const	TYPE_PROFORMA = 4
	Proforma invoice.
const	TYPE_SITUATION = 5
	Situation invoice.
const	STATUS_DRAFT = 0
	Draft status.
const	STATUS_VALIDATED = 1
	Validated (need to be paid)
const	STATUS_CLOSED = 2
	Classified paid.
const	STATUS_ABANDONED = 3
	Classified abandoned and no payment done.
Public Attributes inherited from CommonObject
	$origin_object

Protected Member Functions
	getInvoiceStatic ()
	Get invoice for static methods.
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.

Additional Inherited Members
Static Public Member Functions inherited from Facture
static	createDepositFromOrigin (CommonObject $origin, $date, $payment_terms_id, User $user, $notrigger=0, $autoValidateDeposit=false, $overrideFields=array())
	Creates a deposit from a proposal or an order by grouping lines by VAT rates.
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Replace a thirdparty id with another one.
static	replaceProduct (DoliDB $db, $origin_id, $dest_id)
	Replace a product id with another one.
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 Attributes inherited from Facture
	$table_ref_field = 'ref'
	{}

Detailed Description

Class for WebPortalInvoice.

Definition at line 33 of file webportalinvoice.class.php.

Constructor & Destructor Documentation

__construct()

WebPortalInvoice::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented from Facture.

Definition at line 154 of file webportalinvoice.class.php.

References getInvoiceStatic().

Member Function Documentation

getInvoiceStatic()

WebPortalInvoice::getInvoiceStatic ( )

protected

Get invoice for static methods.

Returns

Facture

Definition at line 140 of file webportalinvoice.class.php.

Referenced by __construct(), and LibStatut().

getKanbanView()

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

Return clickable link of object (with eventually 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.

Reimplemented from Facture.

Definition at line 277 of file webportalinvoice.class.php.

References getLibStatut(), getNomUrl(), and img_picto().

getLabelStatus()

WebPortalInvoice::getLabelStatus

(

$mode = 0

)

Return the label of the status.

Parameters

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 of status

Definition at line 312 of file webportalinvoice.class.php.

References LibStatut(), and type.

getLibStatut()

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

Return label of object status.

Parameters

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
int	$alreadypaid	0=No payment already done, >0=Some payments were already done

Returns

string Label of status

Reimplemented from CommonInvoice.

Definition at line 324 of file webportalinvoice.class.php.

References LibStatut(), and type.

Referenced by getKanbanView().

getNomUrl()

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

Return clickable link of object (with eventually picto)

Parameters

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
int	$notooltip	1=Disable tooltip
int	$addlinktonotes	1=Add link to notes
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
string	$target	Target of link ('', '_self', '_blank', '_parent', '_backoffice', ...)

Returns

string String with URL

Reimplemented from Facture.

Definition at line 194 of file webportalinvoice.class.php.

References $conf, dol_escape_htmltag(), dol_trunc(), getDolGlobalInt(), getTooltipContentArray(), img_object(), ref, and type.

Referenced by getKanbanView().

getTooltipContentArray()

WebPortalInvoice::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 Facture.

Definition at line 169 of file webportalinvoice.class.php.

Referenced by getNomUrl().

LibStatut()

WebPortalInvoice::LibStatut	(		$paye,
			$status,
			$mode = 0,
			$alreadypaid = -1,
			$type = -1 )

Return label of a status.

Parameters

int	$paye	Status field paye
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
int	$alreadypaid	0=No payment already done, >0=Some payments were already done
int	$type	Type invoice. If -1, we use $this->type

Returns

string Label of status

Reimplemented from CommonInvoice.

Definition at line 341 of file webportalinvoice.class.php.

References getInvoiceStatic().

Referenced by getLabelStatus(), and getLibStatut().

---

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

• dolibarr_dev/htdocs/webportal/class/webportalinvoice.class.php