TimeTrex API Manual

EFT_record extends EFT
in package

Table of Contents

$compiled_data  : mixed
$data  : mixed
$file_format  : mixed
$file_format_options  : mixed
$file_postfix_data  : mixed
$file_prefix_data  : mixed
$header_data  : mixed
$line_ending  : mixed
$record_data  : mixed
$split_debit_credit_batches  : mixed
__construct()  : mixed
EFT_record constructor.
compile()  : bool
getAccount()  : bool
getAmount()  : bool
getBatchBusinessNumber()  : bool
See similar function in EFT_Record class.
getBatchDiscretionaryData()  : string
getBatchEntryDescription()  : string
getBatchKey()  : string
getBatchServiceCode()  : string
See similar function in EFT_Record class.
getBusinessNumber()  : bool
ACH Only, helps set the batches based on different criteria.
getCompanyShortName()  : mixed
getCompiledData()  : bool|string
getCPACode()  : bool
getCurrencyISOCode()  : mixed
getDataCenter()  : mixed
getDataCenterName()  : mixed
getDiscretionaryData()  : string
getDueDate()  : bool
getEntryDescription()  : string
getFileCreationDate()  : mixed
getFileCreationNumber()  : mixed
getFileFormat()  : bool|null
getFilePostfixData()  : bool|null
getFilePrefixData()  : bool|null
getInitialEntryNumber()  : mixed
getInstitution()  : bool
ACH Only, helps set the batches based on different criteria.
getIsBalanced()  : bool|null
getName()  : bool
getOriginatorID()  : mixed
getOriginatorLongName()  : bool
getOriginatorReferenceNumber()  : bool
getOriginatorShortName()  : bool
getOtherData()  : bool
See similar function in EFT_Record class.
getReturnAccount()  : bool
getReturnInstitution()  : bool
getReturnTransit()  : bool
getServiceCode()  : string
getTransit()  : bool
getType()  : bool|string
isAlphaNumeric()  : bool
isFloat()  : bool
isNumeric()  : bool
padLine()  : string
padRecord()  : string
removeDecimal()  : mixed
save()  : bool
setAccount()  : bool
setAmount()  : bool
setBatchBusinessNumber()  : bool
setBatchDiscretionaryData()  : bool
setBatchEntryDescription()  : bool
setBatchServiceCode()  : bool
setBusinessNumber()  : bool
setCompanyShortName()  : bool
setCPACode()  : bool
setCurrencyISOCode()  : bool
setDataCenter()  : bool
setDataCenterName()  : bool
setDiscretionaryData()  : bool
setDueDate()  : bool
setEntryDescription()  : bool
setFileCreationDate()  : bool
setFileCreationNumber()  : bool
setFileFormat()  : bool
setFilePostfixData()  : bool
setFilePrefixData()  : bool
setInitialEntryNumber()  : bool
setInstitution()  : bool
setIsBalanced()  : bool
setName()  : bool
setOriginatorID()  : bool
setOriginatorLongName()  : bool
setOriginatorReferenceNumber()  : bool
setOriginatorShortName()  : bool
setOtherData()  : bool
setRecord()  : bool
setReturnAccount()  : bool
setReturnInstitution()  : bool
setReturnTransit()  : bool
setServiceCode()  : bool
setTransit()  : bool
setType()  : bool
toJulian()  : string
sortRecords()  : bool
usortByBusinessNumberAndServiceCodeAndEntryDescriptionAndDueDateAndType()  : int

Properties

$compiled_data

public mixed $compiled_data = \null

$file_format

public mixed $file_format = \null

$file_format_options

public mixed $file_format_options = ['1464', '105', 'BEANSTREAM', 'ACH', 'CIBC_EPAY']

$file_postfix_data

public mixed $file_postfix_data = \null

$file_prefix_data

public mixed $file_prefix_data = \null

$header_data

public mixed $header_data = \null

$line_ending

public mixed $line_ending = "\r\n"

$record_data

public mixed $record_data = \null

$split_debit_credit_batches

public mixed $split_debit_credit_batches = \false

Methods

__construct()

EFT_record constructor.

public __construct([null $options = null ]) : mixed
Parameters
$options : null = null
Return values
mixed —

