\Banksta2

Bank statements processing class

Synopsis

class Banksta2 {

• // constants
• const BANKSTA2_TABLE = 'banksta2';
• const BANKSTA2_PRESETS_TABLE = 'banksta2_presets';
• const BANKSTA2_USER_CACHE_KEY = "BANKSTA2_USERS_DATA";
• const BANKSTA2_PROCBS_CACHE_KEY = "BANKSTA2_PROCBS_DATA";
• const BANKSTA2_MAPPRESETS_CACHE_KEY = "BANKSTA2_MAPPRESETS_DATA";
• const URL_ME = '?module=banksta2';
• const URL_BANKSTA2_UPLOADFORM = '?module=banksta2&uploadform=true';
• const URL_BANKSTA2_PROCESSING = '?module=banksta2&showhash=';
• const URL_BANKSTA2_DETAILED = '?module=banksta2&showdetailed=';
• const URL_BANKSTA2_FIELD_MAPPING = '?module=banksta2&fieldmapping=true';
• const URL_BANKSTA2_PRESETS = '?module=banksta2&presets=true';
• const URL_BANKSTA2_PROCEED_STMT_IMP = '?module=banksta2&proceedstatementimport=true';
• const URL_BANKSTA2_BANKSTALIST = '?module=banksta2&bankstalist=true';
• const URL_USERS_PROFILE_INET = '?module=userprofile&username=';
• const URL_USERS_PROFILE_UKV = '?module=ukv&users=true&showuser=';
• const BANKSTA2_PATH = 'content/documents/banksta2/';
• // members
• protected  $ubConfig = NULL;
• protected  $billing = NULL;
• protected  $messages = NULL;
• protected  $ubCache = NULL;
• protected integer $cacheLifeTime = 900;
• protected array $allowedExtensions = ;
• protected array $fieldsMappingPresets = ;
• protected integer $inetPaymentId = 1;
• protected integer $ukvPaymentId = 2;
• protected array $bankstaServiceType = ;
• protected array $bankstaRecordsAll = ;
• protected array $bankstaRecordsAllIDs = ;
• protected array $allUsersDataInet = ;
• protected array $allUsersDataUKV = ;
• protected array $allContractsInet = ;
• protected array $allContractsUKV = ;
• protected array $ukvTariffs = ;
• protected array $bankstaFoundUsers = ;
• protected string $regexKeywordsDelimiter = ',';
• protected bool $translateLstChkFieldNames = false;
• protected bool $opayzIDAsContract = false;
• protected array $inetSrvAllotedIDs = ;
• protected array $ctvSrvAllotedIDs = ;
• public array $preprocessedFileData = ;
• public array $dbPresetsFlds2PreprocForm = ;
• // methods
• public void __construct()
• protected void initMessages()
• public  getUbMsgHelperInstance()
• protected void loadOptions()
• public array getUsersDataForCache()
• public array getUsersDataCached()
• public array getProcessedBSRecsCached()
• public array getMappingPresetsCached()
• protected array loadUserDataInet()
• protected array loadUserDataUKV()
• protected array loadUKVTariffs()
• public array loadProcessedBankstaRecs()
• public array loadProcessedBankstaRecsIDs()
• public array loadMappingPresets()
• public array getMappingPresets()
• public array getFileInfoByHash()
• public array|false|string getFMPDataJSON()
• public string getMappingPresetsSelector()
• public array|mixed getBankstaRecDetails()
• public void setBankstaRecProcessed()
• public void setBankstaRecCanceled()
• public void setBankstaRecUnCanceled()
• public void setBankstaRecContract()
• public void setBankstaRecSrvType()
• public array|bool uploadFile()
• protected bool checkHashExists()
• public string checkFMPNameExists()
• public void addFieldsMappingPreset()
• public void editFieldsMappingPreset()
• public void deleteFieldsMappingPreset()
• public void deleteBankStatement()
• public string preprocessImportFile()
• public string prepareRegexStrings()
• public string preprocessBStatement()
• public void processBankStatement()
• public void pushStatementPayments()
• protected void createPaymentRec()
• protected bool checkBankstaRowIsUnprocessed()
• public void checkStatementIsUnprocessed()
• public bool checkNeedProcessUKV()
• public static string web_MainButtonsControls()
• public string web_FileUploadForm()
• public void web_FieldsMappingForm()
• public void web_LastChecksForm()
• public static void web_FMPForm()
• public string web_BSProcessingForm()
• public static void renderBStatementsListJSON()
• public static string renderBStatementsJQDT()
• public static void renderFMPListJSON()
• protected static string renderFMPJQDT()
• public string renderFMPAddForm()
• public string renderFMPEditForm()
}


