FreenetIS
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
Fio_Bank_Account_Settings Class Reference

Bank setting for FIO accounts. More...

Inheritance diagram for Fio_Bank_Account_Settings:
Bank_Account_Settings

Public Member Functions

 can_import_statements ()
 Can be bank statements imported in this type of bank?
 can_download_statements_automatically ()
 Can be bank statements automatically downloaded (using API) in this type of bank?
 get_download_statement_type ()
 Gets download statement type (e.g.
 get_download_base_url ()
 Gets base download URL (e.g.
 get_download_statement_url ()
 Gets download URL for statement (e.g.
 get_column_fields ()
 Gets fields array (key is a name of field and value contains a another array with fields type, name, help, rules, etc.)

Public Attributes

const API_TOKEN_LENGTH = 49
 API token has defined length.

Additional Inherited Members

Detailed Description

Bank setting for FIO accounts.

Member Function Documentation

Fio_Bank_Account_Settings::can_download_statements_automatically ( )

Can be bank statements automatically downloaded (using API) in this type of bank?

Returns
boolean

Reimplemented from Bank_Account_Settings.

Fio_Bank_Account_Settings::can_import_statements ( )

Can be bank statements imported in this type of bank?

Returns
boolean

Reimplemented from Bank_Account_Settings.

Fio_Bank_Account_Settings::get_column_fields ( )

Gets fields array (key is a name of field and value contains a another array with fields type, name, help, rules, etc.)

Returns
array Fields array

Reimplemented from Bank_Account_Settings.

Fio_Bank_Account_Settings::get_download_base_url ( )

Gets base download URL (e.g.

http://mbank/) Valid only if download is enabled.

Override this method in order to support auto downloading of statements.

See Also
Bank_Account_Settings::can_download_statements_automatically()
Returns
string URL string
Exceptions
InvalidArgumentExceptionOn invalid settings (e.g. API token)

Reimplemented from Bank_Account_Settings.

Fio_Bank_Account_Settings::get_download_statement_type ( )

Gets download statement type (e.g.

csv, json). Valid only if download is enabled. Tells what file type is espected as result of download. This type is later use for detection of importer for statement.

Override this method in order to support auto downloading of statements.

See Also
Bank_Account_Settings::can_download_statements_automatically()
Returns
string

Reimplemented from Bank_Account_Settings.

Fio_Bank_Account_Settings::get_download_statement_url ( )

Gets download URL for statement (e.g.

http://mbank/json/transactions) Valid only if download is enabled. The statment for the bank account is downloaded from this URL.

This method may use get_download_base_url() method for obtaining of base URL path.

Override this method in order to support auto downloading of statements.

See Also
Bank_Account_Settings::can_download_statements_automatically()
Returns
string URL string
Exceptions
InvalidArgumentExceptionOn invalid settings (e.g. API token)

Reimplemented from Bank_Account_Settings.


The documentation for this class was generated from the following file: