dolibarr 21.0.0-alpha
|
Class to manage PDF template standard_myobject. More...
Public Member Functions | |
__construct ($db) | |
Constructor. | |
write_file ($object, $outputlangs, $srctemplatepath='', $hidedetails=0, $hidedesc=0, $hideref=0) | |
Function to build and write pdf to disk. | |
defineColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0) | |
Define Array Column Field. | |
Public Member Functions inherited from CommonDocGenerator | |
get_substitutionarray_user ($user, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
getSubstitutionarrayMember ($member, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_mysoc ($mysoc, $outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_thirdparty ($object, $outputlangs, $array_key='company') | |
Define array with couple substitution key => substitution value For example {company_name}, {company_name_alias}. | |
get_substitutionarray_contact ($object, $outputlangs, $array_key='object') | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_other ($outputlangs) | |
Define array with couple substitution key => substitution value. | |
get_substitutionarray_lines ($line, $outputlangs, $linenumber=0) | |
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. | |
get_substitutionarray_shipment ($object, $outputlangs, $array_key='object') | |
Define array with couple substitution key => substitution value Note that vars into substitutions array are formatted. | |
get_substitutionarray_each_var_object (&$object, $outputlangs, $recursive=1) | |
Define array with couple substitution key => substitution value. | |
fill_substitutionarray_with_extrafields ($object, $array_to_fill, $extrafields, $array_key, $outputlangs) | |
Fill array with couple extrafield key => extrafield value Note that vars into substitutions array are formatted. | |
printRect ($pdf, $x, $y, $l, $h, $hidetop=0, $hidebottom=0) | |
Rect pdf. | |
printRoundedRect ($pdf, $x, $y, $w, $h, $r, $hidetop=0, $hidebottom=0, $style='D') | |
Print a rounded rectangle on the PDF. | |
columnSort ($a, $b) | |
uasort callback function to Sort columns fields | |
prepareArrayColumnField ($object, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0) | |
Prepare Array Column Field. | |
getColumnContentWidth ($colKey) | |
get column content width from column key | |
getColumnContentXStart ($colKey) | |
get column content X (abscissa) left position from column key | |
getColumnRank ($colKey) | |
get column position rank from column key | |
insertNewColumnDef ($newColKey, $defArray, $targetCol='', $insertAfterTarget=false) | |
get column position rank from column key | |
printStdColumnContent ($pdf, &$curY, $colKey, $columnText='') | |
print standard column content | |
printColDescContent ($pdf, &$curY, $colKey, $object, $i, $outputlangs, $hideref=0, $hidedesc=0, $issupplierline=0) | |
print description column content | |
getExtrafieldContent ($object, $extrafieldKey, $outputlangs=null) | |
get extrafield content for pdf writeHtmlCell compatibility usage for PDF line columns and object note block | |
getColumnStatus ($colKey) | |
get column status from column key | |
pdfTabTitles (&$pdf, $tab_top, $tab_height, $outputlangs, $hidetop=0) | |
Print standard column content. | |
defineColumnExtrafield ($object, $outputlangs, $hidedetails=0) | |
Define Array Column Field for extrafields. | |
Static Public Member Functions | |
static | liste_modeles ($db, $maxfilenamelength=0) |
Return list of active generation modules. | |
Protected Member Functions | |
_tableau (&$pdf, $tab_top, $tab_height, $nexY, $outputlangs, $hidetop=0, $hidebottom=0, $currency='', $outputlangsbis=null) | |
Show table for lines. | |
_pagehead (&$pdf, $object, $showaddress, $outputlangs, $outputlangsbis=null) | |
Show top header of page. | |
_pagefoot (&$pdf, $object, $outputlangs, $hidefreetext=0) | |
Show footer of page. | |
Class to manage PDF template standard_myobject.
Definition at line 47 of file pdf_standard_myobject.modules.php.
pdf_standard_myobject::__construct | ( | $db | ) |
Constructor.
Reimplemented from CommonDocGenerator.
Definition at line 108 of file pdf_standard_myobject.modules.php.
References description, dol_syslog(), getCallerInfoString(), getDolGlobalInt(), name, pdf_getFormat(), and type.
|
protected |
Show footer of page.
Need this->emetteur object
TCPDI | TCPDF | ||
CommonObject | $object | Object to show |
Translate | $outputlangs | Object lang for output |
int<0,1> | $hidefreetext 1=Hide free text |
Definition at line 1200 of file pdf_standard_myobject.modules.php.
References $object, getDolGlobalInt(), and pdf_pagefoot().
Referenced by write_file().
|
protected |
Show top header of page.
TCPDF | TCPDI | Object PDF | |
MyObject | $object | Object to show |
int<0,1> | $showaddress 0=no, 1=yes | |
Translate | $outputlangs | Object lang for output |
?Translate | $outputlangsbis | Object lang for output bis |
Definition at line 924 of file pdf_standard_myobject.modules.php.
References $object, dol_escape_htmltag(), dol_print_date(), dol_trunc(), getDolGlobalInt(), getDolGlobalString(), getMultidirOutput(), pdf_build_address(), pdf_getHeightForLogo(), pdf_getPDFFontSize(), pdf_pagehead(), pdf_watermark(), pdf_writeLinkedObjects(), and pdfBuildThirdpartyName().
Referenced by write_file().
|
protected |
Show table for lines.
TCPDF | TCPDI | Object PDF | |
int | $tab_top | Top position of table |
int | $tab_height | Height of table (rectangle) |
int | $nexY | Y (not used) |
Translate | $outputlangs | Langs object |
int<-1,1> | $hidetop 1=Hide top bar of array and title, 0=Hide nothing, -1=Hide only title | |
int<0,1> | $hidebottom Hide bottom bar of array | |
string | $currency | Currency code |
?Translate | $outputlangsbis | Langs object bis |
Definition at line 867 of file pdf_standard_myobject.modules.php.
References getDolGlobalInt(), getDolGlobalString(), pdf_getPDFFontSize(), CommonDocGenerator\pdfTabTitles(), and CommonDocGenerator\printRect().
Referenced by write_file().
pdf_standard_myobject::defineColumnField | ( | $object, | |
$outputlangs, | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0 ) |
Define Array Column Field.
CommonObject | $object | common object |
Translate | $outputlangs | langs |
int<0,1> | $hidedetails Do not show line details | |
int<0,1> | $hidedesc Do not show desc | |
int<0,1> | $hideref Do not show ref |
Reimplemented from CommonDocGenerator.
Definition at line 1217 of file pdf_standard_myobject.modules.php.
References $object, CommonDocGenerator\defineColumnExtrafield(), getDolGlobalInt(), and setEventMessages().
|
static |
Return list of active generation modules.
Reimplemented from ModelePDFMyObject.
Definition at line 846 of file pdf_standard_myobject.modules.php.
pdf_standard_myobject::write_file | ( | $object, | |
$outputlangs, | |||
$srctemplatepath = '', | |||
$hidedetails = 0, | |||
$hidedesc = 0, | |||
$hideref = 0 ) |
Function to build and write pdf to disk.
MyObject | $object | Source object to generate document from |
Translate | $outputlangs | Lang output object |
string | $srctemplatepath | Full path of source filename for generator using a template file |
int<0,1> | $hidedetails Do not show line details | |
int<0,1> | $hidedesc Do not show desc | |
int<0,1> | $hideref Do not show ref |
Reimplemented from ModelePDFMyObject.
Definition at line 170 of file pdf_standard_myobject.modules.php.
References $object, _pagefoot(), _pagehead(), _tableau(), complete_substitutions_array(), convertBackOfficeMediasLinksToPublicLinks(), dol_concatdesc(), dol_htmlentitiesbr(), dol_mkdir(), dol_sanitizeFileName(), dol_syslog(), dolChmod(), CommonDocGenerator\getColumnStatus(), getCountry(), getDolGlobalInt(), getDolGlobalString(), CommonDocGenerator\getExtrafieldContent(), getLocalTaxesFromRate(), getMultidirOutput(), make_substitutions(), pdf_getInstance(), pdf_getlineqty(), pdf_getPDFFont(), pdf_getPDFFontSize(), pdf_getSubstitutionArray(), CommonDocGenerator\pdfTabTitles(), CommonDocGenerator\prepareArrayColumnField(), CommonDocGenerator\printColDescContent(), and CommonDocGenerator\printStdColumnContent().