Orders
in package
This is the Orders class, a macro class for the userViewHelper.
The purpose of this class is to encapsulate the logic that calculates the view parameters for the user's orders.
Tags
Table of Contents
| ACTION_DELIVERY_NOTE | = 'deliveryNote' | |
|---|---|---|
| ACTION_DELIVERY_NOTE_PDF | = 'deliveryNotePDF' | |
| ACTION_INVOICE | = 'invoice' | |
| ACTION_INVOICE_PDF | = 'invoicePDF' | |
| ACTION_RECOVER | = 'recover' | |
| ACTION_RETURN | = 'return' | |
| ACTION_RETURN_TRACING | = 'returnTracing' | |
| ACTION_VIEW | = 'view' | |
| ACTION_VIEW_PDF | = 'viewPdf' | |
| POPUP | = 'popup' | |
| SHOW_STATUS_ALL | = 'showStatusAll' | |
| SHOW_STATUS_ONLY | = 'showStatusOnly' | |
| SHOW_STATUS_PRIORITY_SUBSTATUS | = 'showStatusPrioritySubstatus' | |
| WINDOW | = 'window' | |
| $documentView | : string | |
| $orders | : ElementCollection|null | |
| $returnProductsView | : string | |
| $returnTracingView | : string | |
| $showOrderActions | : array<string|int, mixed> | |
| $showOrderIcons | : array<string|int, mixed> | |
| $showOrderStates | : array<string|int, mixed> | |
| $showStatus | : string | |
| $userId | : int | |
| __construct() | Constructor method for Orders. | : mixed |
| getViewParameters() | This method returns all calculated arguments and new parameters for UserViewHelper.php | : array<string|int, mixed> |
| getProperties() | Return macro use properties | : array<string|int, mixed> |
Constants
ACTION_DELIVERY_NOTE
public
mixed
ACTION_DELIVERY_NOTE
= 'deliveryNote'
ACTION_DELIVERY_NOTE_PDF
public
mixed
ACTION_DELIVERY_NOTE_PDF
= 'deliveryNotePDF'
ACTION_INVOICE
public
mixed
ACTION_INVOICE
= 'invoice'
ACTION_INVOICE_PDF
public
mixed
ACTION_INVOICE_PDF
= 'invoicePDF'
ACTION_RECOVER
public
mixed
ACTION_RECOVER
= 'recover'
ACTION_RETURN
public
mixed
ACTION_RETURN
= 'return'
ACTION_RETURN_TRACING
public
mixed
ACTION_RETURN_TRACING
= 'returnTracing'
ACTION_VIEW
public
mixed
ACTION_VIEW
= 'view'
ACTION_VIEW_PDF
public
mixed
ACTION_VIEW_PDF
= 'viewPdf'
POPUP
public
mixed
POPUP
= 'popup'
SHOW_STATUS_ALL
public
mixed
SHOW_STATUS_ALL
= 'showStatusAll'
SHOW_STATUS_ONLY
public
mixed
SHOW_STATUS_ONLY
= 'showStatusOnly'
SHOW_STATUS_PRIORITY_SUBSTATUS
public
mixed
SHOW_STATUS_PRIORITY_SUBSTATUS
= 'showStatusPrioritySubstatus'
WINDOW
public
mixed
WINDOW
= 'window'
Properties
$documentView
public
string
$documentView
= self::POPUP
$orders
public
ElementCollection|null
$orders
= null
$returnProductsView
public
string
$returnProductsView
= self::POPUP
$returnTracingView
public
string
$returnTracingView
= self::POPUP
$showOrderActions
public
array<string|int, mixed>
$showOrderActions
= []
$showOrderIcons
public
array<string|int, mixed>
$showOrderIcons
= []
$showOrderStates
public
array<string|int, mixed>
$showOrderStates
= []
$showStatus
public
string
$showStatus
= self::SHOW_STATUS_ALL
$userId
public
int
$userId
= 0
Methods
__construct()
Constructor method for Orders.
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 UserViewHelper.php
public
getViewParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperties()
Return macro use properties
protected
getProperties() : array<string|int, mixed>