pmgr/site/models/account.php

<?php
class Account extends AppModel {

	var $hasOne = array(
		'CurrentLedger' => array(
			'className' => 'Ledger',
			// REVISIT <AP> 20090702:
			//   I would prefer this statement, which has no
			//   engine specific code.  However, it doesn't
			//   work with the Linkable behavior.  I need to
			//   look into that, just not right now.
			//'conditions' => array(array('CurrentLedger.close_transaction_id' => null)),
			'conditions' => array('CurrentLedger.close_transaction_id IS NULL'),
		),
	);

	var $hasMany = array(
		'Ledger',
		'LedgerEntry',
	);


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: type
   *  - Returns the type of this account
   */
  function type($id) {
    $this->cacheQueries = true;
    $account = $this->find('first', array
			   ('recursive' => -1,
			    'fields' => array('type'),
			    'conditions' => array(array('Account.id' => $id)),
			    ));
    $this->cacheQueries = false;

    return $account['Account']['type'];
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: fundamentalType
   *  - Returns the fundmental type of the account, credit or debit
   */
  function fundamentalType($id_or_type) {
    if (is_numeric($id_or_type))
      $type = $this->type($id_or_type);
    else
      $type = $id_or_type;

    // Asset and Expense accounts are debit accounts
    if (in_array(strtoupper($type), array('ASSET', 'EXPENSE')))
      return 'debit';

    // Otherwise, it's a credit account
    return 'credit';
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: fundamentalOpposite
   *  - Returns the opposite fundmental type of the account, credit or debit
   */
  function fundamentalOpposite($id_or_type) {
    if (in_array(strtolower($id_or_type), array('credit', 'debit')))
      $fund = $id_or_type;
    else
      $fund = $this->fundamentalType($id_or_type);

    if (strtolower($fund) == 'debit')
      return 'credit';

    return 'debit';
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: name
   *  - Returns the name of this account
   */
  function name($id) {
    $this->cacheQueries = true;
    $account = $this->find('first', array
			   ('recursive' => -1,
			    'fields' => array('name'),
			    'conditions' => array(array('Account.id' => $id)),
			    ));
    $this->cacheQueries = false;

    return $account['Account']['name'];
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: debitCreditFields
   *  - Returns the fields necessary to determine whether the queried
   *    entries are a debit, or a credit, and also the effect each have
   *    on the overall balance of the account.
   */

  function debitCreditFields($sum = false, $balance = true,
			     $entry_name = 'LedgerEntry', $account_name = 'Account') {
    return $this->LedgerEntry->debitCreditFields
      ($sum, $balance, $entry_name, $account_name);
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: Account IDs
   *  - Returns the ID of the desired account
   */

  function securityDepositAccountID()   { return $this->nameToID('Security Deposit'); }
  function rentAccountID()              { return $this->nameToID('Rent'); }
  function lateChargeAccountID()        { return $this->nameToID('Late Charge'); }
  function nsfAccountID()               { return $this->nameToID('NSF'); }
  function nsfChargeAccountID()         { return $this->nameToID('NSF Charge'); }
  function taxAccountID()               { return $this->nameToID('Tax'); }
  function accountReceivableAccountID() { return $this->nameToID('A/R'); }
  function accountPayableAccountID()    { return $this->nameToID('A/P'); }
  function cashAccountID()              { return $this->nameToID('Cash'); }
  function checkAccountID()             { return $this->nameToID('Check'); }
  function moneyOrderAccountID()        { return $this->nameToID('Money Order'); }
  function achAccountID()               { return $this->nameToID('ACH'); }
  function concessionAccountID()        { return $this->nameToID('Concession'); }
  function waiverAccountID()            { return $this->nameToID('Waiver'); }
  function pettyCashAccountID()         { return $this->nameToID('Petty Cash'); }
  function invoiceAccountID()           { return $this->nameToID('Invoice'); }
  function receiptAccountID()           { return $this->nameToID('Receipt'); }
  function badDebtAccountID()           { return $this->nameToID('Bad Debt'); }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: fundamentalAccounts
   *  - Returns an array of accounts by their fundamental type
   */

  function fundamentalAccounts($ftype) {
    $this->cacheQueries = true;
    $account = $this->find('all', array
			   ('contain' => array('CurrentLedger'),
			    'fields' => array('Account.id', 'Account.type', 'Account.name', 'CurrentLedger.id'),
			    'conditions' => array('Account.type' => strtoupper($ftype))
			    ));
    $this->cacheQueries = false;

    return $account;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: relatedAccounts
   *  - Returns an array of accounts related by similar attributes
   */

  function relatedAccounts($attribute, $extra = null) {
    $this->cacheQueries = true;
    $accounts = $this->find('all', array
			    ('contain' => array('CurrentLedger'),
			     'fields' => array('Account.id', 'Account.type', 'Account.name', 'CurrentLedger.id'),
			     'conditions' => array('Account.'.$attribute => true),
			     'order' => array('Account.name'),
			     ) + (isset($extra) ? $extra : array())
			    );
    $this->cacheQueries = false;

    // Rearrange to be of the form (id => name)
    $rel_accounts = array();
    foreach ($accounts AS $acct) {
      $rel_accounts[$acct['Account']['id']] = $acct['Account']['name'];
    }

    return $rel_accounts;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: xxxAccounts
   *  - Returns an array of accounts suitable for activity xxx
   */

  function invoiceAccounts() {
    return $this->relatedAccounts('invoices', array('order' => 'name'));
  }

  function receiptAccounts() {
    return $this->relatedAccounts('receipts', array('order' => 'name'));
  }

  function depositAccounts() {
    return $this->relatedAccounts('deposits', array('order' => 'name'));
  }

  function refundAccounts() {
    return $this->relatedAccounts('refunds', array('order' => 'name'));
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: collectableAccounts
   *  - Returns an array of accounts suitable to show income collection
   */

  function collectableAccounts() {
    $accounts = $this->receiptAccounts();

    foreach(array($this->nsfAccountID(),
		  $this->badDebtAccountID(),
		  $this->securityDepositAccountID())
	    AS $account_id) {
      $accounts[$account_id] = $this->name($account_id);
    }

    return $accounts;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: currentLedgerID
   *  - Returns the current ledger ID of the account
   */
  function currentLedgerID($id) {
    $this->cacheQueries = true;
    $item = $this->find('first', array
			('contain' => 'CurrentLedger',
			 'conditions' => array('Account.id' => $id),
			 ));
    $this->cacheQueries = false;
    return $item['CurrentLedger']['id'];
  }



  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: ledgers
   *  - Returns an array of ledger ids from the given account
   */
  function ledgers($id, $all = false) {
    if ($all) {
      $contain = array('Ledger' => array('fields' => array('Ledger.id')));
    } else {
      $contain = array('CurrentLedger' => array('fields' => array('CurrentLedger.id')));
    }

    $this->cacheQueries = true;
    $account = $this->find('first', array
			   ('contain' => $contain,
			    'fields' => array(),
			    'conditions' => array(array('Account.id' => $id)),
			    ));
    $this->cacheQueries = false;

    if ($all) {
      $ledger_ids = array();
      foreach ($account['Ledger'] AS $ledger)
	array_push($ledger_ids, $ledger['id']);
    }
    else {
      $ledger_ids = array($account['CurrentLedger']['id']);
    }

/*     pr(array('function' => 'Account::ledgers', */
/* 	     'args' => compact('id', 'all'), */
/* 	     'return' => $ledger_ids)); */

    return $ledger_ids;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: closeCurrentLedger
   *  - Closes the current account ledger, and opens a new one
   *    with the old balance carried forward.
   */
  function closeCurrentLedgers($ids = null) {

    $this->cacheQueries = true;
    $account = $this->find('all', array
			   ('contain' => array('CurrentLedger.id'),
			    'fields' => array(),
			    'conditions' => (empty($ids)
					     ? array()
					     : array(array('Account.id' => $ids)))
			    ));
    $this->cacheQueries = false;
    //pr(compact('id', 'account'));

    $ledger_ids = array();
    foreach ($account AS $acct)
      $ledger_ids[] = $acct['CurrentLedger']['id'];

    return $this->Ledger->closeLedgers($ledger_ids);
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: ledgerEntries
   *  - Returns an array of ledger entries that belong to the given
   *    account, either just from the current ledger, or from all ledgers.
   */
  function ledgerEntries($id, $all = false, $cond = null, $link = null) {
    $ledgers = $this->ledgers($id, $all);
    return $this->Ledger->ledgerEntries($ledgers, $cond, $link);
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: stats
   *  - Returns summary data from the requested account.
   */

  function stats($id = null, $all = false, $query = null) {
    if (!$id)
      return null;

    $this->queryInit($query);
    $query['link'] = array('Account' => $query['link']);

    foreach ($this->ledgers($id, $all) AS $ledger)
      $this->statsMerge($stats['Ledger'],
			$this->Ledger->stats($ledger, $query));

    return $stats;
  }

}
?>