Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Protected Member Functions | Protected Attributes
Invoice Class Reference
Inheritance diagram for Invoice:
AbstractItems Template AbstractBlock DataObject BlockInterface

Public Member Functions

 __construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Framework\Registry $registry, \Magento\Payment\Helper\Data $paymentHelper, \Magento\Sales\Model\Order\Address\Renderer $addressRenderer, array $data=[])
 
 getBackUrl ()
 
 getPrintUrl ()
 
 getPaymentInfoHtml ()
 
 getOrder ()
 
 getInvoice ()
 
 getInvoiceTotalsHtml ($invoice)
 
 formatAddress (\Magento\Sales\Model\Order\Address $address, $format)
 
- Public Member Functions inherited from AbstractItems
 getItemHtml (\Magento\Framework\DataObject $item)
 
- Public Member Functions inherited from Template
 __construct (Template\Context $context, array $data=[])
 
 setTemplateContext ($templateContext)
 
 getTemplate ()
 
 setTemplate ($template)
 
 getTemplateFile ($template=null)
 
 getArea ()
 
 assign ($key, $value=null)
 
 fetchView ($fileName)
 
 getBaseUrl ()
 
 getObjectData (\Magento\Framework\DataObject $object, $key)
 
 getCacheKeyInfo ()
 
- Public Member Functions inherited from AbstractBlock
 __construct (\Magento\Framework\View\Element\Context $context, array $data=[])
 
 getJsLayout ()
 
 getRequest ()
 
 getParentBlock ()
 
 setLayout (\Magento\Framework\View\LayoutInterface $layout)
 
 getLayout ()
 
 setNameInLayout ($name)
 
 getChildNames ()
 
 setAttribute ($name, $value=null)
 
 setChild ($alias, $block)
 
 addChild ($alias, $block, $data=[])
 
 unsetChild ($alias)
 
 unsetCallChild ($alias, $callback, $result, $params)
 
 unsetChildren ()
 
 getChildBlock ($alias)
 
 getChildHtml ($alias='', $useCache=true)
 
 getChildChildHtml ($alias, $childChildAlias='', $useCache=true)
 
 getBlockHtml ($name)
 
 insert ($element, $siblingName=0, $after=true, $alias='')
 
 append ($element, $alias='')
 
 getGroupChildNames ($groupName)
 
 getChildData ($alias, $key='')
 
 getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
 
 getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)
 
 getUrl ($route='', $params=[])
 
 getViewFileUrl ($fileId, array $params=[])
 
 formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)
 
 formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)
 
 getModuleName ()
 
 escapeHtml ($data, $allowedTags=null)
 
 escapeJs ($string)
 
 escapeHtmlAttr ($string, $escapeSingleQuote=true)
 
 escapeCss ($string)
 
 stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)
 
 escapeUrl ($string)
 
 escapeXssInUrl ($data)
 
 escapeQuote ($data, $addSlashes=false)
 
 escapeJsQuote ($data, $quote='\'')
 
 getNameInLayout ()
 
 getCacheKeyInfo ()
 
 getCacheKey ()
 
 getVar ($name, $module=null)
 
 isScopePrivate ()
 
- Public Member Functions inherited from DataObject
 __construct (array $data=[])
 
 addData (array $arr)
 
 setData ($key, $value=null)
 
 unsetData ($key=null)
 
 getData ($key='', $index=null)
 
 getDataByPath ($path)
 
 getDataByKey ($key)
 
 setDataUsingMethod ($key, $args=[])
 
 getDataUsingMethod ($key, $args=null)
 
 hasData ($key='')
 
 toArray (array $keys=[])
 
 convertToArray (array $keys=[])
 
 toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
 
 toJson (array $keys=[])
 
 convertToJson (array $keys=[])
 
 toString ($format='')
 
 __call ($method, $args)
 
 isEmpty ()
 
 serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
 
 debug ($data=null, &$objects=[])
 
 offsetSet ($offset, $value)
 
 offsetExists ($offset)
 
 offsetUnset ($offset)
 
 offsetGet ($offset)
 
- Public Member Functions inherited from BlockInterface
 toHtml ()
 

Protected Member Functions

 _prepareLayout ()
 
 _prepareItem (AbstractBlock $renderer)
 
- Protected Member Functions inherited from AbstractItems
 _prepareItem (\Magento\Framework\View\Element\AbstractBlock $renderer)
 
 _getItemType (\Magento\Framework\DataObject $item)
 
- Protected Member Functions inherited from Template
 _construct ()
 
 _toHtml ()
 
 getRootDirectory ()
 
 getMediaDirectory ()
 
- Protected Member Functions inherited from AbstractBlock
 _construct ()
 
 _prepareLayout ()
 
 _beforeToHtml ()
 
 _afterToHtml ($html)
 
 _toHtml ()
 
 _getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])
 
 getCacheTags ()
 
 getCacheLifetime ()
 
 _loadCache ()
 
 _saveCache ($data)
 
 _getSidPlaceholder ($cacheKey=null)
 
- Protected Member Functions inherited from DataObject
 _getData ($key)
 
 _underscore ($name)
 

Protected Attributes

 $_coreRegistry = null
 
 $_paymentHelper
 
 $addressRenderer
 
- Protected Attributes inherited from Template
 $_viewVars = []
 
 $_baseUrl
 
 $_jsUrl
 
 $_allowSymlinks
 
 $_filesystem
 
 $_template
 
 $templateEnginePool
 
 $_storeManager
 
 $_appState
 
 $directory
 
 $templateContext
 
 $pageConfig
 
 $resolver
 
 $validator
 
- Protected Attributes inherited from AbstractBlock
 $_design
 
 $_session
 
 $_sidResolver
 
 $_nameInLayout
 
 $_layout
 
 $jsLayout = []
 
 $_request
 
 $_urlBuilder
 
 $_eventManager
 
 $_frontController
 
 $_assetRepo
 
 $_viewConfig
 
 $_cacheState
 
 $_logger
 
 $_escaper
 
 $filterManager
 
 $_localeDate
 
 $inlineTranslation
 
 $_isScopePrivate = false
 
 $_scopeConfig
 
 $_cache
 
- Protected Attributes inherited from DataObject
 $_data = []
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractBlock
static extractModuleName ($className)
 
- Data Fields inherited from AbstractItems
const DEFAULT_TYPE = 'default'
 
- Data Fields inherited from Template
const XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'
 
- Data Fields inherited from AbstractBlock
const CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER
 
const CACHE_KEY_PREFIX = 'BLOCK_'
 
- Static Protected Attributes inherited from DataObject
static $_underscoreCache = []
 

Detailed Description

Sales order details block

@api

Since
100.0.2

Definition at line 16 of file Invoice.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\View\Element\Template\Context  $context,
\Magento\Framework\Registry  $registry,
\Magento\Payment\Helper\Data  $paymentHelper,
\Magento\Sales\Model\Order\Address\Renderer  $addressRenderer,
array  $data = [] 
)
Parameters
\Magento\Framework\View\Element\Template\Context$context
\Magento\Framework\Registry$registry
\Magento\Payment\Helper\Data$paymentHelper
\Magento\Sales\Model\Order\Address\Renderer$addressRenderer
array$data

Definition at line 42 of file Invoice.php.

48  {
49  $this->addressRenderer = $addressRenderer;
50  $this->_paymentHelper = $paymentHelper;
51  $this->_coreRegistry = $registry;
52  parent::__construct($context, $data);
53  }

Member Function Documentation

◆ _prepareItem()

_prepareItem ( AbstractBlock  $renderer)
protected
Parameters
AbstractBlock$renderer
Returns
$this

Definition at line 109 of file Invoice.php.

110  {
111  $renderer->setPrintStatus(true);
112  return parent::_prepareItem($renderer);
113  }

◆ _prepareLayout()

_prepareLayout ( )
protected
Returns
void

Definition at line 58 of file Invoice.php.

59  {
60  $this->pageConfig->getTitle()->set(__('Order # %1', $this->getOrder()->getRealOrderId()));
61  $infoBlock = $this->_paymentHelper->getInfoBlock($this->getOrder()->getPayment(), $this->getLayout());
62  $this->setChild('payment_info', $infoBlock);
63  }
__()
Definition: __.php:13

◆ formatAddress()

formatAddress ( \Magento\Sales\Model\Order\Address  $address,
  $format 
)

Formats order address to html, pdf and etc. formats

Parameters
\Magento\Sales\Model\Order\Address$address
string$format
Returns
null|string

Definition at line 139 of file Invoice.php.

140  {
141  return $this->addressRenderer->format($address, $format);
142  }
$address
Definition: customer.php:38
$format
Definition: list.phtml:12

◆ getBackUrl()

getBackUrl ( )
Returns
string

Definition at line 68 of file Invoice.php.

69  {
70  return $this->getUrl('*/*/history');
71  }

◆ getInvoice()

getInvoice ( )
Returns
array|null

Definition at line 100 of file Invoice.php.

101  {
102  return $this->_coreRegistry->registry('current_invoice');
103  }

◆ getInvoiceTotalsHtml()

getInvoiceTotalsHtml (   $invoice)

Get html of invoice totals block

Parameters
\Magento\Sales\Model\Order\Invoice$invoice
Returns
string

Definition at line 121 of file Invoice.php.

122  {
123  $html = '';
124  $totals = $this->getChildBlock('invoice_totals');
125  if ($totals) {
126  $totals->setInvoice($invoice);
127  $html = $totals->toHtml();
128  }
129  return $html;
130  }
$totals
Definition: totalbar.phtml:10
$invoice

◆ getOrder()

getOrder ( )
Returns
array|null

Definition at line 92 of file Invoice.php.

93  {
94  return $this->_coreRegistry->registry('current_order');
95  }

◆ getPaymentInfoHtml()

getPaymentInfoHtml ( )
Returns
string

Definition at line 84 of file Invoice.php.

85  {
86  return $this->getChildHtml('payment_info');
87  }

◆ getPrintUrl()

getPrintUrl ( )
Returns
string

Definition at line 76 of file Invoice.php.

77  {
78  return $this->getUrl('*/*/print');
79  }

Field Documentation

◆ $_coreRegistry

$_coreRegistry = null
protected

Definition at line 23 of file Invoice.php.

◆ $_paymentHelper

$_paymentHelper
protected

Definition at line 28 of file Invoice.php.

◆ $addressRenderer

$addressRenderer
protected

Definition at line 33 of file Invoice.php.


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