Blesta
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • blesta
    • app
      • components
        • events
          • default
      • controllers
      • models
    • components
      • auth
      • delivery
        • interfax
        • postal
          • methods
      • download
      • email
      • exchange
        • rates
          • foxrate
          • google
            • finance
          • yahoo
            • finance
      • gateway
        • payments
      • gateways
      • invoice
        • delivery
        • templates
      • json
      • modules
      • net
        • http
        • net
          • amazon
            • s3
          • geo
            • ip
      • plugins
      • recaptcha
      • security
      • session
        • cart
      • settingscollection
      • upgrades
      • upload
      • vcard
    • helpers
      • currency
        • format
      • data
        • structure
          • array
          • string
      • text
        • parser
  • com
    • tecnick
      • tcpdf
        • blesta
          • components
            • invoice
              • templates
                • quickbooks
                  • invoice
                • templates
                  • default
  • Crypt
    • AES
    • DES
    • Hash
    • Random
    • RC4
    • Rijndael
    • RSA
    • TerraDES
  • File
    • ANSI
    • ASN1
    • X509
  • Math
    • BigInteger
  • minPHP
    • components
      • input
      • record
    • helpers
      • color
      • data
        • structure
      • date
      • html
      • xml
    • lib
  • Net
    • SFTP
    • SSH1
    • SSH2
  • None
  • PHP
  • PHPMailer
  • Services
    • JSON
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • QuickbooksInvoicePdf

Class QuickbooksInvoicePdf

This is a PHP class for generating PDF documents without requiring external extensions.
TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.

TCPDF
Extended by TcpdfWrapper
Extended by QuickbooksInvoicePdf
Package: com\tecnick\tcpdf\blesta\components\invoice\templates\quickbooks\invoice
Copyright: Copyright (c) 2010, Phillips Data, Inc.
License: LGPL
Author: Nicola Asuni - info@tecnick.com
Version: 4.9.004
Link: http://www.tcpdf.org
Located at components/invoice_templates/quickbooks_invoice/quickbooks_invoice_pdf.php

Methods summary

public
# __construct( string $orientation = 'P', string $unit = 'mm', mixed $format = 'A4', boolean $unicode = true, boolean $encoding = 'UTF-8', String $diskcache = false )

This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

Parameters

$orientation
string
$orientation page orientation. Possible values are (case insensitive):
  • P or Portrait (default)
  • L or Landscape
$unit
string
$unit User measure unit. Possible values are:
  • pt: point
  • mm: millimeter (default)
  • cm: centimeter
  • in: inch

A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
$format
mixed
$format The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).
  • 4A0
  • 2A0
  • A0
  • A1
  • A2
  • A3
  • A4 (default)
  • A5
  • A6
  • A7
  • A8
  • A9
  • A10
  • B0
  • B1
  • B2
  • B3
  • B4
  • B5
  • B6
  • B7
  • B8
  • B9
  • B10
  • C0
  • C1
  • C2
  • C3
  • C4
  • C5
  • C6
  • C7
  • C8
  • C9
  • C10
  • RA0
  • RA1
  • RA2
  • RA3
  • RA4
  • SRA0
  • SRA1
  • SRA2
  • SRA3
  • SRA4
  • LETTER
  • LEGAL
  • EXECUTIVE
  • FOLIO
$unicode
boolean
$unicode TRUE means that the input text is unicode (default = true)
$encoding
boolean
$diskcache if TRUE reduce the RAM memory usage by caching temporary data on filesystem (slower).
$diskcache
String
$encoding charset encoding; default is UTF-8

Since

1.0

Overrides

TCPDF::__construct
public
# Header( )

Overwrite the default header that appears on each page of the PDF

Overwrite the default header that appears on each page of the PDF

Overrides

TCPDF::Header
public
# Footer( )

Overwrite the default footer that appears on each page of the PDF

Overwrite the default footer that appears on each page of the PDF

Overrides

TCPDF::Footer
public
# drawInvoice( )

Draws a complete invoice

Draws a complete invoice

private
# drawPaidWatermark( )

Draws the paid text in the background of the invoice

Draws the paid text in the background of the invoice

private
# drawTallies( )

Renders public notes and invoice tallies onto the document

Renders public notes and invoice tallies onto the document