Constants

Name	Value
BANKSTA2_TABLE	'banksta2'
BANKSTA2_PRESETS_TABLE	'banksta2_presets'
BANKSTA2_USER_CACHE_KEY	"BANKSTA2_USERS_DATA"
BANKSTA2_PROCBS_CACHE_KEY	"BANKSTA2_PROCBS_DATA"
BANKSTA2_MAPPRESETS_CACHE_KEY	"BANKSTA2_MAPPRESETS_DATA"
URL_ME	'?module=banksta2'
URL_BANKSTA2_UPLOADFORM	'?module=banksta2&uploadform=true'
URL_BANKSTA2_PROCESSING	'?module=banksta2&showhash='
URL_BANKSTA2_DETAILED	'?module=banksta2&showdetailed='
URL_BANKSTA2_FIELD_MAPPING	'?module=banksta2&fieldmapping=true'
URL_BANKSTA2_PRESETS	'?module=banksta2&presets=true'
URL_BANKSTA2_PROCEED_STMT_IMP	'?module=banksta2&proceedstatementimport=true'
URL_BANKSTA2_BANKSTALIST	'?module=banksta2&bankstalist=true'
URL_USERS_PROFILE_INET	'?module=userprofile&username='
URL_USERS_PROFILE_UKV	'?module=ukv&users=true&showuser='
BANKSTA2_PATH	'content/documents/banksta2/'

Members

protected

• $allContractsInet — array
  Contains available Inet users contracts mappings as contract => login
• $allContractsUKV — array
  Contains available UKV users contracts mappings as contract => login
• $allUsersDataInet — array
  Contains available Inet users data as login => userdata
• $allUsersDataUKV — array
  Contains available UKV users data as login => userdata
• $allowedExtensions — array
  List of allowed extensions
• $bankstaFoundUsers — array
  Contains detected Internet/UKV users as contract => login / contract => id for displaying during statement processing
• $bankstaRecordsAll — array
  Already preprocessed banksta records from BANKSTA2_TABLE
• $bankstaRecordsAllIDs — array
  Already preprocessed banksta records IDs from BANKSTA2_TABLE
• $bankstaServiceType — array
  Service types placeholder
• $billing — null
  Billing API object placeholder
• $cacheLifeTime — int
  Placeholder for BANKSTA2_CACHE_LIFETIME from alter.ini
• $ctvSrvAllotedIDs — array
  Placeholder for BANKSTA2_CTVSRV_ALLOTED_IDS option
• $fieldsMappingPresets — array
  Field mapping presets represented as [preset_id] => array[] of options
• $inetPaymentId — int
  Default payment ID to push Internet banksta payments
• $inetSrvAllotedIDs — array
  Placeholder for BANKSTA2_INETSRV_ALLOTED_IDS option
• $messages — null
  System message helper object placeholder
• $opayzIDAsContract — bool
  Placeholder for BANKSTA2_OPAYZID_AS_CONTRACT option
• $regexKeywordsDelimiter — string
  Placeholder for BANKSTA2_REGEX_KEYWORDS_DELIM option
• $translateLstChkFieldNames — bool
  Placeholder for BANKSTA2_LSTCHK_FNAMES_TRANSLATE option
• $ubCache — null
  UbillingCache instance placeholder
• $ubConfig — null
  UbillingConfig object placeholder