compile()

public compile() : bool
Return values
bool —

getAccount()

public getAccount() : bool
Return values
bool —

getAmount()

public getAmount() : bool
Return values
bool —

getBatchBusinessNumber()

See similar function in EFT_Record class.

public getBatchBusinessNumber() : bool
Return values
bool —

getBatchDiscretionaryData()

public getBatchDiscretionaryData() : string
Return values
string —

getBatchEntryDescription()

public getBatchEntryDescription() : string
Return values
string —

getBatchKey()

public getBatchKey() : string
Return values
string —

getBatchServiceCode()

See similar function in EFT_Record class.

public getBatchServiceCode() : string
Return values
string —

getBusinessNumber()

ACH Only, helps set the batches based on different criteria.

public getBusinessNumber() : bool
Return values
bool —

getCompanyShortName()

public getCompanyShortName() : mixed
Return values
mixed —

getCompiledData()

public getCompiledData() : bool|string
Return values
bool|string —

getCPACode()

public getCPACode() : bool
Return values
bool —

getCurrencyISOCode()

public getCurrencyISOCode() : mixed
Return values
mixed —

getDataCenter()

public getDataCenter() : mixed
Return values
mixed —

getDataCenterName()

public getDataCenterName() : mixed
Return values
mixed —

getDiscretionaryData()

public getDiscretionaryData() : string
Return values
string —

getDueDate()

public getDueDate() : bool
Return values
bool —

getEntryDescription()

public getEntryDescription() : string
Return values
string —

getFileCreationDate()

public getFileCreationDate() : mixed
Return values
mixed —

getFileCreationNumber()

public getFileCreationNumber() : mixed
Return values
mixed —

getFileFormat()

public getFileFormat() : bool|null
Return values
bool|null —

getFilePostfixData()

public getFilePostfixData() : bool|null
Return values
bool|null —

getFilePrefixData()

public getFilePrefixData() : bool|null
Return values
bool|null —

getInitialEntryNumber()

public getInitialEntryNumber() : mixed
Return values
mixed —

getInstitution()

ACH Only, helps set the batches based on different criteria.

public getInstitution() : bool
Return values
bool —

getIsBalanced()

public getIsBalanced() : bool|null
Return values
bool|null —

getName()

public getName() : bool
Return values
bool —

getOriginatorID()

public getOriginatorID() : mixed
Return values
mixed —

getOriginatorLongName()

public getOriginatorLongName() : bool
Return values
bool —

getOriginatorReferenceNumber()

public getOriginatorReferenceNumber() : bool
Return values
bool —

getOriginatorShortName()

public getOriginatorShortName() : bool
Return values
bool —

getOtherData()

See similar function in EFT_Record class.

public getOtherData( $key) : bool
Parameters
$key :
Return values
bool —

getReturnAccount()

public getReturnAccount() : bool
Return values
bool —

getReturnInstitution()

public getReturnInstitution() : bool
Return values
bool —

getReturnTransit()

public getReturnTransit() : bool
Return values
bool —

getServiceCode()

public getServiceCode() : string
Return values
string —

getTransit()

public getTransit() : bool
Return values
bool —

getType()

public getType() : bool|string
Return values
bool|string —

isAlphaNumeric()

public isAlphaNumeric( $value) : bool
Parameters
$value :
Return values
bool —

isFloat()

public isFloat( $value) : bool
Parameters
$value :
Return values
bool —

isNumeric()

public isNumeric( $value) : bool
Parameters
$value :
Return values
bool —

padLine()

public padLine( $line,  $length[, bool $include_line_ending = true ]) : string
Parameters
$line :
$length :
$include_line_ending : bool = true
Return values
string —

padRecord()

public padRecord( $value,  $length,  $type) : string
Parameters
$value :
$length :
$type :
Return values
string —

removeDecimal()

public removeDecimal( $value) : mixed
Parameters
$value :
Return values
mixed —

save()

public save( $file_name) : bool
Parameters
$file_name :
Return values
bool —

setAccount()

public setAccount( $value) : bool
Parameters
$value :
Return values
bool —

setAmount()

public setAmount( $value) : bool
Parameters
$value :
Return values
bool —