private
# drawBackground( )

Renders the background image onto the document

Renders the background image onto the document

private
# drawLogo( )

Renders the logo onto the document

Renders the logo onto the document

private
# drawInvoiceInfo( )

Renders the Invoice info section to the document, containing the invoice ID, client ID, date billed

Renders the Invoice info section to the document, containing the invoice ID, client ID, date billed

private
# drawInvoiceSubInfo( )

Renders the Invoice sub info section to the document, containing the date due

Renders the Invoice sub info section to the document, containing the date due

private
# drawLineHeader( )

Renders the line items table heading

Renders the line items table heading

private
# drawAddress( )

Renders the to address information

Renders the to address information

private
# drawReturnAddress( )

Renders the return address information including tax ID

Renders the return address information including tax ID

private
# drawInvoiceType( )

Sets the invoice type on the document based upon the status of the invoice

Sets the invoice type on the document based upon the status of the invoice

private
# drawPageNumber( )

Renders the page number to the document

Renders the page number to the document

private
# drawTerms( )

Renders the terms of this document

Renders the terms of this document

Methods inherited from TcpdfWrapper

drawTable()

Methods inherited from TCPDF

AcceptPageBreak(), AddFont(), AddLink(), AddPage(), AddSpotColor(), AliasNbPages(), AliasNumPage(), Annotation(), Arrow(), Bookmark(), Button(), Cell(), CheckBox(), Circle(), Clip(), Close(), ComboBox(), CoonsPatchMesh(), Curve(), Ellipse(), Error(), GetAbsX(), GetArrStringWidth(), GetCharWidth(), GetLineWidth(), GetNumChars(), GetStringWidth(), GetX(), GetY(), Gradient(), Image(), ImageEps(), ImagePngAlpha(), IncludeJS(), Line(), LinearGradient(), Link(), ListBox(), Ln(), MirrorH(), MirrorL(), MirrorP(), MirrorV(), MultiCell(), Open(), Output(), PageNo(), PageNoFormatted(), PieSector(), PolyLine(), Polycurve(), Polygon(), RadialGradient(), RadioButton(), Rect(), RegularPolygon(), Rotate(), RoundedRect(), Scale(), ScaleX(), ScaleXY(), ScaleY(), SetAuthor(), SetAutoPageBreak(), SetBooklet(), SetCellPadding(), SetCompression(), SetCreator(), SetDefaultMonospacedFont(), SetDisplayMode(), SetDrawColor(), SetDrawColorArray(), SetDrawSpotColor(), SetFillColor(), SetFillColorArray(), SetFillSpotColor(), SetFont(), SetFontSize(), SetKeywords(), SetLeftMargin(), SetLineStyle(), SetLineWidth(), SetLink(), SetMargins(), SetProtection(), SetRightMargin(), SetSubject(), SetTextColor(), SetTextColorArray(), SetTextSpotColor(), SetTitle(), SetTopMargin(), SetX(), SetXY(), SetY(), Skew(), SkewX(), SkewY(), StarPolygon(), StartTransform(), StopTransform(), Text(), TextField(), Transform(), Translate(), TranslateX(), TranslateY(), UTF8ArrSubString(), UTF8ArrToLatin1(), UTF8ArrayToUniArray(), UTF8StringToArray(), UTF8ToLatin1(), UTF8ToUTF16BE(), UniArrSubString(), Write(), _JScolor(), _Ovalue(), _RC4(), _Uvalue(), __destruct(), _addfield(), _beginpage(), _dataannobjstring(), _datastring(), _datestring(), _destroy(), _dochecks(), _dolinethrough(), _dolinethroughw(), _dounderline(), _dounderlinew(), _enddoc(), _endpage(), _escape(), _escapetext(), _freadint(), _generateencryptionkey(), _getfontpath(), _md5_16(), _newobj(), _objectkey(), _out(), _outCurve(), _outLine(), _outPoint(), _outRect(), _outarc(), _parsejpeg(), _parsepng(), _putAPXObject(), _putEmbeddedFiles(), _putannotsobjs(), _putannotsrefs(), _putbookmarks(), _putcatalog(), _putcidfont0(), _putencryption(), _putextgstates(), _putfonts(), _putfontwidths(), _putheader(), _putimages(), _putinfo(), _putjavascript(), _putocg(), _putpages(), _putresourcedict(), _putresources(), _putshaders(), _putsignature(), _putspotcolors(), _putstream(), _puttrailer(), _puttruetypeunicode(), _putviewerpreferences(), _putxobjectdict(), _textstring(), _toJPEG(), addExtGState(), addHTMLVertSpace(), addHtmlLink(), addJavascriptObject(), addTOC(), arrUTF8ToUTF16BE(), checkPageBreak(), closeHTMLTagHandler(), colorRegistrationBar(), commitTransaction(), convertHTMLColorToDec(), cropMark(), deletePage(), empty_string(), endPage(), formatPageNumber(), formatTOCPageNumber(), getAliasNbPages(), getAliasNumPage(), getAnnotOptFromJSProp(), getBarcode(), getBorderMode(), getBreakMargin(), getBuffer(), getCellCode(), getCellHeightRatio(), getFontAscent(), getFontBuffer(), getFontDescent(), getFontFamily(), getFontSize(), getFontSizePt(), getFontStyle(), getFontsList(), getFooterFont(), getFooterMargin(), getFormDefaultProp(), getGDgamma(), getGraphicVars(), getGroupPageNo(), getGroupPageNoFormatted(), getHTMLUnitToUnits(), getHeaderData(), getHeaderFont(), getHeaderMargin(), getHtmlDomArray(), getImageBuffer(), getImageFileType(), getImageRBX(), getImageRBY(), getImageScale(), getLastH(), getMargins(), getNumLines(), getNumPages(), getObjFilename(), getOriginalMargins(), getPDFData(), getPage(), getPageBuffer(), getPageDimensions(), getPageGroupAlias(), getPageHeight(), getPageNumGroupAlias(), getPageWidth(), getRTL(), getRemainingWidth(), getScaleFactor(), getSpaceString(), get_mqr(), intToRoman(), isRTLTextDir(), lastPage(), movePage(), objclone(), openHTMLTagHandler(), pixelsToUnits(), putHtmlListBullet(), readDiskCache(), registrationMark(), removeSHY(), revstrpos(), rfread(), rollbackTransaction(), selectColumn(), setAlpha(), setBarcode(), setBuffer(), setCellHeightRatio(), setColumnsArray(), setContentMark(), setDefaultTableColumns(), setEqualColumns(), setExtGState(), setFontBuffer(), setFontSubBuffer(), setFooter(), setFooterFont(), setFooterMargin(), setFormDefaultProp(), setGraphicVars(), setHeader(), setHeaderData(), setHeaderFont(), setHeaderMargin(), setHtmlLinksStyle(), setHtmlVSpace(), setImageBuffer(), setImageScale(), setImageSubBuffer(), setJPEGQuality(), setLIsymbol(), setLanguageArray(), setLastH(), setListIndentWidth(), setOpenCell(), setPDFVersion(), setPage(), setPageBuffer(), setPageFormat(), setPageMark(), setPageOrientation(), setPageUnit(), setPrintFooter(), setPrintHeader(), setRTL(), setSignature(), setSpacesRE(), setTableHeader(), setTempRTL(), setUserRights(), setViewerPreferences(), setVisibility(), set_mqr(), startPage(), startPageGroup(), startTransaction(), swapMargins(), unhtmlentities(), unichr(), utf8Bidi(), utf8StrArrRev(), utf8StrRev(), write1DBarcode(), write2DBarcode(), writeBarcode(), writeDiskCache(), writeHTML(), writeHTMLCell()

