CuAdmin.php

<?php
/**
 * PHP CuAdmin Class
 *
 * Handles CU properties
 */
class CuAdmin {
    // stored in cuadmin.flagset
    const CU_SHOWAVAILABLE                      =          1; //   Show Available balance
    const CU_SHOWIMAGES                         =          2; //   Check image retrieval on
    const CU_3RDPARTYRDC                        =          4; //   Use cuadmin.depositlimit for 3rd party remote deposit
    const CU_MAILTXNS                           =          8; //   Mail copy of transactions to CU
    const CU_SAVETXNS                           =         16; //   Save copy of transaction in database
    const CU_COLLECTEMAIL                       =         32; //   Require email addresses on transfers
    const CU_CALCRUNBAL                         =         64; //   Calculate running balance from account balance
    const CU_SHOWDEPDIVIDEND                    =        128; //   Show Dividend message on deposit accounts
    const CU_SHOWLNINTEREST                     =        256; //   Show YTD Interest message on loans
    const CU_SHOWLNTXNDESC                      =        512; //   Include description when reporting loan transactions
    const CU_SHOWLNTXNSPLIT                     =       1024; //   Show split principle and interest for loan transactions
    const CU_HIDENA                             =       2048; //   If loan balance is NA print zero
    const CU_SORTORDER1                         =       4096; //   Sort account history transactions by ....accounttype, certnumber, tracenumber desc
    const CU_SORTORDER2                         =       8192; //   accounttype, certnumber, date desc, sortkey desc
    const CU_SORTORDER3                         =      16384; //   accounttype, certnumber, date desc, tracenumber desc
    const CU_SORTORDER4                         =      32768; //   btrim(ab.accounttype,'DIS'),ab.certnumber,ah.date desc, tracenumber desc
    const CU_LNBALUNUSABLE                      =      65536; //   loanhistory balance missing -- hide the field
    const CU_LNSORT1                            =     131072; //   Sort loan history transactions by .... lb.loannumber, lh.date desc, lh.tracenumber desc
    const CU_LNSORT2                            =     262144; //   btrim(lb.loannumber,'LC'), lh.date desc, lh.tracenumber desc
    const CU_QIFDOWN                            =     524288; //   Allow QIF download format
    const CU_HIDELOANDATE                       =    1048576; //   Hide Loan Next Payment Date
    const CU_SORTORDER5                         =    2097152; //   accounttype, certnumber, date desc, oid desc
    const CU_MNYDOWN                            =    4194304; //   Allow MNY download format Microsoft Money
    const CU_QKNDOWN                            =    8388608; //   Allow QKN download format Quicken WebConnect
    const CU_SHOWNCUA                           =   16777216; //   Show NCUA logo on Transfer screen
    const CU_SHOWLNRATE                         =   33554432; //   Show Current Interest Rates on Loans
    const CU_SHOWARCLINK                        =   67108864; //   Show link for older check images
    const CU_MEMRESET                           =  134217728; //   Allow members to reset their own password
    const CU_ALLOWSWITCH                        =  268435456; //   Allow members to switch to other accounts w/o login
    const CU_PKT_SWITCH                         =  536870912; //   Switch Account records included in LIVE XAC packet
    const CU_HIDE_PYR                           = 1073741824; //   Hide Prior Year Interest and Dividends
    // stored in cuadmin.flagset2
    const CU2_HIDE_PAYOFF                       =          1; //   Hide Payoff
    const CU2_CALL_PAYOFF                       =          2; //   Show 'Call' for Payoff
    const CU2_SPEC18                            =          4; //   Special Handling for loan type 18 Credit Cards
    const CU2_SHOWCCRATE                        =          8; //   Show interest rate on credit cards
    const CU2_SHOWCCLPAY                        =         16; //   Show Credit Card last paid date
    const CU2_PROCRECUR                         =         32; //   Process Repeating Transactions for this CU, they will NOT be processed until this is set
    const CU2_ALLOWMESSAGE                      =         64; //   Credit Union uses member messaging feature
    const CU2_SORTORDER6                        =        128; //   Sort accounts by .... deposittype, accounttype, certnumber
    const CU2_SHOWTXDEST                        =        256; //   Show Destination Account Number for LIVE Cross-Accts
    const CU2_SHOWHOLD                          =        512; //   Show holds; Expect Hold Transactions in live packet
    const CU2_SHOWCCSB                          =       1024; //   Show Credit Card (type 18) stmnt bal
    const CU2_USEONLDEP                         =       2048; //   Credit Union uses OnLineDeposits
    const CU2_CC18NOINFO                        =       4096; //   Type 18 No balance info available
    const CU2_CC18SHOWZERO                      =       8192; //   Type 18 Show as From/To even if zero available
    const CU2_HIDE_PASTDUE                      =      16384; //   Hide Loan Past Due marker
    const CU2_OFX_MEMACCTID                     =      32768; //   OFX Include Member in ACCTID
    const CU2_OFX_PASSLOAN                      =      65536; //   OFX Include LOAN INFO
    const CU2_10DAYPAY                          =     131072; //   Show 10-day payoff
    const CU2_HIDE_CCAVAIL                      =     262144; //   Credit Card Hide Available
    const CU2_CALL_CCAVAIL                      =     524288; //   Credit Card Show 'Call' for Available
    const CU2_SHOWBANNER                        =    1048576; //   Show banner add in page top
    const CU2_ESCHEMA                           =    2097152; //   Use expanded schema for LoanBalance & LoanHistory
    const CU2_SHOW_LN_ESCROW                    =    4194304; //   Loan History show escrow amount (requires CU2_ESCHEMA)
    const CU2_SHOW_LN_FEE                       =    8388608; //   Loan History show fee amount (requires CU2_ESCHEMA)
    const CU2_FRAMEFREE                         =   16777216; //   Present Members with FRAME-FREE home banking scripts -- Menu is loaded from fmenu.html
    const CU2_ALLOW_MBR_ALERTS                  =   33554432; //   Allow Member Alerts Processing -- Use this to turn on Alert processing for a credit union
    const CU2_ALIAS_REQ                         =   67108864; //   CU requires user_alias as username
    const CU2_SHOWPEND                          =  134217728; //   Show pending; Expect pending Txns in live packet
    const CU2_LNSORT3                           =  268435456; //   lb.oid, lh.date desc, lh.tracenumber desc
    const CU2_RANDOM_CHAL                       =  536870912; //   Show only 1 randomized challenge question at a time
    const CU2_ALIAS_OK                          = 1073741824; //   CU allows user_alias as username
    // stored in cuadmin.flagset3
    const CU3_ESTMNT_SIGNUP                     =      1; //   Flag used to see if member should be able to sign up for E-Statements at first login
    const CU3_ESTMNT_CORE                       =      2; //   Flag for receiving eStatements directly from core
    const CU3_SHOW_ENROLL                       =      4; //   Flag for allowing members to enroll in home banking by showing button on login page
    const CU3_ENROLL_MIR                        =      8; //   Flag for having auto activate use the MIR packet
    const CU3_MFA_AUTHCODE                      =     16; //   CU uses MFA Authcode instead of Challenge Questions
    const CU3_PREPEND_MBR_DESC                  =     32; //   Prepends members to descriptions without custom message
    const CU3_MASK_MBR_DESC                     =     64; //   Masks the member number for descriptions without custom message and previous flag set
    const CU3_API_PLUS                          =    128; //   Use Plus API features (Balance Only, History on demand, M2M)
    const CU3_API_XAC                           =    256; //   Make a XAC packet request from the core for the member
    const CU3_LONGCODE_MFA                      =    512; //   By default Odyssey will use Amazon SMS services for sending MFA Codes.  If this is set then it will use the LONG CODE associated with CU
    const CU3_SORTKEY_MICR                      =   1024; //   Allow contents of sortkey from core to override check micr info at HomeCU
    const CU3_QBDOWN                            =   2048; //   Allow QB download format QuickBooks
    const CU3_ENROLL_PIN                        =   4096; //   Flag for having auto activate use the core PIN
    const CU3_DISALLOW_MULTIPLE_ACCOUNTS        =   8192; //   Flag for disallowing multiple accounts
    const CU3_DISALLOW_MULT_ACCOUNTS_TRANSFER   =  16384; //   Flag for disallowing transfers between different accounts
    const CU3_CREATE_ACCESS_CONTROL_FROM_XAC    =  32768; //   Flag to determine if we create Access_Control Records from XAC entries instead of the overloaded 000#1234123
    const CU3_ALLOW_LEAD_ZEROS                  =  65536; //   Allow CU to have leading zeros on member account numbers
    const CU3_ALLOW_COOKIE_MIGRATION            = 131072; //   Allow CU to migrate older (device) cookies to the new format
    const TABLE_NAME = 'cuadmin';

    //the credit union code to use
    private $creditUnion;
    private $cuAdminRepo;

    //The cu's admin info in an array
    public $admininfo = [];

    /**
     * CuAdmin constructor.
     * @param string        $creditUnion
     *
     * @throws Exception
     */
    public function __construct(string $creditUnion, CuAdminRepo $cuAdminRepo) {

      //make sure a valid CU was supplied
      if ($creditUnion == NULL) {
        throw new Exception(static::class . ": 01 - Invalid credit union {$this->creditUnion}.");
      }

      if (!$cuAdminRepo instanceof CuAdminRepo) {
        throw new Exception(static::class . ": need instance of CuAdminRepo");
      }

      $this->creditUnion = $creditUnion;
      $this->cuAdminRepo = $cuAdminRepo;
      $this->Load();

    }

    /**
     * Load the user model with data
     *
     * @throws Exception
     */
    private function Load() {

      $this->admininfo = $this->cuAdminRepo->Read($this->creditUnion);

      if (!$this->admininfo) {
          throw new Exception(static::class . ": 02 - Invalid credit union {$this->creditUnion}.");
      }

    }
}