Forgot the new files on the last checkin

git-svn-id: file:///svn-source/pmgr/branches/statements_20090623@185 97e9348a-65ac-dc4b-aefc-98561f571b83

build.cmd

@@ -0,0 +1,3 @@
+@echo off
+%~dp0\scripts\sitelink2pmgr.pl %~dp0\db\schema.sql %~dp0db\vss.mdb > NUL
+echo Done!

site/app_model.php

@@ -78,6 +78,24 @@ class AppModel extends Model {
 
 
 
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: nameToID
+   *  - Returns the ID of the named item
+   */
+  function nameToID($name) {
+    $this->cacheQueries = true;
+    $item = $this->find('first', array
+			('recursive' => -1,
+			 'conditions' => compact('name'),
+			 ));
+    $this->cacheQueries = false;
+    $item = current($item);
+    return $item['id'];
+  }
+
+
   /**************************************************************************
    **************************************************************************
    **************************************************************************

site/controllers/ledger_entries_controller.php

@@ -162,41 +162,11 @@ class LedgerEntriesController extends AppController {
     if (isset($params['custom']['customer_id'])) {
       $conditions[] = 
 	array('Customer.id' => $params['custom']['customer_id']);
-
-/*       $Account = new Account(); */
-/*       if (isset($params['custom']['account_ftype']) || */
-/* 	  isset($params['custom']['ledger_id'])) { */
-/* 	$conditions[] =  */
-/* 	  array('OR' => array('Account.id' => $Account->invoiceAccountID(), */
-/* 			      'Account.id' => $Account->receiptAccountID())); */
-/*       } else { */
-/* 	$conditions[] =  */
-/* 	  array('OR' => array('DebitAccount.id' => $Account->invoiceAccountID(), */
-/* 			      //'CreditAccount.id' => $Account->invoiceAccountID(), */
-/* 			      //'DebitAccount.id' => $Account->receiptAccountID(), */
-/* 			      'CreditAccount.id' => $Account->receiptAccountID(), */
-/* 			      )); */
-/*       } */
     }
 
     if (isset($params['custom']['lease_id'])) {
       $conditions[] = 
 	array('Lease.id' => $params['custom']['lease_id']);
-
-/*       $Account = new Account(); */
-/*       if (isset($params['custom']['account_ftype']) || */
-/* 	  isset($params['custom']['ledger_id'])) { */
-/* 	$conditions[] =  */
-/* 	  array('OR' => array('Account.id' => $Account->invoiceAccountID(), */
-/* 			      'Account.id' => $Account->receiptAccountID())); */
-/*       } else { */
-/* 	$conditions[] =  */
-/* 	  array('OR' => array('DebitAccount.id' => $Account->invoiceAccountID(), */
-/* 			      //'CreditAccount.id' => $Account->invoiceAccountID(), */
-/* 			      //'DebitAccount.id' => $Account->receiptAccountID(), */
-/* 			      'CreditAccount.id' => $Account->receiptAccountID(), */
-/* 			      )); */
-/*       } */
     }
 
     if (isset($params['custom']['transaction_id'])) {
@@ -304,7 +274,7 @@ class LedgerEntriesController extends AppController {
 
 	     'conditions' => array('LedgerEntry.id' => $id),
 	     ));
-    //pr($entry);
+    pr($entry);
 
     // Because 'DebitLedger' and 'CreditLedger' both relate to 'Account',
     // CakePHP will not include them in the LedgerEntry->find (or so it

site/controllers/statement_entries_controller.php

