pmgr/site/models/tender.php

<?php
class Tender extends AppModel {

	var $belongsTo = array(
		'TenderType',
		'Customer',
		'LedgerEntry',
		'DepositTransaction' => array(
			'className' => 'Transaction',
		),
		'NsfTransaction' => array(
			'className' => 'Transaction',
		),
	);


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: verifyTender
   *  - Verifies consistenty of new tender data
   *    (not in a pre-existing tender)
   */
  function verifyTender($tender) {
    $this->prFunctionLevel(10);
    $this->prEnter(compact('tender'));

    if (empty($tender['tender_type_id'])) {
      return $this->prReturn(false);
    }

    return $this->prReturn(true);
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: addTender
   *  - Inserts new Tender into the database
   */

  function addTender($tender) {
    $this->prEnter(compact('tender'));

    $ret = array();
    if (!$this->verifyTender($tender))
      return $this->prReturn(array('error' => true) + $ret);

    // Come up with a (not necessarily unique) name for the tender.
    // For checks & money orders, this will be based on the check
    // number.  For other types of tender, we'll just use the
    // generic name of the monetary account.
    // REVISIT <AP>: 20090723
    //  I would like to have cash named "Cash #1234", where
    //  the number would correspond to either the Tender ID
    //  or the LedgerEntry ID.
    if (empty($tender['name']) && !empty($tender['account_id'])) {
      $tender['name'] = $this->LedgerEntry->Account->name($tender['account_id']);
      if ($tender['account_id'] == $this->LedgerEntry->Account->checkAccountID() ||
	  $tender['account_id'] == $this->LedgerEntry->Account->moneyOrderAccountID()) {
	$tender['name'] .= ' #' . $tender['data1'];
      }
    }

    $this->pr(20, array('Tender' => $tender),
	      'Pre-Save');

    $this->create();
    if (!$this->save($tender))
      return $this->prReturn(array('error' => true) + $ret);

    $ret['tender_id'] = $this->id;
    return $this->prReturn($ret + array('error' => false));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: nsf
   *  - Flags the ledger entry as having insufficient funds
   *
   *  Steps:
   *   - Get information from Check (C1); for amount $A
   *   - Find Bank Deposit matching to Tender
   *   - New Transaction (T1)
   *   - New Bank Deposit (D1)
   *   - New Tender (N1); NSF; D1, 
   *   - Add new LedgerEntry (L1a); T1; debit:bank; -$A
   *   - Add new LedgerEntry (L1b); T1; credit:NSF; -$A
   *   - Add new LedgerEntry (L2a); T1; debit:NSF;  -$A; N1
   *   - Add new LedgerEntry (L2b); T1; credit:A/R; -$A
   *   - For Tx associated with LE associated with C1:
   *     - For each Payment SE of Tx:
   *     - Add new StatementEntry (S1n); T1; PAYMENT; -1*S1n.amount
   *   - New Transaction (T2) (?????)
   *   - Add new StatementEntry (S2); T2; CHARGE; NSF; $35
   *   - Add new LedgerEntry (L3a); T2; credit:NSF-Fee; $35
   *   - Add new LedgerEntry (L3b); T2; debit:A/R; $35
   *   - Set C1.nsf_tx = T1
   *   - Re-Reconcile (customer may have running credit)
   */

  function nsf($id, $stamp = null) {
    $this->prFunctionLevel(30);
    $this->prEnter(compact('id'));

    // Get information about this NSF item.
    $this->id = $id;
    $tender = $this->find
      ('first', array
       ('contain' =>
	array('LedgerEntry',
	      'DepositTransaction',
	      'NsfTransaction'),
	));
    $this->pr(20, compact('tender'));

    if (!empty($tender['NsfTransaction']['id']))
      die("Item has already been set as NSF");

    if (empty($tender['DepositTransaction']['id']))
      die("Item has not been deposited yet");

    $tender['Transaction'] = $tender['DepositTransaction'];
    unset($tender['DepositTransaction']);
    unset($tender['NsfTransaction']);

    $T = new Transaction();
    $result = $T->addNsf($tender, $stamp);
    if ($result['error'])
      return $this->prReturn(false);

    // Flag the tender as NSF, using the items created from addNsf
    $this->id = $id;
    $this->saveField('nsf_transaction_id', $result['nsf_transaction_id']);
    $this->saveField('nsf_ledger_entry_id', $result['nsf_ledger_entry_id']);

    return $this->prReturn(true);
  }


}
?>