LoanDataGenerator Class Reference

Public Member Functions
	__construct (CsvToArray $csv_obj, DbLoanCreator $db_obj, LoanGeneratorMapper $mapper)
	WaitForInput ()

Protected Member Functions
	Set ($prop, $object)
	SetInputLine ()
	SetConsoleMessage ()
	ProcessInput ()
	IsInputEmpty ()
	UserHasSelectedVolume ()
	UserHasConfirmed ()
	GenerateLoanRecords ()
	ParseCsv ()
	ContinueProcessing ()
	SetDetailTemplate ()
	MapCsvToData ()
	CreateSchemaRecords ($row)
	CreateMasterSchema ($row)
	CreateDetailSchema ($loan_id)
	InsertUserLoan ($loan_id, $user_id, $row)
	InsertChallengeResponses ($user_id)
	InsertUser ($row)
	GetLoanAppUserId ()
	ReturnResponse ()
	SuccessResponses ()
	ErrorResponses ()
	ResetInputValues ()
	UpdateResponses ($response=[])
	UpdateSuccessCounts ($response=[])
	UpdateResponseErrors ($response=[])
	AddNewErrors ($table, $error_arr)
	IsErrors ()

Protected Attributes
	$Mapper
	$CsvToArray
	$DbLoanCreator
	$test_credentials = '1234'
	$confirmed = false
	$num_records = 0
	$csv_line_count = 0
	$line = ''
	$schema_template = 8
	$detail_template = []
	$csv_data = []
	$success_counts = []
	$errors = []

Detailed Description

Copyright

HomeCu 05/2019

Generates sample loans with random for local testing. Run via command line in PHP.

Usage: $obj = new LoanDataGenerator(CsvObject $csv_obj, DbLoanCreator $db_obj, LoanGeneratorMapper $mapper); $obj->execute();

You will be prompted only with "how many loans to create" and asked to confirm. When complete, it will give you the test user passwords to log in with (see DB lnappuser for login info.)

Change the random data by modifying sample-loans-05-19.csv.

Definition at line 17 of file LoanDataGenerator.php.

Constructor & Destructor Documentation

__construct()

LoanDataGenerator::__construct	(	CsvToArray	$csv_obj,
		DbLoanCreator	$db_obj,
		LoanGeneratorMapper	$mapper
	)

LoanDataGenerator constructor.

Parameters

CsvToArray	$csv_obj	instance
DbLoanCreator	$db_obj	instance
LoanGeneratorMapper	$mapper	instance

Returns

void

Definition at line 66 of file LoanDataGenerator.php.

                                                                                                       {

    $this
      ->Set('Mapper', $mapper)
      ->Set('CsvToArray', $csv_obj)
      ->Set('DbLoanCreator', $db_obj);
  }

Member Function Documentation

AddNewErrors()

LoanDataGenerator::AddNewErrors (   $table,   $error_arr  )

protected

Helper for above to simplify code. Don't have to test values, wouldn't be here is there wasn't at least one member in $error_arr

Parameters

string	$table
array	$error_arr

Returns

$this

Definition at line 581 of file LoanDataGenerator.php.

                                                      {

    if (! isset($this->errors[$table])) {
      $this->errors[$table] = [];
    }

    foreach ($error_arr as $err) {
      $this->errors[$table][] = $err;
    }

    return $this;
  }

ContinueProcessing()

LoanDataGenerator::ContinueProcessing ( )

protected

If we have reached number of lines or end of file, stop processing; if exceeded num_records, close the CSV, handle will still be open.

Returns

bool

Definition at line 246 of file LoanDataGenerator.php.

                                          {

    if ($this->csv_line_count > $this->num_records - 1) {
      $this->CsvToArray->CloseFile();
      return false;
    }

    if (! $this->CsvToArray->IsLinesToProcess()) {
      return false;
    }

    return true;

  }

CreateDetailSchema()

LoanDataGenerator::CreateDetailSchema (   $loan_id )

protected

Insert the schema detail records for our current loan.

Parameters

int

$loan_id

Returns

$this

Definition at line 355 of file LoanDataGenerator.php.

                                                  {

    $map = $this->Mapper->CreateDetailTemplateMap($loan_id, $this->detail_template);

    $response = $this->DbLoanCreator->AddSampleData($map);

    $this->UpdateResponses($response);

    return $this;
  }

CreateMasterSchema()

LoanDataGenerator::CreateMasterSchema (   $row )

protected

Create the master schema and return the ID of the inserted record. In later PHP/SQL versions, this will automatically return the record ID inserted, but can't do that here so we are doing two things in one method (which is bad.)

