Payment_DTA
[ class tree: Payment_DTA ] [ index: Payment_DTA ] [ all elements ]
Packages:
Payment_DTA


Classes:
DTA
DTABase
DTAZV
Files:
DTA.php
DTABase.php
DTAZV.php
example_begleitzettel.php
example_credit.php
example_debit.php

Class: DTA

Source Location: /Payment_DTA-1.3.2/DTA.php

Class Overview

DTABase
   |
   --DTA

Dta class provides functions to create and handle with DTA files used in Germany to exchange informations about money transactions with banks or online banking programs.


Author(s):

Version:

  • Release: @package_version@

Variables

Methods

Inherited Variables

Inherited Methods

Class: DTABase

DTABase::DTABase()
Constructor.
DTABase::count()
Return number of exchanges
DTABase::getMetaData()
Returns an array with information about the transactions.
DTABase::makeValidString()
Makes the given string valid for DTA files.
DTABase::saveFile()
Writes the DTA file.
DTABase::validString()
Checks if the given string contains only chars valid for fields in DTA files.

Class Details

[line 97]
Dta class provides functions to create and handle with DTA files used in Germany to exchange informations about money transactions with banks or online banking programs.

Specifications:

  • http://www.ebics-zka.de/dokument/pdf/Anlage%203-Spezifikation%20der%20Datenformate%20-%20Version%202.3%20Endfassung%20vom%2005.11.2008.pdf, part 1.1 DTAUS0, p. 4ff
  • http://www.bundesbank.de/download/zahlungsverkehr/zv_spezifikationen_v1_5.pdf
  • http://www.hbci-zka.de/dokumente/aenderungen/DTAUS_2002.pdf



[ Top ]

Class Variables

$type =

[line 104]

Type of DTA file, DTA_CREDIT or DTA_DEBIT.

Type:   integer


[ Top ]


Method Detail

DTA (Constructor)   [line 132]

DTA DTA( integer $type)

Constructor. The type of the DTA file must be set. One file can only contain credits (DTA_CREDIT) OR debits (DTA_DEBIT).

This is a definement of the DTA format.

  • Access: public

Parameters:

integer   $type   —  Determines the type of the DTA file. Either DTA_CREDIT or DTA_DEBIT. Must be set.

[ Top ]

addExchange   [line 215]

boolean addExchange( array $account_receiver, double $amount, array $purposes, [array $account_sender = array()])

Adds an exchange. First the account data for the receiver of the exchange is set. In the case the DTA file contains credits, this is the payment receiver.

In the other case (the DTA file contains debits), this is the account, from which money is taken away. If the sender is not specified, values of the file sender are used by default.

Account data for receiver and sender contain name Name. Maximally 27 chars are allowed. bank_code Bank code. account_number Account number. additional_name If necessary, additional line for name (maximally 27 chars).

  • Access: public

Parameters:

array   $account_receiver   —  Receiver's account data.
double   $amount   —  Amount of money in this exchange. Currency: EURO
array   $purposes   —  Array of up to 14 lines (maximally 27 chars each) for description of the exchange. A string is accepted as well.
array   $account_sender   —  Sender's account data.

[ Top ]

getFileContent   [line 310]

string getFileContent( )

Returns the full content of the generated DTA file.

All added exchanges are processed.

  • Access: public

[ Top ]

getMetaData   [line 556]

array getMetaData( )

Returns an array with information about the transactions.

Can be used to print an accompanying document (Begleitzettel) for disks.

  • Return: Returns an array with keys: "sender_name", "sender_bank_code", "sender_account", "sum_amounts", "sum_bankcodes", "sum_accounts", "count", "date"
  • Access: public

Overrides DTABase::getMetaData() (Returns an array with information about the transactions.)
[ Top ]

setAccountFileSender   [line 156]

boolean setAccountFileSender( array $account)

Set the sender of the DTA file. Must be set for valid DTA file.

The given account data is also used as default sender's account. Account data contains name Sender's name. Maximally 27 chars are allowed. bank_code Sender's bank code. account_number Sender's account number. additional_name If necessary, additional line for sender's name (maximally 27 chars).

  • Access: public

Parameters:

array   $account   —  Account data for file sender.

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:31:50 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.