DocumentInformation
in package
This is the DocumentInformation class, a macro class for the document viewHelper.
The purpose of this class is to encapsulate the logic that calculates the view parameters for the document's DocumentInformation.
Tags
Table of Contents
| TYPE_CORRECTIVE_INVOICE | = 'correctiveInvoice' | |
|---|---|---|
| TYPE_DELIVERY_NOTE | = 'deliveryNote' | |
| TYPE_INVOICE | = 'invoice' | |
| TYPE_ORDER | = 'order' | |
| TYPE_RETURN | = 'return' | |
| TYPE_RMA | = 'rma' | |
| $document | : AbstractDocumentBase|null | |
| $documentType | : string | |
| $showAuthNumber | : bool | |
| $showTransactionId | : bool | |
| __construct() | Constructor method for DocumentInformation class. | : mixed |
| getViewParameters() | This method returns all calculated arguments and new parameters for DocumentViewHelper.php | : array<string|int, mixed> |
| getProperties() | Return macro use properties | : array<string|int, mixed> |
Constants
TYPE_CORRECTIVE_INVOICE
public
mixed
TYPE_CORRECTIVE_INVOICE
= 'correctiveInvoice'
TYPE_DELIVERY_NOTE
public
mixed
TYPE_DELIVERY_NOTE
= 'deliveryNote'
TYPE_INVOICE
public
mixed
TYPE_INVOICE
= 'invoice'
TYPE_ORDER
public
mixed
TYPE_ORDER
= 'order'
TYPE_RETURN
public
mixed
TYPE_RETURN
= 'return'
TYPE_RMA
public
mixed
TYPE_RMA
= 'rma'
Properties
$document
public
AbstractDocumentBase|null
$document
= null
$documentType
public
string
$documentType
= self::TYPE_ORDER
$showAuthNumber
public
bool
$showAuthNumber
= false
$showTransactionId
public
bool
$showTransactionId
= false
Methods
__construct()
Constructor method for DocumentInformation class.
public
__construct(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
Tags
Return values
mixed —getViewParameters()
This method returns all calculated arguments and new parameters for DocumentViewHelper.php
public
getViewParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperties()
Return macro use properties
protected
getProperties() : array<string|int, mixed>