Parameters

array

$row

Exceptions

Exception

Returns

int

Definition at line 339 of file LoanDataGenerator.php.

                                              {

    $map      = $this->Mapper->MasterSchemaMap($row);
    $response = $this->DbLoanCreator->AddSampleData($map);
    $this->UpdateResponses($response);

    $data = $this->DbLoanCreator->GetLastRecord('lnappschemamaster', 'loanid');

    return $data['data']['loanid'];
  }

CreateSchemaRecords()

LoanDataGenerator::CreateSchemaRecords (   $row )

protected

Set the master schema and get the id (see comments below.) Set the detail schema.

Parameters

array

$row

a row of data from the CSV.

Exceptions

Exception

Returns

int

Definition at line 323 of file LoanDataGenerator.php.

                                               {

    $loan_id = $this->CreateMasterSchema($row);
    $this->CreateDetailSchema($loan_id);

    return $loan_id;
  }

ErrorResponses()

LoanDataGenerator::ErrorResponses ( )

protected

Ditto, helper for ReturnResponse().

Returns

string|null

Definition at line 488 of file LoanDataGenerator.php.

                                      {

    $msg = null;

    if ($this->IsErrors()) {
      foreach ($this->errors as $table => $error_arr) {
        foreach ($error_arr as $str) {

            $msg .= "Error for table $table : $str" . PHP_EOL;
        }
      }
    }

    return $msg;
  }

GenerateLoanRecords()

LoanDataGenerator::GenerateLoanRecords ( )

protected

Call up the actual generator class and get busy.

Exceptions

Exception

Returns

string

Definition at line 207 of file LoanDataGenerator.php.

                                           {

    return $this
      ->ParseCsv()
      ->SetDetailTemplate()
      ->MapCsvToData()
      ->ReturnResponse();
  }

GetLoanAppUserId()

LoanDataGenerator::GetLoanAppUserId ( )

protected

Get the user id from the record we just inserted (@TODO since we are now using native pg_methods, we should change our inserts to ' ... returning userid' so we don't need this exrta query)

Returns

int

Definition at line 425 of file LoanDataGenerator.php.

                                        {

    $data = $this->DbLoanCreator->GetLastRecord('lnappuser', 'userid');

    if (isset($data['data']) && isset($data['data']['userid'])) {
      return $data['data']['userid'];
    }

    return 0;
  }

InsertChallengeResponses()

LoanDataGenerator::InsertChallengeResponses (   $user_id )

protected

Insert three random challenge responses so we can test login process.

Parameters

int

$user_id

Exceptions

Exception

Returns

$this

Definition at line 393 of file LoanDataGenerator.php.

                                                        {

    $rand_resp  = $this->Mapper->MapRandomQuestionResponses($user_id, $this->test_credentials);
    $response   = $this->DbLoanCreator->AddSampleData($rand_resp);
    $this->UpdateResponses($response);

    return $this;
  }

InsertUser()

LoanDataGenerator::InsertUser (   $row )

protected

Insert the user data for the loan. Do first so we can get a user id. (@TODO since we are now using native pg_methods, we should change our inserts to ' ... returning userid'

Parameters

$row

Returns

$this

Definition at line 409 of file LoanDataGenerator.php.

                                      {

    $user_map = $this->Mapper->MapUserData($row, $this->test_credentials);
    $response = $this->DbLoanCreator->AddSampleData($user_map);

    $this->UpdateResponses($response);

    return $this;
  }

InsertUserLoan()

LoanDataGenerator::InsertUserLoan (   $loan_id,   $user_id,   $row  )

protected

Insert the loan data. (@TODO since we are now using native pg_methods, we should change our inserts to ' ... returning userid' so we don't need this exrta query)

Parameters

int	$loan_id
int	$user_id
array	$row

Exceptions

Exception

Returns

$this

Definition at line 376 of file LoanDataGenerator.php.

                                                              {

    // Create a json map [csv key] => [formfield_[this schema field id]]
    $data     = $this->DbLoanCreator->GetList('lnappschemadetail', 'loanid', $loan_id);
    $map_user = $this->Mapper->MapUserLoan($user_id, $loan_id, $row, $data);
    $response = $this->DbLoanCreator->AddSampleData($map_user);
    $this->UpdateResponses($response);

    return $this;
  }

IsErrors()

LoanDataGenerator::IsErrors ( )

protected

Got errors?

Returns

bool

Definition at line 598 of file LoanDataGenerator.php.

                                {

    return count($this->errors) > 0;
  }

IsInputEmpty()

LoanDataGenerator::IsInputEmpty ( )

protected

Is $this->line property empty? (or zero)

Returns

bool

Definition at line 179 of file LoanDataGenerator.php.

                                    {

      return empty($this->line);
  }

MapCsvToData()

LoanDataGenerator::MapCsvToData ( )

protected

For each line of the CSV, map the data to the tables, which is an unavoidable several steps. We must first get the user insert so we can have a user ID for the question records. Then we can move on to the loan, but there is no clear way to associate our CSV fields with loan data fields to create formname_[schema record id] for the JSON. This form key pattern is what makes the data load properly in the end user loan app.

Exceptions

Exception

Returns

$this

Definition at line 289 of file LoanDataGenerator.php.

                                    {

    if ($this->IsErrors()) {
      return $this;
    }

    $count = 0;

    foreach ($this->csv_data as $index => $row) {

      $count++;
      $loan_id = $this->CreateSchemaRecords($row);
      $this->InsertUser($row);
      $user_id = $this->GetLoanAppUserId();

      $this
        ->InsertUserLoan($loan_id, $user_id, $row)
        ->InsertChallengeResponses($user_id);

      // Should already be done at continueProcessing, double guard.
      if ($count >= $this->num_records) {
        break;
      }
    }

    return $this;
  }

ParseCsv()

LoanDataGenerator::ParseCsv ( )

protected

Use CsvToArray to parse the CSV file into an array.

Returns

$this

Definition at line 221 of file LoanDataGenerator.php.

                                {

     while ($this->ContinueProcessing()) {

      $this->csv_line_count++;

      $data = $this->CsvToArray->ParseData();

      if (isset($data['errors']) && (count($data['errors']) > 0)) {
        // Mock a table handle to canonicalize error output.
        $this->AddNewErrors('csv', $data['errors']);
        return $this;
      }

      $this->csv_data[] = $data['data'];
    }

    return $this;
  }

ProcessInput()

LoanDataGenerator::ProcessInput ( )

protected

Process the command line input.

Returns

string

Definition at line 151 of file LoanDataGenerator.php.

                                    {

    if ($this->line === 'q') {
      return "Exiting program . . ." . PHP_EOL;
      exit;
    }

    if (! $this->UserHasSelectedVolume()) {
      $this->num_records = $this->line;


    } elseif (! $this->UserHasConfirmed()) {

      if ($this->line === 'n') {
        $this->num_records = 0;
        return '';
      }

      $this->confirmed = $this->line === 'y';
    }

    return '';
  }

ResetInputValues()

LoanDataGenerator::ResetInputValues ( )

protected

When done, flush these out to return to the prompt screen.

Returns

$this

Definition at line 508 of file LoanDataGenerator.php.

                                        {

    $this->num_records  = 0;
    $this->confirmed    = false;

    return $this;
  }

ReturnResponse()

LoanDataGenerator::ReturnResponse ( )

protected

Compose a response that should be everything that went right. Or wrong.

Returns

string

Definition at line 440 of file LoanDataGenerator.php.

                                      {

    $plural = ($this->num_records == 1)? 'record' : 'records';

    $msg = "
          Done creating {$this->num_records} loan $plural." .
          PHP_EOL .
          "
          To test users, select returning non member at the loan app 
          screen and log in. All passwords and security questions are
          answered with '{$this->test_credentials}.'" .
          PHP_EOL .
          $this->SuccessResponses() .
          $this->ErrorResponses() .
          PHP_EOL .
          "
          When you are done testing, run 'php cleanup-test-records.php'
          to remove all test records. Type 'q' to exit." .
          PHP_EOL;

    $this->ResetInputValues();

    return $msg;
  }

Set()

LoanDataGenerator::Set (   $prop,   $object  )

protected

A typical setter, sets internal properties (CsvToArray, DbLoanCreator, LoanGeneratorMapper) Usually setters are public, don't think we'll need it

Parameters

string	prop property identifier
mixed	property to set

Returns

$this

Definition at line 99 of file LoanDataGenerator.php.

                                         {

    $this->{$prop} = $object;

    return $this;
  }

SetConsoleMessage()

LoanDataGenerator::SetConsoleMessage ( )

protected

Set prompt messages. These prompts should come in this order.

Exceptions

Exception

Returns

string

Definition at line 124 of file LoanDataGenerator.php.

                                         {

    if ($this->UserHasConfirmed()) {
      // Set loose the Kraken.
      echo "One moment, generating loan data . . . " . PHP_EOL;
      return $this->GenerateLoanRecords();
    }

    if ($this->UserHasSelectedVolume()) {
      return "
        This program will now generate {$this->num_records} loan records.
        Enter y to continue, n to cancel:" . PHP_EOL;
    }

    if ($this->IsInputEmpty() || ! $this->UserHasSelectedVolume()) {
      return "
        Enter q to quit at any time.
        Enter the number of loan records you would like to generate:" . PHP_EOL;
    }

    return null;
  }

SetDetailTemplate()

LoanDataGenerator::SetDetailTemplate ( )

protected

Get detail record ID 8 to be applied to every loan we insert. All we will need to do is swap out loan id and unset detail id for each record, see Mapper->createDetailTemplateMap()

Returns

$this

Definition at line 267 of file LoanDataGenerator.php.

                                         {

    if ($this->IsErrors()) {
      return $this;
    }

    $data = $this->DbLoanCreator->getList('lnappschemadetail', 'loanid', $this->schema_template);

    $this->detail_template = $data['data'];

    return $this;
  }

SetInputLine()

LoanDataGenerator::SetInputLine ( )

protected

Set the line entered from input, if there is one.

Returns

$this

Definition at line 110 of file LoanDataGenerator.php.

                                    {

    $handle     = fopen ("php://stdin","r");
    $this->line = trim(fgets($handle));
    fclose($handle);

    return $this;
  }

SuccessResponses()

LoanDataGenerator::SuccessResponses ( )

protected

Helper for returnResponse(). walk the successful insert counts and create sensible message strings of them.

Returns

string|null

Definition at line 470 of file LoanDataGenerator.php.

                                        {

    $msg = null;
    if (count($this->success_counts) > 0) {
      foreach ($this->success_counts as $table => $count) {

        $plural = ($count == 1)? 'record' : 'records';
        $msg .= "$count $plural inserted for table $table." . PHP_EOL;
      }
    }

    return $msg;
  }

UpdateResponseErrors()

LoanDataGenerator::UpdateResponseErrors (   $response = [] )

protected

Set any response errors in our response array. Walking through and adding in the event other errors are added before or after.

Parameters

array

$response

Returns

$this

Definition at line 562 of file LoanDataGenerator.php.

                                                          {

    if ((isset($response['errors']) && count($response['errors']) > 0)) {
      foreach ($response['errors'] as $table => $error_arr) {

        $this->AddNewErrors($table, $error_arr);
      }
    }

    return $this;
  }

UpdateResponses()

LoanDataGenerator::UpdateResponses (   $response = [] )

protected

Update the error array and success counts.

Parameters

array

$response

Returns

$this

Definition at line 521 of file LoanDataGenerator.php.

                                                     {

    if (count($response) == 0) {
      return $this;
    }

    $this
      ->UpdateSuccessCounts($response)
      ->UpdateResponseErrors($response);

    return $this;
  }

UpdateSuccessCounts()

LoanDataGenerator::UpdateSuccessCounts (   $response = [] )

protected

Update the success counts, to be used in a plain-English message in ReturnResponse().

Parameters

array

$response

Returns

$this

Definition at line 539 of file LoanDataGenerator.php.

                                                         {

    if ((isset($response['success']) && count($response['success']) > 0)) {
      foreach ($response['success'] as $table => $count) {

        if (isset($this->success_counts[$table])) {
          $this->success_counts[$table] += $response['success'][$table];
          continue;
        }

        $this->success_counts[$table] = $response['success'][$table];
      }
    }

    return $this;
  }

UserHasConfirmed()

LoanDataGenerator::UserHasConfirmed ( )

protected

Has the user confirmed their choice?

Returns

bool

Definition at line 197 of file LoanDataGenerator.php.

                                        {

    return $this->confirmed === true;
  }

UserHasSelectedVolume()

LoanDataGenerator::UserHasSelectedVolume ( )

protected

Has the user selected how many records to create?

Returns

bool

Definition at line 188 of file LoanDataGenerator.php.

                                             {

    return $this->num_records > 0;
  }

WaitForInput()

LoanDataGenerator::WaitForInput

(

)

Entry point. Wait for user input once started.

Exceptions

Exception

Returns

string

Definition at line 79 of file LoanDataGenerator.php.

                                 {

    while ($this->line !== 'q') {

      echo $this->SetConsoleMessage();
      echo $this
        ->SetInputLine()
        ->ProcessInput();
    }

    return '';
  }

---

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

• tools/cumanage/fixtures/bill/sample-loans/LoanDataGenerator.php