@@ -0,0 +1,116 @@
+<?php
+
+class StatementEntriesController extends AppController {
+
+  var $sidemenu_links = array();
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * override: sideMenuLinks
+   *  - Generates controller specific links for the side menu
+   */
+  function sideMenuLinks() {
+    return array_merge(parent::sideMenuLinks(), $this->sidemenu_links);
+  }
+
+  
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * virtuals: jqGridData
+   *  - With the application controller handling the jqGridData action,
+   *    these virtual functions ensure that the correct data is passed
+   *    to jqGrid.
+   */
+
+  function jqGridDataTables(&$params, &$model) {
+    $link =
+      array(// Models
+	    'LedgerEntry' =>
+	    array('fields' => array('id'),
+		  // Models
+		  'Transaction' =>
+		  array('fields' => array('id', 'stamp'),
+			),
+
+		  'Ledger' =>
+		  array('fields' => array('id', 'sequence'),
+			'conditions' => ("Ledger.id = IF(StatementEntry.type = 'CHARGE'," .
+					 "               LedgerEntry.credit_ledger_id," .
+					 "               LedgerEntry.debit_ledger_id)"),
+			// Models
+			'Account' => array('fields' => array('id', 'name'),
+					   ),
+			),
+		  ),
+	    );
+
+    return array('link' => $link);
+  }
+
+  function jqGridDataFields(&$params, &$model) {
+    $fields = array('id', 'type', 'comment');
+    $fields[] = "IF(StatementEntry.type = 'CHARGE',  StatementEntry.amount, NULL) AS 'charge'";
+    $fields[] = "IF(StatementEntry.type = 'PAYMENT', StatementEntry.amount, NULL) AS 'payment'";
+    $fields[] = "IF(StatementEntry.type = 'CHARGE', 1, -1) * StatementEntry.amount AS 'amount'";
+    return $fields;
+  }
+
+  function jqGridDataConditions(&$params, &$model) {
+    $conditions = parent::jqGridDataConditions($params, $model);
+
+    if (isset($params['custom']['statement_id'])) {
+      $conditions[] =
+	array('StatementEntry.statement_id' => $params['custom']['statement_id']);
+    }
+
+    return $conditions;
+  }
+
+  function jqGridRecordLinks(&$params, &$model, &$records, $links) {
+    $links['Transaction']    = array('id');
+    $links['StatementEntry'] = array('id');
+    $links['Account']        = array('controller' => 'accounts', 'name');
+    $links['LedgerEntry']    = array('id');
+    return parent::jqGridRecordLinks($params, $model, $records, $links);
+  }
+
+  function jqGridRecordsPostProcess(&$params, &$model, &$records) {
+    parent::jqGridRecordsPostProcess($params, $model, $records);
+
+    $subtotal = 0;
+    foreach ($records AS &$record) {
+      $amount = $record['StatementEntry']['amount'];
+      $record['StatementEntry']['amount'] = $amount;
+      $record['StatementEntry']['subtotal'] = ($subtotal += $amount);
+    }
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * action: view
+   *  - Displays information about a specific entry
+   */
+
+  function view($id = null) {
+    if (!$id) {
+      $this->Session->setFlash(__('Invalid Item.', true));
+      $this->redirect(array('controller' => 'accounts', 'action'=>'index'));
+    }
+
+    // Get the StatementEntry and related fields
+    $entry = $this->StatementEntry->find
+      ('first',
+       array('contain' => array(),
+	     'conditions' => array('StatementEntry.id' => $id),
+	     ));
+
+    // Prepare to render.
+    $title = "Statement Entry #{$entry['StatementEntry']['id']}";
+    $this->set(compact('entry', 'title'));
+  }
+}

site/controllers/units_controller.php

@@ -55,7 +55,7 @@ class UnitsController extends AppController {
     $link = array
       ('link' =>
        array(// Models
-	     'UnitSize' => array('fields' => array('name')),
+	     'UnitSize' => array('fields' => array('id', 'name')),
 	     ),
        );
 
@@ -93,6 +93,11 @@ class UnitsController extends AppController {
     return parent::jqGridDataOrder($params, $model, $index, $direction);
   }
 
+  function jqGridRecordLinks(&$params, &$model, &$records, $links) {
+    //$links['UnitSize']       = array('name');
+    $links['Unit']           = array('name', 'id');
+    return parent::jqGridRecordLinks($params, $model, $records, $links);
+  }
 
   /**************************************************************************
    **************************************************************************

site/models/account.php

@@ -82,26 +82,13 @@ class Account extends AppModel {
   /**************************************************************************
    **************************************************************************
    **************************************************************************
-   * function: accountNameToID
+   * function: Account IDs
-   *  - Returns the ID of the named account
+   *  - Returns the ID of the desired account
    */
-  function accountNameToID($name) {
-    $this->cacheQueries = true;
-    $account = $this->find('first', array
-			   ('recursive' => -1,
-			    'conditions' => compact('name'),
-			    ));
-    $this->cacheQueries = false;
-    return $account['Account']['id'];
-  }
 
-  function securityDepositAccountID()   { return $this->accountNameToID('Security Deposit'); }
+  function securityDepositAccountID()   { return $this->nameToID('Security Deposit'); }
-  function rentAccountID()              { return $this->accountNameToID('Rent'); }
+  function rentAccountID()              { return $this->nameToID('Rent'); }
-  function accountReceivableAccountID() { return $this->accountNameToID('A/R'); }
+  function accountReceivableAccountID() { return $this->nameToID('A/R'); }
-  function invoiceAccountID()           { return $this->accountReceivableAccountID(); }
-  function receiptAccountID()           { return $this->accountReceivableAccountID(); }
-  //function invoiceAccountID()           { return $this->accountNameToID('Invoice'); }
-  //function receiptAccountID()           { return $this->accountNameToID('Receipt'); }
 
 
   /**************************************************************************

site/models/customer.php

@@ -8,6 +8,7 @@ class Customer extends AppModel {
 	);
 
 	var $belongsTo = array(
+		'Statement',
 		'PrimaryContact' => array(
 			'className' => 'Contact',
 		),
@@ -43,13 +44,26 @@ class Customer extends AppModel {
    */
   function accountId($id) {
     $this->cacheQueries = true;
-    $customer = $this->find('first',
+    $item = $this->find('first',
-			    array('contain' => false,
+			array('contain' => false,
-				  'fields' => array('account_id'),
+			      'fields' => array('account_id'),
-				  'conditions' => array(array('Customer.id' => $id))));
+			      'conditions' => compact('id')));
     $this->cacheQueries = false;
 
-    return $customer['Customer']['account_id'];
+    $item = current($item);
+    return $item['account_id'];
+  }
+
+  function statementID($id) {
+    $this->cacheQueries = true;
+    $item = $this->find('first', array
+			('recursive' => -1,
+			 'conditions' => compact('id'),
+			 ));
+    $this->cacheQueries = false;
+
+    $item = current($item);
+    return $item['statement_id'];
   }
 
 
@@ -75,6 +89,7 @@ class Customer extends AppModel {
     return $ids;
   }
 
+
   /**************************************************************************
    **************************************************************************
    **************************************************************************
@@ -82,22 +97,10 @@ class Customer extends AppModel {
    *  - Returns an array of security deposit entries
    */
   function findSecurityDeposits($id, $link = null) {
-/*     pr(array('function' => 'Customer::findSecurityDeposits', */
+    return $this->Statement->findEntriesRelatedToAccount
-/* 	     'args' => compact('id', 'link'), */
+      ($this->statementId($id),
-/* 	     )); */
-
-    $entries = $this->Account->findLedgerEntriesRelatedToAccount
-      ($this->Account->invoiceAccountID(),
        $this->Account->securityDepositAccountID(),
-       true, array('LedgerEntry.customer_id' => $id), $link);
+       null, $link);
-
-/*     pr(array('function' => 'Customer::findSecurityDeposits', */
-/* 	     'args' => compact('id', 'link'), */
-/* 	     'vars' => compact('customer'), */
-/* 	     'return' => compact('entries'), */
-/* 	     )); */
-
-    return $entries;
   }
 
 
@@ -191,16 +194,11 @@ class Customer extends AppModel {
    *  - Returns summary data from the requested customer.
    */
 
-  function stats($id = null) {
+  function stats($id = null, $cond = null, $link = null) {
     if (!$id)
       return null;
 
-    $stats = $this->Account->stats($this->Account->accountReceivableAccountID(), true,
+    return $this->Statement->stats($this->statementID($id), $cond, $link);
-				   array('LedgerEntry.customer_id' => $id));
-
-    // Pull to the top level and return
-    $stats = $stats['Ledger'];
-    return $stats;
   }
 
 }

site/models/lease.php

@@ -26,6 +26,7 @@ class Lease extends AppModel {
 		'LeaseType',
 		'Unit',
 		'Customer',
+		'Statement',
 		'LateSchedule',
 	);
 
@@ -40,13 +41,23 @@ class Lease extends AppModel {
   /**************************************************************************
    **************************************************************************
    **************************************************************************
-   * function: accountId
+   * function: accessors
-   *  - Returns the accountId of the given lease
    */
   function accountId($id) {
     return $this->Account->invoiceAccountID();
   }
 
+  function statementID($id) {
+    $this->cacheQueries = true;
+    $item = $this->find('first', array
+			('recursive' => -1,
+			 'conditions' => compact('id'),
+			 ));
+    $this->cacheQueries = false;
+    $item = current($item);
+    return $item['statement_id'];
+  }
+
 
   /**************************************************************************
    **************************************************************************
@@ -83,21 +94,10 @@ class Lease extends AppModel {
    *  - Returns an array of security deposit entries
    */
   function findSecurityDeposits($id, $link = null) {
-/*     pr(array('function' => 'Lease::findSecurityDeposits', */
+    return $this->Statement->findEntriesRelatedToAccount
-/* 	     'args' => compact('id', 'link'), */
+      ($this->statementId($id),
-/* 	     )); */
-
-    $entries = $this->Account->findLedgerEntriesRelatedToAccount
-      ($this->accountId($id),
        $this->Account->securityDepositAccountID(),
-       true, array('LedgerEntry.lease_id' => $id), $link);
+       null, $link);
-
-/*     pr(array('function' => 'Lease::findSecurityDeposits', */
-/* 	     'args' => compact('id', 'link'), */
-/* 	     'vars' => compact('lease'), */
-/* 	     'return' => compact('entries'), */
-/* 	     )); */
-    return $entries;
   }
 
 
@@ -142,16 +142,11 @@ class Lease extends AppModel {
    *  - Returns summary data from the requested lease.
    */
 
-  function stats($id = null) {
+  function stats($id = null, $cond = null, $link = null) {
     if (!$id)
       return null;
 
-    $stats = $this->Account->stats($this->Account->accountReceivableAccountID(), true,
+    return $this->Statement->stats($this->statementID($id), $cond, $link);
-				   array('LedgerEntry.lease_id' => $id));
-
-    // Pull to the top level and return
-    $stats = $stats['Ledger'];
-    return $stats;
   }
 
 }

site/models/statement.php

@@ -0,0 +1,123 @@
+<?php
+class Statement extends AppModel {
+
+  var $hasMany = array(
+    'Lease',
+    'Customer',
+    'StatementEntry',
+
+    'ChargeStatementEntry' => array(
+      'className' => 'StatementEntry',
+      'conditions' => array('type' => 'CHARGE'),
+    ),
+    'PaymentStatementEntry' => array(
+      'className' => 'StatementEntry',
+      'conditions' => array('type' => 'PAYMENT'),
+    ),
+  );
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: findStatementEntries
+   *  - Returns an array of statement entries that belong to a given
+   *    statement. There is extra work done... see the StatementEntry model.
+   */
+  function findStatementEntries($id, $cond = null, $link = null) {
+/*     pr(array('function' => 'Statement::findStatementEntries', */
+/* 	     'args' => compact('id', 'cond', 'link'), */
+/* 	     )); */
+
+    if (!isset($cond))
+      $cond = array();
+
+    $cond[] = array('Statement.id' => $id);
+    $entries = $this->find('all', array('link' => $link, 'conditions' => $cond));
+
+/*     pr(array('function' => 'Statement::findStatementEntries', */
+/* 	     'args' => compact('id', 'cond', 'link'), */
+/* 	     'return' => compact('entries'), */
+/* 	     )); */
+    return $entries;
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: findEntriesRelatedToAccount
+   *  - Returns an array of statement entries that belong to the given
+   *    account, and are related to a specific account.
+   */
+  function findEntriesRelatedToAccount($id, $rel_ids, $cond = null, $link = null) {
+/*     pr(array('function' => 'Statement::findEntriesRelatedToAccount', */
+/* 	     'args' => compact('id', 'rel_ids', 'cond', 'link'), */
+/* 	     )); */
+
+    if (!isset($cond))
+      $cond = array();
+    if (!isset($link))
+      $link = array();
+    if (!is_array($rel_ids))
+      $rel_ids = array($rel_ids);
+
+    $link['StatementEntry'] = array('LedgerEntry' => array('Ledger' => array('Account')));
+    $cond[] = array('Account.id' => $rel_ids);
+
+    $entries = $this->findStatementEntries($id, $cond, $link);
+
+    $stats = $this->stats($id, $cond, $link);
+    $entries = array('Entries' => $entries,
+		     'summary' => $stats);
+
+/*     pr(array('function' => 'Statement::findEntriesRelatedToAccount', */
+/* 	     'args' => compact('id', 'relid', 'cond', 'link'), */
+/* 	     'return' => compact('entries'), */
+/* 	     )); */
+    return $entries;
+  }
+
+
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: stats
+   *  - Returns summary data from the requested statement.
+   */
+  function stats($id, $cond = null, $link = null) {
+    if (!isset($cond))
+      $cond = array();
+    if (!isset($link))
+      $link = array();
+
+    if (!isset($link['StatementEntry']))
+      $link['StatementEntry'] = array('fields' => array());
+
+    $cond[] = array('Statement.id' => $id);
+
+    $stats = $this->find
+      ('first', array
+       ('link' => $link,
+
+	'fields' =>
+	array("SUM(IF(StatementEntry.type = 'CHARGE',
+                      StatementEntry.amount, NULL)) AS charges",
+	      "SUM(IF(StatementEntry.type = 'PAYMENT',
+                      StatementEntry.amount, NULL)) AS payments",
+	      "SUM(IF(StatementEntry.type = 'CHARGE', 1, -1)
+                   * IF(StatementEntry.amount, StatementEntry.amount, 0)
+                   ) AS balance",
+	      "COUNT(StatementEntry.id) AS entries"),
+
+	'conditions' => $cond,
+	'group' => 'Statement.id',
+	));
+
+    // The fields are all tucked into the [0] index,
+    // and the rest of the array is useless (empty).
+    return $stats[0];
+  }
+
+}
+?>

site/models/statement_entry.php

@@ -0,0 +1,9 @@
+<?php
+class StatementEntry extends AppModel {
+
+	var $belongsTo = array(
+		'Statement',
+		'LedgerEntry',
+	);
+
+}