LoanGeneratorMapper.php

<?php
/**
 * @copyright HomeCu 05/2019
 *
 * Maps and array of CSV test data to the DB field data. There is no direct 1:1 mapping
 * we can build easily. We have to go into the JSON in lnnappschemadetail->fieldattr
 * and look for a match on "responsetablefield" or "fieldcorename" to correctly
 * map CSV fields to DB fields.
 *
 * Injects into LoanDataGenerator class and probably has no other useful
 * application, but **does** allow LoanDataGenerator to utilize a
 * different mapper if it applies.
 */
class LoanGeneratorMapper
{

  /** @var string $cu - loans currently only work in dev for CRUISECU */
  protected $cu = 'SCRUBSCU';
  /**
   * LoanGeneratorMapper constructor.
   * @param string $cu
   * @return void
   */
  public function __construct($cu = '') {

    if (! empty($cu)) {
      $this->cu = $cu;
    }
  }

  /**
   * Using the master template, create the template for this loan.
   * @param int $loan_id
   * @param array $map (of detail schema template)
   * @return array
   */
  public function CreateDetailTemplateMap($loan_id, $map) {

    $count  = count($map);

    for ($i = 0; $i < $count; $i++) {
      if (isset($map[$i]['detailid'])) {
        unset($map[$i]['detailid']);
      }

      $map[$i]['loanid'] = $loan_id;
    }

    return [
      'lnappschemadetail' => $map
    ];
  }


  /**
   * Map the lnappschemamaster table.
   * @param array $row
   * @return array
   * @throws Exception
   */
  public function masterSchemaMap($row) {

    $dt = new DateTime();
    return [
      'lnappschemamaster' => [
          [
            'cu'                      => $this->cu,
            'loantitle'               => "{$row['b_fname']} {$row['b_lname']} {$row['loan_purpose']} Loan",
            'loandisclosure_fragment' => '',
            'lastmodified'            => $dt->format('Y-m-d')
          ]
      ]
    ];
  }

  /**
   * Compile three sample challenge answers all this the same answer
   * @param string $test_credentials
   * @param int $user_id
   * @return array
   */
  public function mapRandomQuestionResponses($user_id, $test_credentials) {

    $insert = [];
    $qids   = [rand(50, 65)];

    while (count($qids) < 3) {
      $qids = $this->AddToArray($qids);
    }

    foreach ($qids as $id) {
      $insert[] = [
        'userid'      => $user_id,
        'questid'     => $id,
        'user_answer' => $test_credentials
      ];
    }

    return ['lnappuser_questselect' => $insert];
  }

  /**
   * Helper for above.
   * @param array $arr
   * @return array
   */
  protected function AddToArray($arr) {

    $id = rand(50, 65);

    if (! in_array($id, $arr)) {
      array_push($arr, $id);
    }
    return $arr;
  }


  /**
   * map the user data
   * @param array $row
   * @param string $test_credentials
   * @return array
   */
  public function MapUserData($row, $test_credentials) {

    return [
      'lnappuser' => [
        [
          'email'               => $row['b_email'],
          'pwd'                 => password_hash($test_credentials, PASSWORD_DEFAULT),
          'allow_e_comm'        => 0,
          'cu'                  => $this->cu,
          'confidenceword'      => $test_credentials,
          'failedloginattempts' => 0,
          'challenge_quest_id'  => -1,
          'userlogintype'       => null,
          'banking_user_id'     => 0,
          'session_account'     => null
        ]
      ]
    ];
  }
  /**
   * map the loan data
   * @param int $user_id
   * @param int $loan_id
   * @param array $row
   * @param array $data = entire data loan set
   * @throws Exception
   * @return array
   */
  public function MapUserLoan($user_id, $loan_id, $row, $data) {

    $dt   = new DateTime();
    $date = $dt->format('Y-m-d');

    // @TODO initially wanted to build this as one call, but didn't work out, de-nest these
    return [
      'lnappuserresponse' => [
        [
          'userid'            => $user_id,
          'loanid'            => $loan_id,
          'respstatus'        => 0,
          'respcomments'      => '',
          'respcoreloanappid' => -1,
          'respstarton'       => $date,
          'respsubmiton'      => null,
          'respmodifiedon'    => $date,
          'respfname'         => $row['b_fname'],
          'resplname'         => $row['b_lname'],
          'respmname'         => $row['b_mname'],
          'respssn'           => $row['b_ssn'], // SOOOOO bad.
          'respdob'           => $row['b_dob'],
          'respmember'        => '',
          'respphone'         => '',
          'respapplication'   => $this->CreateJsonApp( $row, $data),
          'respstatusdesc'    => null,
          'respamt'           => $row['loan_amount'],
          'resplastinquire'   => null
        ]
      ]
    ];
  }

