TimeTrex API Manual

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
$split_debit_credit_batches  : mixed
__construct()  : mixed
EFT constructor.
compile()  : bool
getBatchBusinessNumber()  : bool
See similar function in EFT_Record class.
getBatchDiscretionaryData()  : string
getBatchEntryDescription()  : string
getBatchServiceCode()  : string
See similar function in EFT_Record class.
getBusinessNumber()  : mixed
getCompanyShortName()  : mixed
getCompiledData()  : bool|string
getCurrencyISOCode()  : mixed
getDataCenter()  : mixed
getDataCenterName()  : mixed
getFileCreationDate()  : mixed
getFileCreationNumber()  : mixed
getFileFormat()  : bool|null
getFilePostfixData()  : bool|null
getFilePrefixData()  : bool|null
getInitialEntryNumber()  : mixed
getIsBalanced()  : bool|null
getOriginatorID()  : mixed
getOriginatorShortName()  : mixed
getOtherData()  : bool
See similar function in EFT_Record class.
isAlphaNumeric()  : bool
isFloat()  : bool
isNumeric()  : bool
padLine()  : string
padRecord()  : string
removeDecimal()  : mixed
save()  : bool
setBatchBusinessNumber()  : bool
setBatchDiscretionaryData()  : bool
setBatchEntryDescription()  : bool
setBatchServiceCode()  : bool
setBusinessNumber()  : bool
setCompanyShortName()  : bool
setCurrencyISOCode()  : bool
setDataCenter()  : bool
setDataCenterName()  : bool
setFileCreationDate()  : bool
setFileCreationNumber()  : bool
setFileFormat()  : bool
setFilePostfixData()  : bool
setFilePrefixData()  : bool
setInitialEntryNumber()  : bool
setIsBalanced()  : bool
setOriginatorID()  : bool
setOriginatorShortName()  : bool
setOtherData()  : bool
setRecord()  : 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"

$split_debit_credit_batches

public mixed $split_debit_credit_batches = \false

Methods

__construct()

EFT constructor.

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

compile()

public compile() : 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

getBatchServiceCode()

See similar function in EFT_Record class.

public getBatchServiceCode() : string
Return values
string

getBusinessNumber()

public getBusinessNumber() : mixed
Return values
mixed

getCompanyShortName()

public getCompanyShortName() : mixed
Return values
mixed

getCompiledData()

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

getCurrencyISOCode()

public getCurrencyISOCode() : mixed
Return values
mixed

getDataCenter()

public getDataCenter() : mixed
Return values
mixed

getDataCenterName()

public getDataCenterName() : mixed
Return values
mixed

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

getIsBalanced()

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

getOriginatorID()

public getOriginatorID() : mixed
Return values
mixed

getOriginatorShortName()

public getOriginatorShortName() : mixed
Return values
mixed

getOtherData()

See similar function in EFT_Record class.

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

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

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

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

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

setIsBalanced()

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

setOriginatorID()

public setOriginatorID( $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

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