pmgr/models/customer.php

<?php
class Customer extends AppModel {

	var $name = 'Customer';
	var $validate = array(
		'id' => array('numeric'),
		'name' => array('notempty'),
	);

	var $belongsTo = array(
		'PrimaryContact' => array(
			'className' => 'Contact',
		),
	);

	var $hasMany = array(
		'CurrentLease' => array(
			'className' => 'Lease',
			'conditions' => 'CurrentLease.close_date IS NULL',
		),
		'Lease',
		'LedgerEntry',
		'ContactsCustomer',
	);

	var $hasAndBelongsToMany = array(
		'Contact',
		'Transaction' => array(
			'joinTable' => 'ledger_entries',
			'foreignKey' => 'customer_id',
			'associationForeignKey' => 'transaction_id',
		),
	);


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: accountId
   *  - Returns the account ID for the given customer
   */
  function accountId($id) {
    $this->cacheQueries = true;
    $customer = $this->find('first',
			    array('contain' => false,
				  'fields' => array('account_id'),
				  'conditions' => array(array('Customer.id' => $id))));
    $this->cacheQueries = false;

    return $customer['Customer']['account_id'];
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: leaseIds
   *  - Returns the lease IDs for the given customer
   */
  function leaseIds($id) {
    $this->cacheQueries = true;
    $customer = $this->find('first',
			    array('contain' =>
				  array('Lease' => array('fields' => array('id'))),
				  'fields' => array(),
				  'conditions' => array(array('Customer.id' => $id))));
    $this->cacheQueries = false;

    $ids = array();
    foreach ($customer['Lease'] AS $lease)
      $ids[] = $lease['id'];

    return $ids;
  }

  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: findSecurityDeposits
   *  - Returns an array of security deposit entries
   */
  function findSecurityDeposits($id, $link = null) {
/*     pr(array('function' => 'Customer::findSecurityDeposits', */
/* 	     'args' => compact('id', 'link'), */
/* 	     )); */

    $A = new Account();
    $entries = $A->findLedgerEntriesRelatedToAccount
      ($A->securityDepositAccountID(),
       array($A->invoiceAccountID(), $A->receiptAccountID()),
       true, array('LedgerEntry.customer_id' => $id), $link);

/*     pr(array('function' => 'Customer::findSecurityDeposits', */
/* 	     'args' => compact('id', 'link'), */
/* 	     'vars' => compact('customer'), */
/* 	     'return' => compact('entries'), */
/* 	     )); */

    return $entries;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: findUnreconciledLedgerEntries
   *  - Returns ledger entries that are not yet reconciled
   *    (such as charges not paid).
   */

  function findUnreconciledLedgerEntries($id = null, $fundamental_type = null) {
    $A = new Account();
    $unreconciled = $A->findUnreconciledLedgerEntries
      ($A->accountReceivableAccountID(),
       $fundamental_type,
       array('LedgerEntry.customer_id' => $id));

    return $unreconciled;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: reconcileNewLedgerEntry
   *  - Returns which ledger entries a new credit/debit would
   *    reconcile, and how much.
   *
   *  - REVISIT <AP> 20090617
   *    This should be subject to different algorithms, such
   *    as apply to oldest charges first, newest first, to fees
   *    before rent, etc.  Until we get there, I'll hardcode
   *    whatever algorithm is simplest.
   */

  function reconcileNewLedgerEntry($id, $fundamental_type, $amount) {
    $A = new Account();
    $reconciled = $A->reconcileNewLedgerEntry
      ($A->accountReceivableAccountID(),
       $fundamental_type,
       $amount,
       array('LedgerEntry.customer_id' => $id));

    return $reconciled;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: details
   *  - Returns detail information for the customer
   */

  function details($id = null) {
    // Query the DB for need information.
    $customer = $this->find
      ('first', array
       ('contain' => array
	(// Models
	 'Contact' =>
	 array('order'  => array('Contact.display_name'),
	       // Models
	       'ContactPhone',
	       'ContactEmail',
	       'ContactAddress',
	       ),
	 'Lease' =>
	 array('Unit' =>
	       array('order'  => array('sort_order'),
		     'fields' => array('id', 'name'),
		     ),
	       ),
	 ),

	'conditions' => array('Customer.id' => $id),
	));

    // Figure out the outstanding balance for this customer
    $customer['stats'] = $this->stats($id);

    // Figure out the total security deposit for the current lease.
    $customer['deposits'] = $this->findSecurityDeposits($id);

    return $customer;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * function: saveCustomer
   *  - Saves the customer and related data
   */

  function saveCustomer($id, $data, $primary_contact_entry) {

    // Go through each contact, and create new ones as needed
    foreach ($data['Contact'] AS &$contact) {
      if (isset($contact['id']))
	continue;

      $I = new Contact();
      $I->create();
      if (!$I->save($contact, false)) {
	return false;
      }
      $contact['id'] = $I->id;
    }

    // Set the primary contact ID based on caller selection
    $data['Customer']['primary_contact_id']
      = $data['Contact'][$primary_contact_entry]['id'];

    // Provide a default customer name if not specified
    if (!$data['Customer']['name']) {
      $this->Contact->recursive = -1;
      $pcontact = $this->Contact->read(null, $data['Customer']['primary_contact_id']);
      $data['Customer']['name'] = $pcontact['Contact']['display_name'];
    }

    // Save the customer data
    $this->create();
    if ($id)
      $this->id = $id;
    if (!$this->save($data, false)) {
      return false;
    }
    $id = $this->id;

    // Remove all associated Customer Contacts, as it ensures
    // any entries deleted by the user actually get deleted
    // in the system.  We'll recreate the needed ones anyway.
    // REVISIT <AP>: 20090706
    //  Appears that $this->save() is already doing the
    //  delete.  I would have thought this would only happen
    //  on a saveAll??
/*     $this->ContactsCustomer->deleteAll */
/*       (array('customer_id' => $id), false); */

    // At this point, since we've saved data to customer,
    // we'll proceed forward as much as possible, even
    // if we encounter an error.  For now, we'll assume
    // the operation will succeed.
    $ret = true;

    // Go through each entry of this customer method
    foreach ($data['Contact'] AS &$contact) {
      // Update the ContactsCustomer to reflect the appropriate IDs
      $contact['ContactsCustomer']['customer_id'] = $id;
      $contact['ContactsCustomer']['contact_id'] = $contact['id'];

      // Save the relationship between customer and contact
      $CM = new ContactsCustomer();
      if (!$CM->save($contact['ContactsCustomer'], false)) {
	$ret = false;
      }
    }

    // Return the result
    return $ret;
  }


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

  function stats($id = null) {
    if (!$id)
      return null;

    $A = new Account();
    $stats = $A->stats($A->accountReceivableAccountID(), true,
		       array('LedgerEntry.customer_id' => $id));

    // Pull to the top level and return
    $stats = $stats['Ledger'];
    return $stats;
  }

}
?>