  /**
   * Find the **correct** detail id in the schema template for this app and create the JSON
   * array that will go into the field respapplication.
   * @param array $row
   * @param array $data = entire data set for creation of JSON.
   * @return string
   */
  protected function CreateJsonApp($row, $data) {

    $json_map = $this->CreateJsonMap($row, $data['data']);

    // Using this map, create an array with proper field->value associations
    // Could do `return json_encode($this->MapCsvToJsonArray($row, $json_map))`
    // Left the var set do we can just output $mapped on it's own in debug
    $mapped = $this->MapCsvToJsonArray($row, $json_map);

    // return it json encoded for storing in the app record.
    return json_encode($mapped);
  }


  /**
   * Here we map the actual data to the record ID found and set in createJsonMap(). So what we have done is
   * 1) Find the detailid in each field of this record's schemadetail by parsing the JSON of fieldattr
   *    in template, in the example below, 1234
   * 2) Created an array associating our "json field names" with the CSV names as in
   *    'productname' => 'formfield_1234'
   * 4) Below we create the "finished" array with values associated with "json field names" as in
   *    'formfield_1234' => 'HomeCu'
   * 5) "Never time to do it right . . . ."
   * @param array $row
   * @param array $json_map
   * @return array
   */
  protected function MapCsvToJsonArray($row, $json_map) {

    $data = [];

    foreach ($row as $key => $value) {
      if (array_key_exists($key, $json_map)) {
        $data[$json_map[$key]] = $value;
      }
    }

    return $data;
  }

  /**
   * Here we attempt to map to the field in the detail template.
   * @param array $row
   * @param array $tpl
   * @return array
   */
  protected function CreateJsonMap($row = [], $tpl = []) {

    $map = [];

    foreach ($row as $field => $value) {

      $id = $this->FindFieldId($field, $tpl);

      // Not logging these to the errors array. It's not helpful and it
      // just means some fields won't be in the JSON
      if (! $id) {
        continue;
      }

      $map[$field] = 'formfield_' . $id;
    }

    return $map;
  }

  /**
   * Attempt to locate the matching array key "responsetablefield" or "fieldcorename"
   * If it matches the mapping of one or the other, return the record ID.
   * @param string $field
   * @param array $tpl
   * @return int|null
   */
  protected function FindFieldId($field, $tpl) {

    foreach ($tpl as $arr) {

      $field_attr = $this->DecodeFieldAttr($arr);

      if (empty($field_attr)) {
        continue;
      }

      if (! empty($this->FindFieldIdentifier($field, $field_attr))) {
        return $arr['detailid'];
        break;
      }
    }

    return null;
  }

  /**
   * Parse fieldattr and return the array. Should never fail but . . .
   * @param array $field_arr
   * @return array|null
   */
  protected function DecodeFieldAttr($field_arr = []) {

    if (empty($field_arr)) {
      return null;
    }

    if (! (
      array_key_exists('fieldattr', $field_arr) &&
      ! empty($field_arr['fieldattr'])
    )) {
      return null;
    }

    return json_decode($field_arr['fieldattr'], 1);

  }

