DbLoanCreator Class Reference

Public Member Functions
	__construct ($DbObject)
	AddSampleData ($data=[])
	GetRecord ($table, $keyfield, $value)
	GetLastRecord ($table, $keyfield)
	GetList ($table, $keyfield, $value)

Protected Member Functions
	Set ($prop, $object)
	InitResponse ()
	AddRecords ()
	PopulateTable ($table='', $data=[])
	BuildInsertStatement ($table)
	IsAtLeastTableAndData ($table, $data)
	ReturnResponse ()
	IsErrors ()

Protected Attributes
	$DbObj
	$data = []
	$response = []

Detailed Description

Copyright

HomeCu 05/2019

A class specifically for adding sample data to loans. Not used directly; inject this object into your consumer class then call public addSampleData() with an array of prepared/mapped data.

$obj->addSampleData([array data]);

Expects

array[ [table identifier] = [ [ [field identifier] => [value], // for each field to insert ] ], // for each table to insert data ]

Returns array [ 'success' => [ [table name] => [int n count of successes], // for each table ], 'errors' => [ [table name] => array[ [string specific error], // for each error in this table ], // for each table ] ]

Definition at line 38 of file DbLoanCreator.php.

Constructor & Destructor Documentation

__construct()

DbLoanCreator::__construct

(

$DbObject

)

Constructor, initialize the database link object (your "$dbh")

Parameters

object

$DbObject

Returns

void

Definition at line 54 of file DbLoanCreator.php.

                                         {

    $this->Set('DbObj', $DbObject);
  }

Member Function Documentation

AddRecords()

DbLoanCreator::AddRecords ( )

protected

Add records using $this->data.

Returns

$this

Definition at line 193 of file DbLoanCreator.php.

                                  {

    foreach ($this->data as $table => $data) {

      if ($this->IsErrors()) {

        return $this;
      }

      if ($this->PopulateTable($table, $data)) {
        if (isset($this->response['success'][$table])) {
          $this->response['success'][$table]++;
          continue;
        }
        // else ...
        $this->response['success'][$table] = 1;
      }
    }

    return $this;
  }

AddSampleData()

DbLoanCreator::AddSampleData

(

$data = []

)

Entry point, add data to the DB and respond with errors or success log. Note we flush out response array with each call or it will exponentially add counts and errors to earlier values.

Parameters

array

$data

already mapped to DB fields

Returns

array

Definition at line 66 of file DbLoanCreator.php.

                                            {

    return $this
      ->Set('data', $data)
      ->InitResponse()
      ->AddRecords()
      ->ReturnResponse();
  }

BuildInsertStatement()

DbLoanCreator::BuildInsertStatement (   $table )

protected

Build the insert statements. Generally I would prefer to dynamically create fields and values but you have two choices in PHP for PostgreSql: fiddle about with data types and figure out which to escape and which not, or use pg_query_params which solves that and other issues (such as SQL injection.) The problem then becomes that the placeholders can't be dynamic, you need placeholders like $1, $2, etc. We only have a few tables in a test script so letting it slide. Just be sure the fields correspond . . .

Parameters

string

$table

Returns

string

Definition at line 253 of file DbLoanCreator.php.

                                                  {

    switch($table) {

      case 'lnappuser':
        return "insert into $table (email, pwd, allow_e_comm, cu, confidenceword,
                failedloginattempts, challenge_quest_id, userlogintype, banking_user_id,
                session_account) values($1, $2, $3, $4, $5, $6, $7, $8, $9, $10)";

      case 'lnappschemadetail':
        return "insert into $table (loanid, pageid, groupid, lineid, fieldtype,
                fieldvalue, fieldattr) values($1, $2, $3, $4, $5, $6, $7)";

      case 'lnappuserresponse':
        return "insert into $table (userid, loanid, respstatus, respcomments,
              respcoreloanappid, respstarton, respsubmiton, respmodifiedon, respfname,
              resplname, respmname, respssn, respdob, respmember, respphone, respapplication,
              respstatusdesc, respamt, resplastinquire) values($1, $2, $3, $4, $5, $6, $7, $8,
              $9, $10, $11, $12, $13, $14, $15, $16, $17, $18, $19)";

      case 'lnappschemamaster':
        return "insert into $table (cu, loantitle, loandisclosure_fragment, lastmodified) values($1, $2, $3, $4)";

      case 'lnappuser_questselect':
        return "insert into $table(userid, questid, user_answer) values($1, $2, $3)";

      default:
        return '';
    }
  }

GetLastRecord()

DbLoanCreator::GetLastRecord	(		$table,
			$keyfield
	)

We should be using the native OID method OR "returning [keyfield]" on inserts but for various reasons this is problematic. Get the last inserted ID.

Parameters

string	$table
string	$keyfield

Returns

array

Definition at line 111 of file DbLoanCreator.php.

                                                   {

    $sql      = "select $keyfield from $table order by $keyfield desc limit 1";
    $msg_part = "table $table, key field $keyfield SQL $sql";
    $result   = pg_query($this->DbObj, $sql);

    if (! $result) {
      return [
        'error' => "No DB result in GetLastRecord $msg_part " . pg_last_error(),
        'data' =>  []
      ];
    }

    $res = pg_fetch_assoc($result);

    return [
      'error' => ($res)? null : "No result found for $msg_part in GetLastRecord",
      'data' => ($res)? $res : []
    ];
  }

GetList()

DbLoanCreator::GetList	(		$table,
			$keyfield,
			$value
	)

Generally used to get the entire schema template record, get multiple rows by a single keyfield.

Parameters

string	$table
string	$keyfield
int	$value

Returns

array

Definition at line 140 of file DbLoanCreator.php.

                                                     {

    $sql      = "select * from $table where $keyfield = $1 order by $keyfield asc";
    $msg_part = "table $table, key field $keyfield value $value SQL $sql";
    $result   = pg_query_params($this->DbObj, $sql, [$value]);

    if (! $result) {
      return [
        'error' => "No DB result in GetList $msg_part " . pg_last_error(),
        'data' =>  []
      ];
    }

    $res = pg_fetch_all($result);

    return [
      'error' => ($res)? null : "No result found for $msg_part in GetList",
      'data' => ($res)? $res : []
    ];
  }

GetRecord()

DbLoanCreator::GetRecord	(		$table,
			$keyfield,
			$value
	)

The following three don't really belong in a "creator" but since there's no DB layer, here they are. GetRecord() gets a single record by a single field value (usually id.)

Parameters

string	$table
string	$keyfield
int	$value

Returns

array

Definition at line 83 of file DbLoanCreator.php.

                                                       {

    $sql      = "select * from $table where $keyfield = $1";
    $msg_part = "table $table, key field $keyfield, value $value SQL $sql";
    $result   = pg_query_params($this->DbObj, $sql, [$value]);

    if (! $result) {
      return [
        'error' => "No DB result in getRecord $msg_part " . pg_last_error(),
        'data' =>  []
      ];
    }

    $res = pg_fetch_assoc($result);

    return [
      'error' => ($res)? null : "No result found for $msg_part in getRecord",
      'data' => ($res)? $result : []
    ];
  }

InitResponse()

DbLoanCreator::InitResponse ( )

protected

Set the response array. Response will be two arrays, successes and errors. Both are returned giving a running log of the process, see doc block at head.

Returns

$this

Definition at line 179 of file DbLoanCreator.php.

                                    {

    $this->response = [
      'success' => [],
      'errors'  => []
    ];

    return $this;
  }

IsAtLeastTableAndData()

DbLoanCreator::IsAtLeastTableAndData (   $table,   $data  )

protected

Not much validation, being a command line script you should only be sending The Good Stuff. Setting a var so we can collect multiple errors (and improve validation if needed)

Parameters

string	$table
array	$data

Returns

bool

Definition at line 291 of file DbLoanCreator.php.

                                                          {

    $valid = true;

    if (empty($table)) {
      $this->response['errors'][$table][] = "Empty table value found, fix it.";
      $valid = false;
    }

    if (count($data) == 0) {
      $this->response['errors'][$table][] = "Empty data array found, fix it.";
      $valid = false;
    }

    return $valid;
  }

IsErrors()

DbLoanCreator::IsErrors ( )

protected

Got errors?

Returns

bool

Definition at line 321 of file DbLoanCreator.php.

                                {

    return count($this->response['errors']) > 0;
  }

PopulateTable()

DbLoanCreator::PopulateTable (   $table = '',   $data = []  )

protected

Populate the table with records from the data rows, one by one, using pg_query_params to avoid futzing about with quoting and escaping. Could probably compile as one statement, but it's cmd line and light.

Parameters

string	$table
array	$data

Returns

bool

Definition at line 223 of file DbLoanCreator.php.

                                                            {

    if (! $this->IsAtLeastTableAndData($table, $data)) {
      return false;
    }

    foreach ($data as $arr) {

      $sql    = $this->BuildInsertStatement($table);
      $result = pg_query_params($this->DbObj, $sql, $arr);

      if (! $result) {
        $this->response['errors'][$table][] = "Failed on insert: $sql last error: " . pg_last_error();
        return false;
      }
    }

    return true;
  }

ReturnResponse()

DbLoanCreator::ReturnResponse ( )

protected

Return a response, this approach allows chaining of methods above it.

Returns

array

Definition at line 312 of file DbLoanCreator.php.

                                      {

    return $this->response;
  }

Set()

DbLoanCreator::Set (   $prop,   $object  )

protected

A typical setter, sets internal properties (DbObj, cu) Usually these are public, don't think we'll need it

Parameters

string	prop property identifier
mixed	property to set

Returns

$this

Definition at line 168 of file DbLoanCreator.php.

                                         {

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

---

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

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