OrderPaymentController extends EntityController
Class OrderPaymentController
Table of Contents
Constants
- PAY_SYSTEM_CLICK = 'PAY_SYSTEM_CLICK'
- SENT_TO_TERMINAL = 'SENT_TO_TERMINAL'
- VIEWED_WAY_CUSTOMER_PAYMENT_PAY = 'VIEWED'
Methods
- getEntityTypeID() : int
- getInstance() : static
- Get an instance of the controller
- getSupportedPullCommands() : array<string|int, string>
- Returns associative array of supported pull commands
- loadCommunicationsAndMultifields() : void
- onClick() : void
- onConvert() : mixed
- Register conversion event in a timeline of a source entity (This entity is a source)
- onCreate() : mixed
- Register create event in a timeline
- onDelete() : mixed
- Register delete event in a timeline
- onModify() : mixed
- Register update event in a timeline
- onPaid() : void
- onRestore() : mixed
- Register restore event in a timeline
- onSend() : mixed
- onSentToTerminal() : void
- onView() : void
- prepareAuthorInfo() : mixed
- prepareAuthorInfoBulk() : mixed
- prepareEntityPushTag() : mixed
- prepareHistoryDataModel() : array<string|int, mixed>
- Prepare data about an timeline entry. The data is used in interface to display timeline event
- prepareMultiFieldInfo() : mixed
- prepareMultiFieldInfoBulk() : mixed
- prepareSearchContent() : mixed
- register() : void
- Register existed entity in retrospect mode.
- sendPullEventOnAdd() : void
- Send pull event about timeline item creation
- sendPullEventOnDelete() : void
- Send pull event about timeline item deletion
- sendPullEventOnPin() : mixed
- sendPullEventOnUpdate() : void
- Send pull event about timeline item modification
- updateSettingFields() : Result
Constants
PAY_SYSTEM_CLICK
public
mixed
PAY_SYSTEM_CLICK
= 'PAY_SYSTEM_CLICK'
SENT_TO_TERMINAL
public
mixed
SENT_TO_TERMINAL
= 'SENT_TO_TERMINAL'
VIEWED_WAY_CUSTOMER_PAYMENT_PAY
public
mixed
VIEWED_WAY_CUSTOMER_PAYMENT_PAY
= 'VIEWED'
Methods
getEntityTypeID()
public
getEntityTypeID() : int
Return values
intgetInstance()
Get an instance of the controller
public
static getInstance() : static
Return values
staticgetSupportedPullCommands()
Returns associative array of supported pull commands
public
getSupportedPullCommands() : array<string|int, string>
Return values
array<string|int, string>loadCommunicationsAndMultifields()
public
static loadCommunicationsAndMultifields(array<string|int, mixed> &$items[, CCrmPerms $userPermissions = null ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $items : array<string|int, mixed>
- $userPermissions : CCrmPerms = null
- $options : array<string|int, mixed> = []
onClick()
public
onClick(int $ownerId, array<string|int, mixed> $params) : void
Parameters
- $ownerId : int
- $params : array<string|int, mixed>
onConvert()
Register conversion event in a timeline of a source entity (This entity is a source)
public
onConvert(mixed $ownerID, array<string|int, mixed> $params) : mixed
Parameters
- $ownerID : mixed
-
- id of a source entity, which this controller is associated with
- $params : array<string|int, mixed>
onCreate()
Register create event in a timeline
public
onCreate(mixed $ownerID, array<string|int, mixed> $params) : mixed
Parameters
- $ownerID : mixed
- $params : array<string|int, mixed>
Tags
onDelete()
Register delete event in a timeline
public
onDelete(mixed $entityID, array<string|int, mixed> $params) : mixed
Parameters
- $entityID : mixed
- $params : array<string|int, mixed>
onModify()
Register update event in a timeline
public
onModify(mixed $entityID, array<string|int, mixed> $params) : mixed
Parameters
- $entityID : mixed
- $params : array<string|int, mixed>
onPaid()
public
onPaid(int $ownerId, array<string|int, mixed> $params) : void
Parameters
- $ownerId : int
- $params : array<string|int, mixed>
onRestore()
Register restore event in a timeline
public
onRestore(mixed $entityID, array<string|int, mixed> $params) : mixed
Parameters
- $entityID : mixed
- $params : array<string|int, mixed>
onSend()
public
onSend(mixed $ownerId, mixed $params) : mixed
Parameters
- $ownerId : mixed
- $params : mixed
onSentToTerminal()
public
onSentToTerminal(int $ownerId, array<string|int, mixed> $params) : void
Parameters
- $ownerId : int
- $params : array<string|int, mixed>
onView()
public
onView(int $ownerId, array<string|int, mixed> $params, string $viewedWay) : void
Parameters
- $ownerId : int
- $params : array<string|int, mixed>
- $viewedWay : string
prepareAuthorInfo()
public
static prepareAuthorInfo(array<string|int, mixed> &$item) : mixed
Parameters
- $item : array<string|int, mixed>
prepareAuthorInfoBulk()
public
static prepareAuthorInfoBulk(array<string|int, mixed> &$items) : mixed
Parameters
- $items : array<string|int, mixed>
prepareEntityPushTag()
public
prepareEntityPushTag(mixed $entityID) : mixed
Parameters
- $entityID : mixed
prepareHistoryDataModel()
Prepare data about an timeline entry. The data is used in interface to display timeline event
public
prepareHistoryDataModel(array<string|int, mixed> $data[, array<string|int, mixed>|null $options = null ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
- $options : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>prepareMultiFieldInfo()
public
static prepareMultiFieldInfo(array<string|int, mixed> &$item) : mixed
Parameters
- $item : array<string|int, mixed>
prepareMultiFieldInfoBulk()
public
static prepareMultiFieldInfoBulk(array<string|int, mixed> &$items) : mixed
Parameters
- $items : array<string|int, mixed>
prepareSearchContent()
public
prepareSearchContent(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
register()
Register existed entity in retrospect mode.
public
register(int $ownerID[, array<string|int, mixed> $options = null ]) : void
Parameters
- $ownerID : int
-
Entity ID
- $options : array<string|int, mixed> = null
sendPullEventOnAdd()
Send pull event about timeline item creation
public
sendPullEventOnAdd(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
- $itemIdentifier : ItemIdentifier
- $timelineEntryId : int
- $userId : int|null = null
sendPullEventOnDelete()
Send pull event about timeline item deletion
public
sendPullEventOnDelete(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
- $itemIdentifier : ItemIdentifier
- $timelineEntryId : int
- $userId : int|null = null
sendPullEventOnPin()
public
sendPullEventOnPin(ItemIdentifier $itemIdentifier, int $timelineEntryId, bool $isPinned[, int $userId = null ]) : mixed
Parameters
- $itemIdentifier : ItemIdentifier
- $timelineEntryId : int
- $isPinned : bool
- $userId : int = null
sendPullEventOnUpdate()
Send pull event about timeline item modification
public
sendPullEventOnUpdate(ItemIdentifier $itemIdentifier, int $timelineEntryId[, int|null $userId = null ]) : void
Parameters
- $itemIdentifier : ItemIdentifier
- $timelineEntryId : int
- $userId : int|null = null
updateSettingFields()
public
updateSettingFields(mixed $ownerID, mixed $entryTypeID, array<string|int, mixed> $fields) : Result
Parameters
- $ownerID : mixed
- $entryTypeID : mixed
- $fields : array<string|int, mixed>