  /**
   * Map the CSV field $field to either the local response table field or core field name.
   * This will tell us which "schema record id" to use in the JSON.
   * @param $field
   * @param $field_attr
   * @return string|null
   */
  protected function FindFieldIdentifier($field, $field_attr) {

    $local  = (array_key_exists('responsetablefield', $field_attr))?  $field_attr['responsetablefield'] : null;
    $core   = (array_key_exists('fieldcorename', $field_attr))?       $field_attr['fieldcorename']      : null;

    if (! ($local || $core)) {
      return null;
    }

    $arr = [
      'product'           => ['local' => null,          'core' => 'productname'],
      'loan_purpose'      => ['local' => null,          'core' => 'lnpurpose'],
      'loan_type'         => ['local' => null,          'core' => 'loantype'],
      // No mapping for this one, I guess let it return null
      'app_started'       => ['local' => null,          'core' => null],
      'loan_amount'       => ['local' => 'respamt',     'core' => 'amtreqd'],
      'individual_joint'  => ['local' => null,          'core' => 'indvjoint'],
      'disab_ins'         => ['local' => null,          'core' => 'appcdioption'],
      'credit_ins'        => ['local' => null,          'core' => 'appclioption'],
      'b_fname'           => ['local' => 'respfname',   'core' => 'dms_appfname'],
      'b_mname'           => ['local' => 'respmname',   'core' => 'dms_appmname'],
      'b_lname'           => ['local' => 'resplname',   'core' => 'dms_applname'],
      'b_ssn'             => ['local' => 'respssn',     'core' => 'dms_apptin'],
      'b_account'         => ['local' => 'respmember',  'core' => 'dms_accountnumber'],
      'b_dob'             => ['local' => 'respdob',     'core' => 'appbirthdate'],
      'b_email'           => ['local' => null,          'core' => 'appemail'],
      'b_home_ph'         => ['local' => null,          'core' => 'apphomephone'],
      'b_work'            => ['local' => null,          'core' => 'appworkphone'],
      'b_cell'            => ['local' => null,          'core' => 'appcellphone'],
      'b_years_residence' => ['local' => null,          'core' => 'appyearsataddress'],
      'b_address'         => ['local' => null,          'core' => 'appaddr'],
      'b_city'            => ['local' => null,          'core' => 'dms_appcity'],
      'b_state'           => ['local' => null,          'core' => 'dms_appst'],
      'b_zip'             => ['local' => null,          'core' => 'dms_appzip'],
      'b_employer'        => ['local' => null,          'core' => 'appemployer'],
      'b_monthly_income'  => ['local' => null,          'core' => 'appmonthincome'],
      'b_emp_status'      => ['local' => null,          'core' => 'appemploystatus'],
      'b_job_title'       => ['local' => null,          'core' => 'appjobtitle'],
      'b_emp_started_on'  => ['local' => null,          'core' => 'appjobstartdate'],
      'b_income_other'    => ['local' => null,          'core' => 'appotherincome'],
      'b_inc_other_src'   => ['local' => null,          'core' => 'appotherincomesource'],
      'b_own_rent'        => ['local' => null,          'core' => 'apphousingtype'],
      'b_monthly_housing' => ['local' => null,          'core' => 'apphousingpmt'],
      // Child support left out "fieldcorename":"appchildsupportdesc" "fieldcorename":"appchildsupportpmt"
      'b_ref_fname'       => ['local' => null,          'core' => 'dms_appreffname'],
      'b_ref_lname'       => ['local' => null,          'core' => 'dms_appreflname'],
      'b_ref_addr'        => ['local' => null,          'core' => 'apprefaddr'],
      // What's with the "1" in these three ONLY?
      'b_ref_city'        => ['local' => null,          'core' => 'dms_appref1city'],
      'b_ref_state'       => ['local' => null,          'core' => 'dms_appref1st'],
      'b_ref_zip'         => ['local' => null,          'core' => 'dms_appref1zip'],
      'b_ref_phone'       => ['local' => null,          'core' => 'apprefphone'],
      'b_ref_relation'    => ['local' => null,          'core' => 'appreftype'],
      'c_fname'           => ['local' => null,          'core' => 'dms_coappfname'],
      'c_mname'           => ['local' => null,          'core' => 'dms_coappmname'],
      'c_lname'           => ['local' => null,          'core' => 'dms_coapplname'],
      'c_ssn'             => ['local' => null,          'core' => 'coapptin'],
      // No mapping for this one
      'c_account'         => ['local' => null,          'core' => null],
      'c_dob'             => ['local' => null,          'core' => 'coappbirthdate'],
      'c_email'           => ['local' => null,          'core' => 'coappemail'],
      'c_home_ph'         => ['local' => null,          'core' => 'coapphomephone'],
      'c_work'            => ['local' => null,          'core' => 'coappworkphone'],
      'c_cell'            => ['local' => null,          'core' => 'coappcellphone'],
      'c_years_residence' => ['local' => null,          'core' => 'coappyearsataddress'],
      'c_address'         => ['local' => null,          'core' => 'coappaddr'],
      'c_city'            => ['local' => null,          'core' => 'dms_coappaddrcity'],
      'c_state'           => ['local' => null,          'core' => 'dms_coappaddrst'],
      'c_zip'             => ['local' => null,          'core' => 'dms_coappaddrzip'],
      'c_employer'        => ['local' => null,          'core' => 'coappemployer'],
      'c_monthly_income'  => ['local' => null,          'core' => 'coappmonthincome'],
      // No mapping for this one
      'c_emp_status'      => ['local' => null,          'core' => null],
      'c_job_title'       => ['local' => null,          'core' => 'coappjobtitle'],
      'c_emp_started_on'  => ['local' => null,          'core' => 'coappjobstartdate'],
      'c_income_other'    => ['local' => null,          'core' => 'coappotherincome'],
      'c_inc_other_src'   => ['local' => null,          'core' => 'coappotherincomesource'],
      'c_own_rent'        => ['local' => null,          'core' => 'coapphousingtype'],
      // Why is there mortgage desc. here and not for main? Leaving both out.
      'c_monthly_housing' => ['local' => null,          'core' => 'coapphousingpmt'],
      // Child support left out.
      'c_ref_fname'       => ['local' => null,          'core' => 'dms_coappreffname'],
      'c_ref_lname'       => ['local' => null,          'core' =>'dms_coappreflname'],
      'c_ref_addr'        => ['local' => null,          'core' => 'coapprefaddr'],
      'c_ref_city'        => ['local' => null,          'core' => 'dms_coappref1city'],
      'c_ref_state'       => ['local' => null,          'core' => 'dms_coappref1st'],
      'c_ref_zip'         => ['local' => null,          'core' => 'dms_coappref1zip'],
      'c_ref_phone'       => ['local' => null,          'core' => 'coapprefphone'],
      'c_ref_relation'    => ['local' => null,          'core' => 'coappreftype']
    ];

    // These return values aren't used for anything but debugging and to test for
    // an empty response or not, to confirm we have a mapping.
    if (array_key_exists($field, $arr)) {
      $map = $arr[$field];
      if (! is_null($local) && ($map['local'] == $local)) {
          return 'local';
      }
      if (! is_null($core) && ($map['core'] == $core)) {
        return 'core';
      }
    }

    return null;

  }

}