Class Mage_Sales_Model_Order_Pdf_Abstract

Sales Order PDF abstract model

Varien_Object

Mage_Sales_Model_Order_Pdf_Abstract

Direct known subclasses

Mage_Sales_Model_Order_Pdf_Creditmemo, Mage_Sales_Model_Order_Pdf_Invoice, Mage_Sales_Model_Order_Pdf_Shipment, Mage_Sales_Model_Order_Pdf_Shipment_Packaging

Abstract
Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order/Pdf/Abstract.php

Methods summary
`abstract public Zend_Pdf`	# `getPdf( )` Retrieve PDF Retrieve PDF Returns `Zend_Pdf`
`public float`	# `widthForStringUsingFontSize( string $string, Zend_Pdf_Resource_Font $font, float $fontSize )` Returns the total width in points of the string using the specified font and size. Returns the total width in points of the string using the specified font and size. This is not the most efficient way to perform this calculation. I'm concentrating optimization efforts on the upcoming layout manager class. Similar calculations exist inside the layout manager class, but widths are generally calculated only after determining line fragments. Parameters `$string` `string` $string `$font` `Zend_Pdf_Resource_Font` $font `$fontSize` `float` $fontSize Font size in points Returns `float`
`public integer`	# `getAlignRight( string $string, integer $x, integer $columnWidth, Zend_Pdf_Resource_Font $font, integer $fontSize, integer $padding = 5 )` Calculate coordinates to draw something in a column aligned to the right Calculate coordinates to draw something in a column aligned to the right Parameters `$string` `string` $string `$x` `integer` $x `$columnWidth` `integer` $columnWidth `$font` `Zend_Pdf_Resource_Font` $font `$fontSize` `integer` $fontSize `$padding` `integer` $padding Returns `integer`
`public integer`	# `getAlignCenter( string $string, integer $x, integer $columnWidth, Zend_Pdf_Resource_Font $font, integer $fontSize )` Calculate coordinates to draw something in a column aligned to the center Calculate coordinates to draw something in a column aligned to the center Parameters `$string` `string` $string `$x` `integer` $x `$columnWidth` `integer` $columnWidth `$font` `Zend_Pdf_Resource_Font` $font `$fontSize` `integer` $fontSize Returns `integer`
`protected`	# `insertLogo( Zend_Pdf_Page & $page, null $store = null )` Insert logo to pdf page Insert logo to pdf page Parameters `$page` `Zend_Pdf_Page` $page `$store` `null` $store
`protected`	# `insertAddress( Zend_Pdf_Page & $page, null $store = null )` Insert address to pdf page Insert address to pdf page Parameters `$page` `Zend_Pdf_Page` $page `$store` `null` $store
`protected array`	# `_formatAddress( string $address )` Format address Format address Parameters `$address` `string` $address Returns `array`
`protected integer`	# `_calcAddressHeight( array $address )` Calculate address height Calculate address height Parameters `$address` `array` $address Returns `integer` Height
`protected`	# `insertOrder( Zend_Pdf_Page & $page, Mage_Sales_Model_Order $obj, boolean $putOrderId = true )` Insert order to pdf page Insert order to pdf page Parameters `$page` `Zend_Pdf_Page` $page `$obj` `Mage_Sales_Model_Order` $obj `$putOrderId` `boolean` $putOrderId
`public`	# `insertDocumentNumber( Zend_Pdf_Page $page, string $text )` Insert title and number for concrete document type Insert title and number for concrete document type Parameters `$page` `Zend_Pdf_Page` $page `$text` `string` $text
`protected integer`	# `_sortTotalsList( array $a, array $b )` Sort totals list Sort totals list Parameters `$a` `array` $a `$b` `array` $b Returns `integer`
`protected array`	# `_getTotalsList( Mage_Sales_Model_Abstract $source )` Return total list Return total list Parameters `$source` `Mage_Sales_Model_Abstract` $source Returns `array`
`protected Zend_Pdf_Page`	# `insertTotals( Zend_Pdf_Page $page, Mage_Sales_Model_Abstract $source )` Insert totals to pdf page Insert totals to pdf page Parameters `$page` `Zend_Pdf_Page` $page `$source` `Mage_Sales_Model_Abstract` $source Returns `Zend_Pdf_Page`
`protected array`	# `_parseItemDescription( Varien_Object $item )` Parse item description Parse item description Parameters `$item` `Varien_Object` $item Returns `array`
`protected`	# `_beforeGetPdf( )` Before getPdf processing Before getPdf processing
`protected`	# `_afterGetPdf( )` After getPdf processing After getPdf processing
`protected string`	# `_formatOptionValue( array\|string $value, Mage_Sales_Model_Order $order )` Format option value process Format option value process Parameters `$value` `array\|string` $value `$order` `Mage_Sales_Model_Order` $order Returns `string`
`protected`	# `_initRenderer( string $type )` Initialize renderer process Initialize renderer process Parameters `$type` `string` $type
`protected Mage_Sales_Model_Order_Pdf_Items_Abstract`	# `_getRenderer( string $type )` Retrieve renderer model Retrieve renderer model Parameters `$type` `string` $type Returns `Mage_Sales_Model_Order_Pdf_Items_Abstract` Throws `Mage_Core_Exception`
`public Mage_Sales_Model_Order_Pdf_Items_Abstract`	# `getRenderer( string $type )` Public method of protected @see _getRenderer() Public method of protected @see _getRenderer() Retrieve renderer model Parameters `$type` `string` $type Returns `Mage_Sales_Model_Order_Pdf_Items_Abstract`
`protected Zend_Pdf_Page`	# `_drawItem( Varien_Object $item, Zend_Pdf_Page $page, Mage_Sales_Model_Order $order )` Draw Item process Draw Item process Parameters `$item` `Varien_Object` $item `$page` `Zend_Pdf_Page` $page `$order` `Mage_Sales_Model_Order` $order Returns `Zend_Pdf_Page`
`protected Zend_Pdf_Resource_Font`	# `_setFontRegular( Zend_Pdf_Page $object, integer $size = 7 )` Set font as regular Set font as regular Parameters `$object` `Zend_Pdf_Page` $object `$size` `integer` $size Returns `Zend_Pdf_Resource_Font`
`protected Zend_Pdf_Resource_Font`	# `_setFontBold( Zend_Pdf_Page $object, integer $size = 7 )` Set font as bold Set font as bold Parameters `$object` `Zend_Pdf_Page` $object `$size` `integer` $size Returns `Zend_Pdf_Resource_Font`
`protected Zend_Pdf_Resource_Font`	# `_setFontItalic( Zend_Pdf_Page $object, integer $size = 7 )` Set font as italic Set font as italic Parameters `$object` `Zend_Pdf_Page` $object `$size` `integer` $size Returns `Zend_Pdf_Resource_Font`
`protected Mage_Sales_Model_Order_Pdf_Abstract`	# `_setPdf( Zend_Pdf $pdf )` Set PDF object Set PDF object Parameters `$pdf` `Zend_Pdf` $pdf Returns `Mage_Sales_Model_Order_Pdf_Abstract`
`protected Zend_Pdf`	# `_getPdf( )` Retrieve PDF object Retrieve PDF object Returns `Zend_Pdf` Throws `Mage_Core_Exception`
`public Zend_Pdf_Page`	# `newPage( array $settings = array() )` Create new page and assign to PDF object Create new page and assign to PDF object Parameters `$settings` `array` $settings Returns `Zend_Pdf_Page`
`public Zend_Pdf_Page`	# `drawLineBlocks( Zend_Pdf_Page $page, array $draw, array $pageSettings = array() )` Draw lines Draw lines draw items array format: lines array;array of line blocks (required) shift int; full line height (optional) height int;line spacing (default 10) line block has line columns array column array format text string\|array; draw text (required) feed int; x position (required) font string; font style, optional: bold, italic, regular font_file string; path to font file (optional for use your custom font) font_size int; font size (default 7) align string; text align (also see feed parametr), optional left, right height int;line spacing (default 10) Parameters `$page` `Zend_Pdf_Page` $page `$draw` `array` $draw `$pageSettings` `array` $pageSettings Returns `Zend_Pdf_Page` Throws `Mage_Core_Exception`

Constants summary
`string`	`XML_PATH_SALES_PDF_INVOICE_PUT_ORDER_ID`	`'sales_pdf/invoice/put_order_id'`	# Predefined constants Predefined constants
`string`	`XML_PATH_SALES_PDF_SHIPMENT_PUT_ORDER_ID`	`'sales_pdf/shipment/put_order_id'`	#
`string`	`XML_PATH_SALES_PDF_CREDITMEMO_PUT_ORDER_ID`	`'sales_pdf/creditmemo/put_order_id'`	#

Properties summary
`public integer`	`$y`		# Y coordinate Y coordinate
`protected array`	`$_renderers`	`array()`	# Item renderers with render type key Item renderers with render type key model => the model name renderer => the renderer model
`protected Zend_Pdf`	`$_pdf`		# Zend PDF object Zend PDF object
`protected string`	`$_defaultTotalModel`	`'sales/order_pdf_total_default'`	# Default total model Default total model

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Pdf_Abstract

Direct known subclasses

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws