ShipmentNotDeducted extends LogMessage implements HasShipmentDetailsContentBlock, HasDeliveryMethodContentBlock uses HasShipmentDetailsContentBlock, HasDeliveryMethodContentBlock
Table of Contents
Interfaces
Methods
- __construct() : mixed
- canUseColorSelector() : bool
- getAdditionalIconButton() : IconButton|null
- Additional icon-like button in footer
- getAuthorId() : int|null
- Get item created by identifier
- getBackgroundColorToken() : string
- Get code of icon background color
- getButtons() : array<string|int, Button>|null
- Get footer buttons
- getChangeStreamButton() : ChangeStreamButton|null
- Change stream button used to change item stream: Scheduled -> History or History <--> Fixed history
- getColor() : array<string|int, mixed>|null
- getCommonContentBlocksBlocks() : array<string|int, mixed>
- getContentBlocks() : array<string|int, ContentBlock>|null
- Get item content blocks
- getContext() : Context
- getCounterType() : string|null
- If necessary to show counter near icon, method will return type of the counter
- getDate() : DateTime|null
- Get item header date.
- getDatePlaceholder() : string|null
- Placeholder for cases when date is empty
- getDeliveryMethodContentBlock() : LineOfTextBlocks
- getIcon() : Icon|null
- Icon of timeline record
- getIconBackgroundColor() : string|null
- getIconCode() : string|null
- Code of item icon
- getInfoHelper() : InfoHelper|null
- Hint icon in item header
- getLayout() : Layout
- getLogo() : Logo|null
- Get item logotype
- getMarketPanel() : MarketPanel|null
- getMenuItems() : array<string|int, MenuItem>|null
- Get footer context menu items
- getModel() : Model
- getNoteItemId() : int
- getNoteItemType() : int
- getPayload() : Payload|null
- getShipmentDetailsContentBlock() : LineOfTextBlocks
- getSort() : array<string|int, mixed>
- getTags() : array<string|int, Tag>|null
- Get header tags
- getTitle() : string|null
- Get item title
- getTitleAction() : Action|null
- Get item title onClick action
- getType() : string
- String type identifier of item
- isActive() : bool
- Checks item status.
- isLogMessage() : bool
- Is item a log message.
- isScheduled() : bool
- jsonSerialize() : array<string|int, mixed>
- needShowNotes() : bool
- Can notes block be shown
- needShowRestAppLayoutBlocks() : bool
Methods
__construct()
public
__construct(Context $context, Model $model) : mixed
Parameters
canUseColorSelector()
public
canUseColorSelector() : bool
Return values
boolgetAdditionalIconButton()
Additional icon-like button in footer
public
getAdditionalIconButton() : IconButton|null
Return values
IconButton|nullgetAuthorId()
Get item created by identifier
public
getAuthorId() : int|null
Return values
int|nullgetBackgroundColorToken()
Get code of icon background color
public
getBackgroundColorToken() : string
Return values
stringgetButtons()
Get footer buttons
public
getButtons() : array<string|int, Button>|null
Return values
array<string|int, Button>|nullgetChangeStreamButton()
Change stream button used to change item stream: Scheduled -> History or History <--> Fixed history
public
getChangeStreamButton() : ChangeStreamButton|null
Return values
ChangeStreamButton|nullgetColor()
public
getColor() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetCommonContentBlocksBlocks()
public
getCommonContentBlocksBlocks() : array<string|int, mixed>
Return values
array<string|int, mixed>getContentBlocks()
Get item content blocks
public
getContentBlocks() : array<string|int, ContentBlock>|null
Return values
array<string|int, ContentBlock>|nullgetContext()
public
getContext() : Context
Return values
ContextgetCounterType()
If necessary to show counter near icon, method will return type of the counter
public
getCounterType() : string|null
Return values
string|nullgetDate()
Get item header date.
public
getDate() : DateTime|null
Return values
DateTime|nullgetDatePlaceholder()
Placeholder for cases when date is empty
public
getDatePlaceholder() : string|null
Return values
string|nullgetDeliveryMethodContentBlock()
public
getDeliveryMethodContentBlock() : LineOfTextBlocks
Return values
LineOfTextBlocksgetIcon()
Icon of timeline record
public
getIcon() : Icon|null
Return values
Icon|nullgetIconBackgroundColor()
public
getIconBackgroundColor() : string|null
Return values
string|nullgetIconCode()
Code of item icon
public
getIconCode() : string|null
Return values
string|nullgetInfoHelper()
Hint icon in item header
public
getInfoHelper() : InfoHelper|null
Return values
InfoHelper|nullgetLayout()
public
getLayout() : Layout
Return values
LayoutgetLogo()
Get item logotype
public
getLogo() : Logo|null
Return values
Logo|nullgetMarketPanel()
public
getMarketPanel() : MarketPanel|null
Return values
MarketPanel|nullgetMenuItems()
Get footer context menu items
public
getMenuItems() : array<string|int, MenuItem>|null
Return values
array<string|int, MenuItem>|nullgetModel()
public
abstract getModel() : Model
Return values
ModelgetNoteItemId()
public
getNoteItemId() : int
Return values
intgetNoteItemType()
public
getNoteItemType() : int
Return values
intgetPayload()
public
getPayload() : Payload|null
Return values
Payload|nullgetShipmentDetailsContentBlock()
public
getShipmentDetailsContentBlock() : LineOfTextBlocks
Return values
LineOfTextBlocksgetSort()
public
getSort() : array<string|int, mixed>
Return values
array<string|int, mixed>getTags()
Get header tags
public
getTags() : array<string|int, Tag>|null
Return values
array<string|int, Tag>|nullgetTitle()
Get item title
public
getTitle() : string|null
Return values
string|nullgetTitleAction()
Get item title onClick action
public
getTitleAction() : Action|null
Return values
Action|nullgetType()
String type identifier of item
public
getType() : string
Return values
stringisActive()
Checks item status.
public
static isActive() : bool
Return values
boolisLogMessage()
Is item a log message.
public
isLogMessage() : bool
Log messages have their own representation
Return values
boolisScheduled()
public
isScheduled() : bool
Return values
booljsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>needShowNotes()
Can notes block be shown
public
needShowNotes() : bool
Return values
boolneedShowRestAppLayoutBlocks()
public
needShowRestAppLayoutBlocks() : bool