pmgr/site/controllers/leases_controller.php

<?php

class LeasesController extends AppController {

  var $sidemenu_links =
    array(array('name' => 'Leases',   'header' => true),
	  array('name' => 'Active',   'url' => array('controller' => 'leases', 'action' => 'active')),
	  array('name' => 'Closed',   'url' => array('controller' => 'leases', 'action' => 'closed')),
	  array('name' => 'All',      'url' => array('controller' => 'leases', 'action' => 'all')),
	  );


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * override: sideMenuLinks
   *  - Generates controller specific links for the side menu
   */
  function sideMenuLinks() {
    return array_merge(parent::sideMenuLinks(), $this->sidemenu_links);
  }

  
  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: index / active / closed / all
   *  - Generate a listing of leases
   */

  function index()    { $this->all(); }
  function active()   { $this->jqGridView('Active Leases'); }
  function closed()   { $this->jqGridView('Closed Leases'); }
  function all()      { $this->jqGridView('All Leases', 'all'); }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * virtuals: jqGridData
   *  - With the application controller handling the jqGridData action,
   *    these virtual functions ensure that the correct data is passed
   *    to jqGrid.
   */

  function jqGridDataSetup(&$params) {
    parent::jqGridDataSetup($params);
    if (!isset($params['action']))
      $params['action'] = 'all';
  }

  function jqGridDataTables(&$params, &$model) {
    return array
      ('link' => array('Unit'     => array('fields' => array('Unit.id', 'Unit.name')),
		       'Customer' => array('fields' => array('Customer.id', 'Customer.name'))));
  }

  function jqGridDataConditions(&$params, &$model) {
    $conditions = parent::jqGridDataConditions($params, $model);

    if ($params['action'] === 'active') {
      $conditions[] = 'Lease.close_date IS NULL';
    }
    elseif ($params['action'] === 'closed') {
      $conditions[] = 'Lease.close_date IS NOT NULL';
    }

    return $conditions;
  }

  function jqGridRecordLinks(&$params, &$model, &$records, $links) {
    $links['Lease'] = array('number');
    $links['Unit'] = array('name');
    return parent::jqGridRecordLinks($params, $model, $records, $links);
  }

  function jqGridDataRecords(&$params, &$model, $query) {
    $leases = parent::jqGridDataRecords($params, $model, $query);

    // Get the balance on each lease.
    foreach ($leases AS &$lease) {
      $stats = $this->Lease->stats($lease['Lease']['id']);
      $lease['Lease']['balance'] = $stats['Account']['Ledger']['balance'];
    }

    return $leases;
  }


  /**************************************************************************
   **************************************************************************
   **************************************************************************
   * action: view
   *  - Displays information about a specific lease
   */

  function view($id = null) {
    if (!$id) {
      $this->Session->setFlash(__('Invalid Item.', true));
      $this->redirect(array('action'=>'index'));
    }

    // Get details about the lease and its ledgers (no ledger entries yet)
    $lease = $this->Lease->find
      ('first',
       array('contain' =>
	     array(// Models
		   'LeaseType',
		   'Unit',
		   'Account' => array('CurrentLedger'),
		   'Customer',
		   ),
	     'conditions' => array(array('Lease.id' => $id)),
	     'limit' => 2
	     )
       );

    // Summarize each ledger
    $this->Lease->statsMerge($lease, 
			     $this->Lease->stats($lease['Lease']['id']));

    // Obtain the overall lease balance
    $this->Lease->statsMerge($lease['Lease'],
			     array('stats' => $this->Lease->stats($id)));
    $outstanding_balance = $lease['Lease']['stats']['Account']['Ledger']['balance'];

    // Determine the lease security deposit
    $deposits = $this->Lease->findSecurityDeposits($lease['Lease']['id']);
    $outstanding_deposit = $deposits['summary']['balance'];

    // Move the Leder stats into our alias 'CurrentLedger'
    $lease['Account']['CurrentLedger'] += $lease['Account']['Ledger'];
    unset($lease['Account']['Ledger']);

    // Prepare to render
    $title = 'Lease: #' . $lease['Lease']['id'];
    $this->set(compact('lease', 'title',
		       'outstanding_deposit',
		       'outstanding_balance'));
  }
}