Documentation

PaymentBatch
in package
implements DomainObjectInterface

Tags

Interfaces, Classes, Traits and Enums

DomainObjectInterface

Table of Contents

DEPOSIT_STATUS_BATCH_CREATE_FAIL  = 'TPBatchCreationFailed'
DEPOSIT_STATUS_CLOSED  = 'Closed'
DEPOSIT_STATUS_DELETED  = 'Deleted'
DEPOSIT_STATUS_DEP_PARTIAL  = 'PartialDeposit'
DEPOSIT_STATUS_ERROR  = 'Error'
DEPOSIT_STATUS_ITEMS_DUPLICATE  = 'Duplicate_Items_In_Batch'
DEPOSIT_STATUS_ITEMS_REJECTED  = 'Rejected_Items_In_Batch'
DEPOSIT_STATUS_NEEDS_BALANCING  = 'NeedsBalancing'
DEPOSIT_STATUS_NEEDS_RESCAN  = 'NeedsRescan'
DEPOSIT_STATUS_OPEN  = 'Open'
DEPOSIT_STATUS_OPENED  = 'Opened'
DEPOSIT_STATUS_PROC_PARTIAL  = 'PartiallyProcessed'
DEPOSIT_STATUS_PROC_READY  = 'ReadyForProcessing'
DEPOSIT_STATUS_PROC_W_ADJ  = 'ProcessedWithAdjustment'
DEPOSIT_STATUS_REJECTED  = 'Rejected'
DEPOSIT_STATUS_TRANS_PROC_ERROR  = 'TPError'
DEPOSIT_STATUS_TRANS_PROC_SENT  = 'SentToTransactionProcessing'
DEPOSIT_STATUS_UPDATED  = 'Updated'
$created  : DateTimeImmutable
$creator  : string
$description  : string
$id  : BatchId
$locationName  : string
$paymentCount  : int
$paymentTotal  : int|null
$status  : string
$updated  : DateTimeImmutable
__construct()  : mixed
created()  : DateTimeImmutable
creator()  : string
description()  : string
id()  : BatchId
locationName()  : string
paymentCount()  : int
paymentTotal()  : int|null
status()  : string
updated()  : DateTimeImmutable
validDepositStatuses()  : array<string|int, string>

Constants

DEPOSIT_STATUS_BATCH_CREATE_FAIL

public mixed DEPOSIT_STATUS_BATCH_CREATE_FAIL = 'TPBatchCreationFailed'
Tags

DEPOSIT_STATUS_CLOSED

public mixed DEPOSIT_STATUS_CLOSED = 'Closed'
Tags

DEPOSIT_STATUS_DELETED

public mixed DEPOSIT_STATUS_DELETED = 'Deleted'
Tags

DEPOSIT_STATUS_DEP_PARTIAL

public mixed DEPOSIT_STATUS_DEP_PARTIAL = 'PartialDeposit'
Tags

DEPOSIT_STATUS_ERROR

public mixed DEPOSIT_STATUS_ERROR = 'Error'
Tags

DEPOSIT_STATUS_ITEMS_DUPLICATE

public mixed DEPOSIT_STATUS_ITEMS_DUPLICATE = 'Duplicate_Items_In_Batch'
Tags

DEPOSIT_STATUS_ITEMS_REJECTED

public mixed DEPOSIT_STATUS_ITEMS_REJECTED = 'Rejected_Items_In_Batch'
Tags

DEPOSIT_STATUS_NEEDS_BALANCING

public mixed DEPOSIT_STATUS_NEEDS_BALANCING = 'NeedsBalancing'
Tags

DEPOSIT_STATUS_NEEDS_RESCAN

public mixed DEPOSIT_STATUS_NEEDS_RESCAN = 'NeedsRescan'
Tags

DEPOSIT_STATUS_OPEN

public mixed DEPOSIT_STATUS_OPEN = 'Open'
Tags

DEPOSIT_STATUS_OPENED

public mixed DEPOSIT_STATUS_OPENED = 'Opened'
Tags

DEPOSIT_STATUS_PROC_PARTIAL

public mixed DEPOSIT_STATUS_PROC_PARTIAL = 'PartiallyProcessed'
Tags

DEPOSIT_STATUS_PROC_READY

public mixed DEPOSIT_STATUS_PROC_READY = 'ReadyForProcessing'
Tags

DEPOSIT_STATUS_PROC_W_ADJ

public mixed DEPOSIT_STATUS_PROC_W_ADJ = 'ProcessedWithAdjustment'
Tags

DEPOSIT_STATUS_REJECTED

public mixed DEPOSIT_STATUS_REJECTED = 'Rejected'
Tags

DEPOSIT_STATUS_TRANS_PROC_ERROR

public mixed DEPOSIT_STATUS_TRANS_PROC_ERROR = 'TPError'
Tags

DEPOSIT_STATUS_TRANS_PROC_SENT

public mixed DEPOSIT_STATUS_TRANS_PROC_SENT = 'SentToTransactionProcessing'
Tags

DEPOSIT_STATUS_UPDATED

public mixed DEPOSIT_STATUS_UPDATED = 'Updated'
Tags

Properties

Methods

__construct()

public __construct(BatchId $id, string $description, DateTimeImmutable $created, string $creator, string $locationName, int $paymentCount, int|null $paymentTotal, string $status, DateTimeImmutable $updated) : mixed
Parameters
$id : BatchId
$description : string
$created : DateTimeImmutable
$creator : string
$locationName : string
$paymentCount : int
$paymentTotal : int|null
$status : string
$updated : DateTimeImmutable
Tags
throws
Exception
Return values
mixed

created()

public created() : DateTimeImmutable
Return values
DateTimeImmutable

creator()

public creator() : string
Return values
string

description()

public description() : string
Return values
string

locationName()

public locationName() : string
Return values
string

paymentCount()

public paymentCount() : int
Return values
int

paymentTotal()

public paymentTotal() : int|null
Return values
int|null

status()

public status() : string
Return values
string

updated()

public updated() : DateTimeImmutable
Return values
DateTimeImmutable

validDepositStatuses()

public static validDepositStatuses() : array<string|int, string>
Tags
Return values
array<string|int, string>

Search results