Added outstanding charges and outstanding credits to the customer page, and reorded fields in order of presumed importance. Removed items from Unit/Lease which really shouldn't have been there. They were added for convenience, but the redundancy was confusing. Added a couple report links to make it easy to see outstanding charges and collected rents.

git-svn-id: file:///svn-source/pmgr/branches/v0.3_work/site@977 97e9348a-65ac-dc4b-aefc-98561f571b83

models/statement_entry.php

@@ -294,7 +294,7 @@ class StatementEntry extends AppModel {
     }
 
     return $this->prReturn(array('entries' => $resultset,
-			       'summary' => $this->stats(null, $query)));
+				 'summary' => $this->stats(null, $query)));
   }
 
 
@@ -338,6 +338,72 @@ class StatementEntry extends AppModel {
   }
 
 
+  /**************************************************************************
+   **************************************************************************
+   **************************************************************************
+   * function: outstandingDebits
+   *  - Determines all debit types that have not yet been resolved.
+   *    The name is a bit dumb, but it means any statement entry type
+   *    that a positive customer balance could be used to offset. In
+   *    other words, entries that are still in need of matching
+   *    disbursements.  Most notably, this means charges but could
+   *    also mean things like refunds as well.
+   */
+
+  function outstandingDebits($query = null, $customer_id = null,
+			     $lease_id = null, $debit_types = null)
+  {
+    $this->prEnter(compact('query', 'lease_id',
+			   'customer_id', 'charge_ids',
+			   'debit_types'));
+    $this->queryInit($query);
+
+    if (empty($debit_types))
+      $debit_types = $this->debitTypes();
+
+    if (!empty($customer_id))
+      $query['conditions'][] = array('StatementEntry.customer_id' => $customer_id);
+
+    if (!empty($lease_id))
+      $query['conditions'][] = array('StatementEntry.lease_id' => $lease_id);
+
+    /* if (isset($charge_ids)) { */
+    /*   // REVISIT <AP> 20100330: */
+    /*   // Not using $query here, as this code was extracted from its */
+    /*   // original location in assignCredits, and so I'm keeping the */
+    /*   // logic consistent.  It does seem, however, that we shouldn't */
+    /*   // be ignoring $query if passed in.  I'm sure this won't be */
+    /*   // looked at until someone _does_ pass $query in (and it break), */
+    /*   // so hopefully at that time, we can understand what needs to */
+    /*   // happen in that case (requirements are not clear at present). */
+    /*   $lquery = array('contain' => false, */
+    /* 		      'conditions' => array('StatementEntry.id' => $charge_ids)); */
+    /* } else { */
+    /*   $lquery = $query; */
+    /*   // If we're working with a specific lease, then limit charges to it */
+    /*   if (!empty($lease_id)) */
+    /* 	$lquery['conditions'][] = array('StatementEntry.lease_id' => $lease_id); */
+    /* } */
+
+    if (empty($query['order']))
+      $query['order'] = 'StatementEntry.effective_date ASC';
+
+    $debits = array();
+    foreach ($debit_types AS $dtype) {
+      $rset = $this->reconciledSet($dtype, $query, true);
+      $entries = $rset['entries'];
+      $debits = array_merge($debits, $entries);
+      $this->pr(18, compact('dtype', 'entries'), "Outstanding Debit Entries");
+    }
+
+    return $this->prReturn($debits);
+  }
+
+  function outstandingCharges($query = null, $customer_id = null, $lease_id = null) {
+    return $this->outstandingDebits($query, $customer_id, $lease_id, array('CHARGE'));
+  }
+
+
   /**************************************************************************
    **************************************************************************
    **************************************************************************
@@ -359,9 +425,6 @@ class StatementEntry extends AppModel {
 			   'customer_id', 'lease_id'));
     $this->queryInit($query);
 
-    if (!empty($customer_id))
-      $query['conditions'][] = array('StatementEntry.customer_id' => $customer_id);
-
     if (empty($disbursement_type))
       $disbursement_type = 'DISBURSEMENT';
 
@@ -375,6 +438,9 @@ class StatementEntry extends AppModel {
 	$this->INTERNAL_ERROR("Charge IDs, yet no corresponding receipt");
 
       $lquery = $query;
+      if (!empty($customer_id))
+	$lquery['conditions'][] = array('StatementEntry.customer_id' => $customer_id);
+
       $lquery['conditions'][] = array('StatementEntry.type' => 'SURPLUS');
       // REVISIT <AP>: 20090804
       //  We need to ensure that we're using surplus credits ONLY from either
@@ -423,23 +489,16 @@ class StatementEntry extends AppModel {
 		"Receipt Credit Added");
     }
 
-    // Now find all unpaid charges
-    if (isset($charge_ids)) {
-      $lquery = array('contain' => false,
-		      'conditions' => array('StatementEntry.id' => $charge_ids));
-    } else {
+    // Now find all unpaid charges, using either the specific set
+    // of charges given, or all outstanding charges based on the
+    // query, customer and/or lease
+    if (!empty($charge_ids)) {
+      $this->INTERNAL_ERROR("PERHAPS IMPLEMENTED - THOUGH NEVER TESTED");
       $lquery = $query;
-      // If we're working with a specific lease, then limit charges to it
-      if (!empty($lease_id))
-	$lquery['conditions'][] = array('StatementEntry.lease_id' => $lease_id);
-    }
-    $lquery['order'] = 'StatementEntry.effective_date ASC';
-    $charges = array();
-    foreach ($this->debitTypes() AS $dtype) {
-      $rset = $this->reconciledSet($dtype, $lquery, true);
-      $entries = $rset['entries'];
-      $charges = array_merge($charges, $entries);
-      $this->pr(18, compact('dtype', 'entries'), "Outstanding Debit Entries");
+      $lquery['conditions'][] = array('StatementEntry.id' => $charge_ids);
+      $charges = $this->reconciledSet('CHARGE', $query, true);
+    } else {
+      $charges = $this->outstandingDebits($query, $customer_id, $lease_id);
     }
 
     // Work through all unpaid charges, applying disbursements as we go