pdf_proforma
class pdf_proforma extends pdf_eratosthene (View source)
Class to generate PDF orders with template Proforma
Properties
| string | $name | from pdf_eratosthene | |
| string | $version | Dolibarr version of the loaded document |
from pdf_eratosthene |
| string | $error | from CommonDocGenerator | |
| string[] | $errors | from CommonDocGenerator | |
| string[] | $warnings | from CommonDocGenerator | |
| DoliDB | $db | from pdf_eratosthene | |
| ExtraFields | $extrafieldsCache | from CommonDocGenerator | |
| int | $update_main_doc_field | from pdf_eratosthene | |
| string | $scandir | from CommonDocGenerator | |
| string | $description | from pdf_eratosthene | |
| array{0: float, 1: float} | $format | from CommonDocGenerator | |
| string | $type | from pdf_eratosthene | |
| float | $page_hauteur | from CommonDocGenerator | |
| float | $page_largeur | from CommonDocGenerator | |
| float | $marge_gauche | from CommonDocGenerator | |
| float | $marge_droite | from CommonDocGenerator | |
| float | $marge_haute | from CommonDocGenerator | |
| float | $marge_basse | from CommonDocGenerator | |
| int | $corner_radius | from CommonDocGenerator | |
| int<0, 1> | $option_logo | from CommonDocGenerator | |
| int<0, 1> | $option_tva | from CommonDocGenerator | |
| int<0, 1> | $option_multilang | from CommonDocGenerator | |
| int<0, 1> | $option_freetext | from CommonDocGenerator | |
| int<0, 1> | $option_draft_watermark | from CommonDocGenerator | |
| string | $watermark | from CommonDocGenerator | |
| int<0, 1> | $option_modereg | from CommonDocGenerator | |
| int<0, 1> | $option_condreg | from CommonDocGenerator | |
| int<0, 1> | $option_escompte | from CommonDocGenerator | |
| int<0, 1> | $option_credit_note | from CommonDocGenerator | |
| array<string, float> | $tva | from ModelePDFCommandes | |
| array<string, array{amount: float}> | $tva_array | from ModelePDFCommandes | |
| array<int, array<string, float>> | $localtax1 | Local tax rates Array[tax_type][tax_rate] |
from ModelePDFCommandes |
| array<int, array<string, float>> | $localtax2 | Local tax rates Array[tax_type][tax_rate] |
from ModelePDFCommandes |
| int | $tabTitleHeight | from CommonDocGenerator | |
| array{align?: "R"|"C"|"L", padding?: array<float|int>} | $defaultTitlesFieldsStyle | from CommonDocGenerator | |
| array{align?: "R"|"C"|"L", padding?: array<float|int>} | $defaultContentsFieldsStyle | from CommonDocGenerator | |
| Societe | $emetteur | from CommonDocGenerator | |
| array{0: int, 1: int} | $phpmin | from CommonDocGenerator | |
| array<string, array{rank: int, width: float|false, status: bool|int<0, 1>, border-left?: bool, title: array{textkey: string, label?: string, align?: string, padding?: array{0: float, 1: float, 2: float, 3: float}}, content?: array{align?: string, padding?: array{0: float, 1: float, 2: float, 3: float}}}> | $cols | from pdf_eratosthene | |
| array<string, array{page: int, y: float|int}> | $afterColsLinePositions | from CommonDocGenerator | |
| array{fullpath: string} | $result | from CommonDocGenerator | |
| float | $posxlabel | from CommonDocGenerator | |
| float | $posxup | from ModelePDFCommandes | |
| float | $posxref | from CommonDocGenerator | |
| float | $posxpicture | from ModelePDFCommandes | |
| float | $posxdesc | from ModelePDFCommandes | |
| float | $posxqty | from ModelePDFCommandes | |
| float | $posxpuht | from CommonDocGenerator | |
| float | $posxtva | from ModelePDFCommandes | |
| float|int | $posxtotalht | from CommonDocGenerator | |
| float | $postotalht | from ModelePDFCommandes | |
| float | $posxunit | from ModelePDFCommandes | |
| float | $posxdiscount | from ModelePDFCommandes | |
| float | $posxworkload | from CommonDocGenerator | |
| float | $posxtimespent | from CommonDocGenerator | |
| float | $posxprogress | from CommonDocGenerator | |
| bool | $atleastonephoto | from CommonDocGenerator | |
| int<0, 1> | $atleastoneratenotnull | from ModelePDFCommandes | |
| int<0, 1> | $atleastonediscount | from ModelePDFCommandes | |
| int | $entity | from pdf_eratosthene |
Methods
Constructor
Define array with couple substitution key => substitution value
Define array with couple substitution key => substitution value
Define array with couple substitution key => substitution value
Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}
Define array with couple substitution key => substitution value
Define array with couple substitution key => substitution value
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
Define array with couple substitution key => substitution value
Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted.
Rect pdf
Print a rounded rectangle on the PDF
Get position in PDF after col display
Used for reset afterColsLinePositions var in start of a new pdf draw line loop
Used for to set afterColsLinePositions var in a pdf draw line loop
uasort callback function to Sort columns fields
Prepare Array Column Field
get column content width from column key
get column content X (abscissa) left position from column key
get column position rank from column key
print standard column content
print description column content
get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block
display extrafields columns content
Print standard column content
Define Array Column Field for extrafields
Define Array Column Field
Return list of active generation modules
Function to build pdf onto disk
Show miscellaneous information (payment mode, payment term, ...)
Show total to pay
Show table for lines
Show footer of page. Need this->emetteur object
Details
__construct($db)
Constructor
@param DoliDB $db Database handler
array<string, float|string>
get_substitutionarray_user(User $user, Translate $outputlangs)
Define array with couple substitution key => substitution value
array<string, float|string>
getSubstitutionarrayMember(Adherent $member, Translate $outputlangs)
Define array with couple substitution key => substitution value
array<string, mixed>
get_substitutionarray_mysoc(Societe $mysoc, Translate $outputlangs)
Define array with couple substitution key => substitution value
array<string, mixed>
get_substitutionarray_thirdparty(Societe $object, Translate $outputlangs, string $array_key = 'company')
Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}
array<string, mixed>
get_substitutionarray_contact(Contact $object, Translate $outputlangs, string $array_key = 'object')
Define array with couple substitution key => substitution value
array<string, mixed>
get_substitutionarray_other(Translate $outputlangs)
Define array with couple substitution key => substitution value
array<string, mixed>
get_substitutionarray_object(CommonObject $object, Translate $outputlangs, string $array_key = 'object')
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
get_substitutionarray_lines(CommonObjectLine $line, Translate $outputlangs, $linenumber = 0)
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
array<string, mixed>
get_substitutionarray_shipment(Expedition $object, Translate $outputlangs, string $array_key = 'object')
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted.
array<string, mixed>
get_substitutionarray_each_var_object(CommonObject|float|int|string>|CommonObject $object, Translate $outputlangs, bool|int $recursive = 1)
Define array with couple substitution key => substitution value
array<string, float|string>
fill_substitutionarray_with_extrafields(CommonObject $object, array<string, float|string> $array_to_fill, $extrafields, $array_key, $outputlangs)
Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted.
void
printRect(TCPDI|TCPDF $pdf, float $x, float $y, float $l, float $h, int<-1, 1> $hidetop = 0, int<0, 1> $hidebottom = 0)
Rect pdf
void
printRoundedRect(TCPDF $pdf, float $x, float $y, float $w, float $h, float $r, int<-1, 1> $hidetop = 0, int $hidebottom = 0, string $style = 'D')
Print a rounded rectangle on the PDF
false|array{page: int, y: float|int, col: string}
getMaxAfterColsLinePositionsData()
Get position in PDF after col display
void
resetAfterColsLinePositionsData(float $y, int $pageNumb)
Used for reset afterColsLinePositions var in start of a new pdf draw line loop
void
setAfterColsLinePositionsData(string $colId, float $y, int $pageNumb)
Used for to set afterColsLinePositions var in a pdf draw line loop
columnSort($a, array{rank?: int} $b)
uasort callback function to Sort columns fields
@param array{rank?:int} $a PDF lines array fields configs
prepareArrayColumnField($object, Translate $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
Prepare Array Column Field
@param CommonObject $object common object
float
getColumnContentWidth($colKey)
get column content width from column key
@param string $colKey the column key
float
getColumnContentXStart($colKey)
get column content X (abscissa) left position from column key
@param string $colKey the column key
int
getColumnRank($colKey)
get column position rank from column key
@param string $colKey the column key
insertNewColumnDef($newColKey, array{rank?: int} $defArray, $targetCol = '', $insertAfterTarget = false)
get column position rank from column key
@param string $newColKey the new column key
printStdColumnContent(TCPDI|TCPDF $pdf, $curY, $colKey, $columnText = '')
print standard column content
printColDescContent(TCPDI|TCPDF $pdf, $curY, $colKey, $object, $i, $outputlangs, $hideref = 0, $hidedesc = 0, $issupplierline = 0)
print description column content
getExtrafieldContent($object, string $extrafieldKey, $outputlangs = null)
get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block
@param CommonObject $object Common object
getExtrafieldsInHtml($object, Translate $outputlangs, $params = array())
display extrafields columns content
@param CommonObject|CommonObjectLine $object line of common object
bool
getColumnStatus($colKey)
get column status from column key
@param string $colKey the column key
float
pdfTabTitles(TCPDI|TCPDF $pdf, float $tab_top, float $tab_height, Translate $outputlangs, int $hidetop = 0)
Print standard column content
defineColumnExtrafield($object, Translate $outputlangs, $hidedetails = 0)
Define Array Column Field for extrafields
@param CommonObject $object common object det
defineColumnField($object, Translate $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
Define Array Column Field
@param CommonObject $object common object
static
liste_modeles($db, int<0, max> $maxfilenamelength = 0)
Return list of active generation modules
@param DoliDB $db Database handler
write_file(Commande $object, $outputlangs, $srctemplatepath = '', $hidedetails = 0, $hidedesc = 0, $hideref = 0)
Function to build pdf onto disk
@param Commande $object Object to generate
protected int
drawPaymentsTable($pdf, Commande $object, float $posy, Translate $outputlangs)
Show payments table
@param TCPDF $pdf Object PDF
protected
drawInfoTable($pdf, Commande $object, $posy, $outputlangs)
Show miscellaneous information (payment mode, payment term, ...)
@param TCPDF $pdf Object PDF
protected float
drawTotalTable(TCPDF $pdf, Commande $object, float $deja_regle, float $posy, Translate $outputlangs, $outputlangsbis = null)
Show total to pay
protected
_tableau($pdf, float|int $tab_top, $tab_height, $nexY, $outputlangs, $hidetop = 0, $hidebottom = 0, $currency = '', $outputlangsbis = null)
Show table for lines
@param TCPDF $pdf Object PDF
protected
_pagehead($pdf, Commande $object, $showaddress, $outputlangs, $outputlangsbis = null, $titlekey = "InvoiceProForma")
Show top header of page.
@param TCPDF $pdf Object PDF
protected
_pagefoot($pdf, Commande $object, $outputlangs, $hidefreetext = 0)
Show footer of page. Need this->emetteur object
@param TCPDF $pdf PDF