Magic methods summary

Properties summary

private static string $font_size
#

Holds the default font size for this document

Holds the default font size for this document

private static string $font_size_alt
#

Holds the alternate font size for this document

Holds the alternate font size for this document

private static string $font_size_alt2
#

Holds the second alternate font size for this document

Holds the second alternate font size for this document

private static string $font_size_alt3
#

Holds the third alternate font size for this document

Holds the third alternate font size for this document

private static string $font
#

The primary font family to use

The primary font family to use

private static string $font_bold
#

The bold font family to use

The bold font family to use

private static array $primary_color
#

An RGB representation of the primary color used throughout

An RGB representation of the primary color used throughout

private static array $primary_text_color
#

An RGB representation of the primary text color used throughout

An RGB representation of the primary text color used throughout

private static array $standard_num_options
#

The standard number format options

The standard number format options

public array $meta
#

An array of meta data for this invoice

An array of meta data for this invoice

public CurrencyFormat $CurrencyFormat
#

The CurrencyFormat object used to format currency values

The CurrencyFormat object used to format currency values

public array $invoice
#

An array of invoice data for this invoice

An array of invoice data for this invoice

private integer $header_end_y
#

The Y position where the header finishes its content

The Y position where the header finishes its content

private array $line_options
#

An array of line item options