• $ukvPaymentId — int
  Default payment ID to push UKV banksta payments
• $ukvTariffs — array
  Contains available UKV tariffs mappings as id => data

public

• $dbPresetsFlds2PreprocForm — array
  Placeholder mapper for BANKSTA2_PRESETS_TABLE and web_PreprocessingForm
• $preprocessedFileData — array
  Placeholder for file data preprocessed during filePreprocessing()

Methods

protected

• checkBankstaRowIsUnprocessed() — Checks banksta row by it's ID if it is unprocessed
• checkHashExists() — checks if banksta hash exists?
• createPaymentRec() — Creates a row in BANKSTA2_TABLE with essential payment data
• initMessages() — Inits message helper object for further usage
• loadOptions() — Getting an alter.ini options
• loadUKVTariffs() — Loads UKV tariffs into private tariffs prop
• loadUserDataInet() — Loads all available Internet users data from database
• loadUserDataUKV() — Loads all available UKV users data from database
• renderFMPJQDT() — Returns fields mapping presets JQDT control and some JS bindings for dynamic forms

public

• __construct()
• addFieldsMappingPreset() — Adds new fields mapping preset to DB
• checkFMPNameExists() — Returns true if field mapping preset with such name already exists
• checkNeedProcessUKV() — Checks $paymentsToPush array for UKV records presence
• checkStatementIsUnprocessed()
• deleteBankStatement() — Deletes uploaded bank statement
• deleteFieldsMappingPreset() — Deletes fields mapping preset
• editFieldsMappingPreset() — Edits existing fields mapping preset
• getBankstaRecDetails() — Returns array with certain banksta record content
• getFMPDataJSON() — Returns fields mapping presets in JSON representation
• getFileInfoByHash() — Returns file info for a certain filehash
• getMappingPresets() — Fields mapping presets placeholder getter
• getMappingPresetsCached() — Returns processed bank statements data from cache
• getMappingPresetsSelector() — Returns an HTML-code string containing selector control
• getProcessedBSRecsCached() — Returns processed bank statements data from cache
• getUbMsgHelperInstance() — Returns reference to UbillingMessageHelper object
• getUsersDataCached() — Returns user data from cache
• getUsersDataForCache() — Returns essential user data suitable for caching
• loadMappingPresets() — Load fields mapping presets (FMPs)
• loadProcessedBankstaRecs() — Loads all of banksta rows to private property for further use
• loadProcessedBankstaRecsIDs() — Loads all of banksta rows IDs to private property for further use
• prepareRegexStrings() — Creates essential regex body-strings for preprocessBStatement() processing
• preprocessBStatement() — Bank statement preprocessing and last checks form building
• preprocessImportFile() — Uploaded file preprocessing
• processBankStatement() — Bank statement rows processing and adding to DB
• pushStatementPayments() — Push bank statement payments for users that have been found
• renderBStatementsJQDT() — Returns uploaded statements JQDT control
• renderBStatementsListJSON() — Renders uploaded statements ajax list JSON for JQDT
• renderFMPAddForm() — Returns field mapping preset addition form
• renderFMPEditForm() — Returns field mapping preset editing form
• renderFMPListJSON() — Renders fields mapping presets ajax list JSON for JQDT
• setBankstaRecCanceled() — Marks banksta record as canceled
• setBankstaRecContract() — Changes contract for some banksta record
• setBankstaRecProcessed() — Marks banksta record as processed
• setBankstaRecSrvType() — Changes service type for some banksta record
• setBankstaRecUnCanceled() — Marks banksta record as uncanceled
• uploadFile() — Upload statement file
• web_BSProcessingForm() — Renders a processing form for certain statement determined by hash
• web_FMPForm() — Shows the fields mapping presets form
• web_FieldsMappingForm() — Renders statement preprocessing form with fields mapping
• web_FileUploadForm() — Returns file selection and upload form
• web_LastChecksForm() — Renders a "last checks form" with all the actual payments data that will be imported
• web_MainButtonsControls() — Returns main buttons controls for banksta2