setBatchBusinessNumber()

public setBatchBusinessNumber( $value) : bool
Parameters
$value :
Return values
bool —

setBatchDiscretionaryData()

public setBatchDiscretionaryData( $value) : bool
Parameters
$value :
Return values
bool —

setBatchEntryDescription()

public setBatchEntryDescription( $value) : bool
Parameters
$value :
Return values
bool —

setBatchServiceCode()

public setBatchServiceCode( $value) : bool
Parameters
$value :
Return values
bool —

setBusinessNumber()

public setBusinessNumber( $value) : bool
Parameters
$value :
Return values
bool —

setCompanyShortName()

public setCompanyShortName( $value) : bool
Parameters
$value :
Return values
bool —

setCPACode()

public setCPACode( $value) : bool
Parameters
$value :
Return values
bool —

setCurrencyISOCode()

public setCurrencyISOCode( $value) : bool
Parameters
$value :
Return values
bool —

setDataCenter()

public setDataCenter( $value) : bool
Parameters
$value :
Return values
bool —

setDataCenterName()

public setDataCenterName( $value) : bool
Parameters
$value :
Return values
bool —

setDiscretionaryData()

public setDiscretionaryData( $value) : bool
Parameters
$value :
Return values
bool —

setDueDate()

public setDueDate( $value) : bool
Parameters
$value :
Return values
bool —

setEntryDescription()

public setEntryDescription( $value) : bool
Parameters
$value :
Return values
bool —

setFileCreationDate()

public setFileCreationDate( $value) : bool
Parameters
$value :
Return values
bool —

setFileCreationNumber()

public setFileCreationNumber( $value) : bool
Parameters
$value :
Return values
bool —

setFileFormat()

public setFileFormat( $format) : bool
Parameters
$format :
Return values
bool —

setFilePostfixData()

public setFilePostfixData( $data) : bool
Parameters
$data :
Return values
bool —

setFilePrefixData()

public setFilePrefixData( $data) : bool
Parameters
$data :
Return values
bool —

setInitialEntryNumber()

public setInitialEntryNumber( $value) : bool
Parameters
$value :
Return values
bool —

setInstitution()

public setInstitution( $value) : bool
Parameters
$value :
Return values
bool —

setIsBalanced()

public setIsBalanced( $data) : bool
Parameters
$data :
Return values
bool —

setName()

public setName( $value) : bool
Parameters
$value :
Return values
bool —

setOriginatorID()

public setOriginatorID( $value) : bool
Parameters
$value :
Return values
bool —

setOriginatorLongName()

public setOriginatorLongName( $value) : bool
Parameters
$value :
Return values
bool —

setOriginatorReferenceNumber()

public setOriginatorReferenceNumber( $value) : bool
Parameters
$value :
Return values
bool —

setOriginatorShortName()

public setOriginatorShortName( $value) : bool
Parameters
$value :
Return values
bool —

setOtherData()

public setOtherData( $key,  $value) : bool
Parameters
$key :
$value :
Return values
bool —

setRecord()

public setRecord(object $obj) : bool
Parameters
$obj : object
Return values
bool —

setReturnAccount()

public setReturnAccount( $value) : bool
Parameters
$value :
Return values
bool —

setReturnInstitution()

public setReturnInstitution( $value) : bool
Parameters
$value :
Return values
bool —

setReturnTransit()

public setReturnTransit( $value) : bool
Parameters
$value :
Return values
bool —

setServiceCode()

public setServiceCode( $value) : bool
Parameters
$value :
Return values
bool —

setTransit()

public setTransit( $value) : bool
Parameters
$value :
Return values
bool —

setType()

public setType( $value) : bool
Parameters
$value :
Return values
bool —

toJulian()

public toJulian(int $epoch) : string
Parameters
$epoch : int

EPOCH

Return values
string —

sortRecords()

private sortRecords() : bool
Return values
bool —

usortByBusinessNumberAndServiceCodeAndEntryDescriptionAndDueDateAndType()

private usortByBusinessNumberAndServiceCodeAndEntryDescriptionAndDueDateAndType( $a,  $b) : int
Parameters
$a :
$b :
Return values
int —

Search results