An array of line item options

public boolean $include_address
#

Param

boolean
Whether to include the to address or not

Properties inherited from TCPDF

$AliasNbPages, $AliasNumPage, $AutoPageBreak, $ColorFlag, $CoreFonts, $CurOrientation, $CurrentFont, $DrawColor, $FillColor, $FontAscent, $FontDescent, $FontFamily, $FontFiles, $FontSize, $FontSizePt, $FontStyle, $HREF, $InFooter, $LayoutMode, $LineWidth, $OutlineRoot, $Ovalue, $PDFVersion, $PageAnnots, $PageBreakTrigger, $PageMode, $Pvalue, $TextColor, $Uvalue, $ZoomMode, $annot_obj_id, $annotation_fonts, $annots_start_obj_id, $apxo_obj_id, $apxo_start_obj_id, $author, $bMargin, $barcode, $bgcolor, $booklet, $buffer, $bufferlen, $byterange_string, $cMargin, $cache_UTF8StringToArray, $cache_file_length, $cache_maxsize_UTF8StringToArray, $cache_size_UTF8StringToArray, $cell_height_ratio, $cntmrk, $column_start_page, $columns, $compress, $creator, $curr_annot_obj_id, $current_column, $currpagegroup, $customlistindent, $default_form_prop, $default_monospaced_font, $default_table_columns, $diffs, $diskcache, $dpi, $embedded_start_obj_id, $embeddedfiles, $enc_obj_id, $encoding, $encrypted, $encryption_key, $endlinex, $epsmarker, $extgstates, $feps, $fgcolor, $fhPt, $font_obj_ids, $fontkeys, $fontlist, $fonts, $footer_font, $footer_margin, $footerlen, $footerpos, $form_action, $form_enctype, $form_mode, $form_obj_id, $fwPt, $gradients, $h, $hPt, $header_font, $header_logo, $header_logo_width, $header_margin, $header_string, $header_title, $htmlLinkColorArray, $htmlLinkFontStyle, $htmlvspace, $imagekeys, $images, $img_rb_x, $img_rb_y, $imgscale, $internal_encoding, $inthead, $intmrk, $isunicode, $javascript, $jpeg_quality, $js_obj_id, $js_objects, $js_start_obj_id, $k, $keywords, $l, $lMargin, $last_rc4_key, $last_rc4_key_c, $lasth, $linestyleCap, $linestyleDash, $linestyleJoin, $linestyleWidth, $linethrough, $links, $lispacer, $listcount, $listindent, $listnum, $listordered, $lisymbol, $n, $n_js, $n_ocg_print, $n_ocg_view, $newline, $newpagegroup, $num_columns, $numfonts, $numimages, $numpages, $objcopy, $offsets, $oldcMargin, $openMarkedContent, $opencell, $original_lMargin, $original_rMargin, $outlines, $padding, $page, $page_obj_id, $pagedim, $pagegroups, $pagelen, $pageopen, $pages, $premode, $print_footer, $print_header, $rMargin, $radio_groups, $radiobutton_groups, $re_spaces, $rtl, $sig_annot_ref, $sig_obj_id, $sign, $signature_data, $signature_max_length, $spot_colors, $start_transaction_page, $start_transaction_y, $state, $subject, $tMargin, $tagvspaces, $tempfontsize, $textindent, $thead, $theadMargins, $title, $tmprtl, $transfmatrix, $transfmatrix_key, $transfmrk, $underline, $ur, $ur_annots, $ur_document, $ur_form, $ur_signature, $viewer_preferences, $visibility, $w, $wPt, $x, $y

Blesta API documentation generated by ApiGen 2.8.0