ShipmentDocumentRealization extends ProductsDataProvider implements Nameable
Class ShipmentDocumentRealization
Table of Contents
Interfaces
- Nameable
Constants
- QR_CODE_FIELD_NAME = 'PAYMENT_QR_CODE'
Methods
- __construct() : mixed
- getAdditionalDocumentInfo() : array<string|int, mixed>
- getAddress() : string
- Get Primary Address (it used to be like this).
- getAnotherEmail() : array<string|int, mixed>
- getAnotherPhone() : array<string|int, mixed>
- getAssignedId() : int|string
- getBankDetailId() : int
- getClientEmail() : array<string|int, mixed>
- getClientId() : int|string
- getClientIm() : array<string|int, mixed>
- getClientName() : string
- getClientPhone() : array<string|int, mixed>
- getClientWeb() : array<string|int, mixed>
- getCommonFields() : array<string|int, mixed>
- getCompanyId() : int|null
- getContactId() : int|null
- getCrmOwnerType() : int
- getCurrencyId() : string
- getCurrencyName() : string
- getEmailCommunication() : array<string|int, mixed>
- getFields() : array<string|int, mixed>
- getHash() : string
- getHomeEmail() : array<string|int, mixed>
- getHomePhone() : array<string|int, mixed>
- getLangName() : mixed
- getLangPhrasesPath() : string
- getMobilePhone() : array<string|int, mixed>
- getMyCompanyEditUrl() : bool|string
- getMyCompanyId() : int|array<string|int, mixed>
- getMyCompanyProvider() : Company|null
- getNameFormat() : string
- getPaymentQrCode() : string|null
- getPrimaryAddress() : string
- getRegisteredAddress() : string
- getRequisiteId() : int|array<string|int, mixed>
- getSelfCompanyId() : int|string
- getSelfId() : int
- getStatus() : string|null
- getSumWithoutWords() : bool|mixed
- getTimelineItemIdentifier() : ItemIdentifier|null
- getTotalRows() : int
- getUserFields() : array<string|int, mixed>
- getUserFieldValue() : null
- getWorkEmail() : array<string|int, mixed>
- getWorkPhone() : array<string|int, mixed>
- hasAccess() : mixed
- isLoaded() : bool
- isRootProvider() : bool
- loadProducts() : array<string|int, Product>
- loadTaxes() : array<string|int, mixed>|array<string|int, Tax>|null
- onDocumentCreate() : mixed
- onDocumentDelete() : mixed
- onDocumentUpdate() : mixed
- onPublicView() : mixed
- prepareTransactionData() : TransactionData
Constants
QR_CODE_FIELD_NAME
public
mixed
QR_CODE_FIELD_NAME
= 'PAYMENT_QR_CODE'
Methods
__construct()
public
__construct(mixed $source[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $source : mixed
- $options : array<string|int, mixed> = []
getAdditionalDocumentInfo()
public
getAdditionalDocumentInfo(Document $document) : array<string|int, mixed>
Parameters
- $document : Document
Return values
array<string|int, mixed>getAddress()
Get Primary Address (it used to be like this).
public
getAddress() : string
If Primary Address is empty - get Delivery Address instead (as this is new by default address type).
Return values
stringgetAnotherEmail()
public
getAnotherEmail() : array<string|int, mixed>
Return values
array<string|int, mixed>getAnotherPhone()
public
getAnotherPhone() : array<string|int, mixed>
Return values
array<string|int, mixed>getAssignedId()
public
getAssignedId() : int|string
Return values
int|stringgetBankDetailId()
public
getBankDetailId() : int
Return values
intgetClientEmail()
public
getClientEmail() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientId()
public
getClientId() : int|string
Return values
int|stringgetClientIm()
public
getClientIm() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientName()
public
getClientName() : string
Return values
stringgetClientPhone()
public
getClientPhone() : array<string|int, mixed>
Return values
array<string|int, mixed>getClientWeb()
public
getClientWeb() : array<string|int, mixed>
Return values
array<string|int, mixed>getCommonFields()
public
getCommonFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getCompanyId()
public
getCompanyId() : int|null
Return values
int|nullgetContactId()
public
getContactId() : int|null
Return values
int|nullgetCrmOwnerType()
public
getCrmOwnerType() : int
Tags
Return values
intgetCurrencyId()
public
getCurrencyId() : string
Return values
stringgetCurrencyName()
public
getCurrencyName() : string
Return values
stringgetEmailCommunication()
public
getEmailCommunication() : array<string|int, mixed>
Return values
array<string|int, mixed>getFields()
public
getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getHash()
public
getHash() : string
Return values
stringgetHomeEmail()
public
getHomeEmail() : array<string|int, mixed>
Return values
array<string|int, mixed>getHomePhone()
public
getHomePhone() : array<string|int, mixed>
Return values
array<string|int, mixed>getLangName()
public
static getLangName() : mixed
Tags
getLangPhrasesPath()
public
getLangPhrasesPath() : string
Return values
stringgetMobilePhone()
public
getMobilePhone() : array<string|int, mixed>
Return values
array<string|int, mixed>getMyCompanyEditUrl()
public
getMyCompanyEditUrl([bool $singleOnly = true ]) : bool|string
Parameters
- $singleOnly : bool = true
Return values
bool|stringgetMyCompanyId()
public
getMyCompanyId([null $defaultMyCompanyId = null ]) : int|array<string|int, mixed>
Parameters
- $defaultMyCompanyId : null = null
Tags
Return values
int|array<string|int, mixed>getMyCompanyProvider()
public
getMyCompanyProvider() : Company|null
Return values
Company|nullgetNameFormat()
public
static getNameFormat() : string
Tags
Return values
stringgetPaymentQrCode()
public
getPaymentQrCode() : string|null
Return values
string|nullgetPrimaryAddress()
public
getPrimaryAddress() : string
Return values
stringgetRegisteredAddress()
public
getRegisteredAddress() : string
Return values
stringgetRequisiteId()
public
getRequisiteId() : int|array<string|int, mixed>
Return values
int|array<string|int, mixed>getSelfCompanyId()
public
getSelfCompanyId() : int|string
Return values
int|stringgetSelfId()
public
getSelfId() : int
Return values
intgetStatus()
public
getStatus() : string|null
Return values
string|nullgetSumWithoutWords()
public
getSumWithoutWords(string $placeholder) : bool|mixed
Parameters
- $placeholder : string
Return values
bool|mixedgetTimelineItemIdentifier()
public
getTimelineItemIdentifier() : ItemIdentifier|null
Return values
ItemIdentifier|nullgetTotalRows()
public
getTotalRows() : int
Return values
intgetUserFields()
public
getUserFields() : array<string|int, mixed>
Return values
array<string|int, mixed>getUserFieldValue()
public
getUserFieldValue([string $placeholder = null ]) : null
Parameters
- $placeholder : string = null
Return values
nullgetWorkEmail()
public
getWorkEmail() : array<string|int, mixed>
Return values
array<string|int, mixed>getWorkPhone()
public
getWorkPhone() : array<string|int, mixed>
Return values
array<string|int, mixed>hasAccess()
public
hasAccess(mixed $userId) : mixed
Parameters
- $userId : mixed
Tags
isLoaded()
public
isLoaded() : bool
Return values
boolisRootProvider()
public
isRootProvider() : bool
Return values
boolloadProducts()
public
loadProducts() : array<string|int, Product>
Return values
array<string|int, Product>loadTaxes()
public
loadTaxes() : array<string|int, mixed>|array<string|int, Tax>|null
Return values
array<string|int, mixed>|array<string|int, Tax>|nullonDocumentCreate()
public
onDocumentCreate(Document $document) : mixed
Parameters
- $document : Document
onDocumentDelete()
public
onDocumentDelete(Document $document) : mixed
Parameters
- $document : Document
Tags
onDocumentUpdate()
public
onDocumentUpdate(Document $document) : mixed
Parameters
- $document : Document
Tags
onPublicView()
public
onPublicView(Document $document[, bool $isFirstTime = false ]) : mixed
Parameters
- $document : Document
- $isFirstTime : bool = false
prepareTransactionData()
public
prepareTransactionData() : TransactionData