diff --git a/app_controller.php b/app_controller.php
index 45a9523..ebeee34 100644
--- a/app_controller.php
+++ b/app_controller.php
@@ -84,103 +84,83 @@ class AppController extends Controller {
/**************************************************************************
**************************************************************************
**************************************************************************
- * helper: jqGridView
- * - called by function to create an index listing
+ * helper: gridView
+ * - called by derived controllers to create an index listing
*/
- function jqGridView($title, $action = null, $element = null) {
+ function gridView($title, $action = null, $element = null) {
$this->set('title', $title);
- // The resulting page will contain a jqGrid, which will
+ // The resulting page will contain a grid, which will
// use ajax to obtain the actual data for this action
$this->set('action', $action ? $action : $this->params['action']);
$this->render('/elements/' . ($element ? $element : $this->params['controller']));
}
+
/**************************************************************************
**************************************************************************
**************************************************************************
- * action: jqGridData
- * - Fetches the actual data requested by jqGrid as XML
+ **************************************************************************
+ **************************************************************************
+ * action: gridData
+ * - Fetches the actual data requested by grid as XML
*/
- function jqGridData() {
+ function gridData() {
// Grab a copy of the parameters that control this request
$params = array();
if (isset($this->params['url']) && is_array($this->params['url']))
$params = $this->params['url'];
// Do any preliminary setup necessary
- $this->jqGridDataSetup($params);
+ $this->gridDataSetup($params);
// Get the top level model for this grid
- $model = $this->jqGridDataModel($params);
-
- // Establish the basic query and conditions
- $query = array_intersect_key($this->jqGridDataCountTables($params, $model),
- array('link'=>1, 'contain'=>1));
- $query['conditions'] = $this->jqGridDataCountConditions($params, $model);
- $query['group'] = $this->jqGridDataCountGroup($params, $model);
-
- // DEBUG PURPOSES ONLY!
- $params['count_query'] = $query;
+ $model = $this->gridDataModel($params);
// Get the number of records prior to pagination
- $count = $this->jqGridDataRecordCount($params, $model, $query);
+ $count = $this->gridDataCount($params, $model);
- // Start the query over, this time getting the actual set
- // of tables needed, not just those needed for counting.
- $query = array_intersect_key($this->jqGridDataTables($params, $model),
- array('link'=>1, 'contain'=>1));
- $query['conditions'] = $this->jqGridDataConditions($params, $model);
+ // Determine pagination configuration (and save to $params)
+ $pagination = $this->gridDataPagination($params, $model, $count);
- // Verify a few parameters and determine our starting row
- $limit = $params['rows'];
- $total = ($count < 0) ? 0 : ceil($count/$limit);
- $page = ($params['page'] <= 1) ? 1 : (($params['page'] > $total) ? $total : $params['page']);
- $start = $limit*$page - $limit;
-
- // Grab the actual records taking pagination into account
- $query['group'] = $this->jqGridDataGroup($params, $model);
- $query['order'] = $this->jqGridDataOrder($params, $model,
- isset($params['sidx']) ? $params['sidx'] : null,
- isset($params['sord']) ? $params['sord'] : null);
- $query['limit'] = $this->jqGridDataLimit($params, $model, $start, $limit);
- $query['fields'] = $this->jqGridDataFields($params, $model);
- $results = $this->jqGridDataRecords($params, $model, $query);
-
- // DEBUG PURPOSES ONLY!
- $params['query'] = $query;
+ // Retreive the appropriate subset of data
+ $records = $this->gridDataRecords($params, $model, $pagination);
// Post process the records
- $this->jqGridRecordsPostProcess($params, $model, $results);
+ $this->gridDataPostProcess($params, $model, $records);
- // Add in any needed hyperlinks
- $this->jqGridRecordLinks($params, $model, $results, array());
-
- // Finally, dump out the data
- $this->jqGridDataOutputHeader($params, $model);
- echo "\n";
- echo "
\n$xml\n\n"); + } } - function jqGridDataCountTables(&$params, &$model) { - // If not overridden, we use the same tables to - // perform our count as we do to for the actual query - return $this->jqGridDataTables($params, $model); + /************************************************************************** + ************************************************************************** + ************************************************************************** + * gridData COUNTING + */ + + function gridDataCount(&$params, &$model) { + // Establish the tables and conditions for counting + $query = array_intersect_key($this->gridDataCountTables($params, $model), + array('link'=>1, 'contain'=>1)); + + // Add in the conditions and grouping + $query['conditions'] = $this->gridDataCountConditions($params, $model); + $query['group'] = $this->gridDataCountGroup($params, $model); + + // DEBUG PURPOSES ONLY! + $params['count_query'] = $query; + + // Get the number of records prior to pagination + return $this->gridDataCountExecute($params, $model, $query); } - function jqGridDataTables(&$params, &$model) { + function gridDataCountExecute(&$params, &$model, $query) { + return $model->find('count', $query); + } + + function gridDataCountTables(&$params, &$model) { + // Same tables for counting as for retreiving + return $this->gridDataTables($params, $model); + } + + function gridDataCountConditions(&$params, &$model) { + // Same conditions for counting as for retreiving + return $this->gridDataConditions($params, $model); + } + + function gridDataCountGroup(&$params, &$model) { + // Grouping will screw up the count, since it + // causes the results to be split into chunks + // based on the GROUP BY clause. We can't have + // more than one row of data in the count query, + // just a _single_ row with the actual count. + return null; + } + + + /************************************************************************** + ************************************************************************** + * gridData PAGINATION + */ + + function gridDataPagination(&$params, &$model, $record_count) { + // Retrieve, or calculate, all parameters necesssary for + // pagination. Verify the passed in parameters are valid. + + $limit = $params['rows'] > 0 ? $params['rows'] : 10; + $total = ($record_count < 0) ? 0 : ceil($record_count/$limit); + $page = ($params['page'] <= 1) ? 1 : (($params['page'] > $total) ? $total : $params['page']); + $start = $limit * ($page - 1); + + return compact('record_count', 'limit', 'page', 'start', 'total'); + } + + /************************************************************************** + ************************************************************************** + * gridData RETREIVAL + */ + + function gridDataRecords(&$params, &$model, $pagination) { + // Establish the tables for this query + $query = array_intersect_key($this->gridDataTables($params, $model), + array('link'=>1, 'contain'=>1)); + + // Add in the conditions and grouping + $query['conditions'] = $this->gridDataConditions($params, $model); + $query['group'] = $this->gridDataGroup($params, $model); + + // Grab the actual records taking pagination into account + $query['order'] = $this->gridDataOrder($params, $model, + isset($params['sidx']) ? $params['sidx'] : null, + isset($params['sord']) ? $params['sord'] : null); + $query['limit'] = $this->gridDataLimit($params, $model, $pagination['start'], $pagination['limit']); + $query['fields'] = $this->gridDataFields($params, $model); + + // DEBUG PURPOSES ONLY! + $params['query'] = $query; + + return $this->gridDataRecordsExecute($params, $model, $query); + } + + function gridDataRecordsExecute(&$params, &$model, $query) { + return $model->find('all', $query); + } + + function gridDataTables(&$params, &$model) { return array('contain' => false); } - function jqGridDataCountConditions(&$params, &$model) { - return $this->jqGridDataConditions($params, $model); - } - - function jqGridDataConditions(&$params, &$model) { + function gridDataConditions(&$params, &$model) { $searches = array(); if (isset($params['_search']) && $params['_search'] === 'true') { @@ -293,38 +368,73 @@ class AppController extends Controller { return $conditions; } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { return null; } - function jqGridDataCountGroup(&$params, &$model) { - return null; - } - - function jqGridDataGroup(&$params, &$model) { + function gridDataGroup(&$params, &$model) { return $model->alias.'.'.$model->primaryKey; } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { return $index ? array($index .' '. $direction) : null; } - function jqGridDataLimit(&$params, &$model, $start, $limit) { + function gridDataLimit(&$params, &$model, $start, $limit) { return $start . ', ' . $limit; } - function jqGridDataRecordCount(&$params, &$model, $query) { - return $model->find('count', $query); + + /************************************************************************** + ************************************************************************** + * gridData POST PROCESSING + */ + + function gridDataPostProcess(&$params, &$model, &$records) { + // Add grid IDs to each record + $this->gridDataPostProcessGridIDs($params, $model, $records); + + // Add the calculated fields (if any), to the model fields + $this->gridDataPostProcessCalculatedFields($params, $model, $records); + + // Perform any requested subtotaling of fields + $this->gridDataPostProcessSubtotal($params, $model, $records); + + // Add in any needed hyperlinks + $this->gridDataPostProcessLinks($params, $model, $records, array()); + + // DEBUG PURPOSES ONLY! + //$params['records'] = $records; } - function jqGridDataRecords(&$params, &$model, $query) { - return $model->find('all', $query); - } - - function jqGridRecordsPostProcess(&$params, &$model, &$records) { + function gridDataPostProcessGridIDs(&$params, &$model, &$records) { $model_alias = $model->alias; $id = $model->primaryKey; + foreach ($records AS &$record) { + $record['grid_id'] = $record[$model_alias][$id]; + } + } + + function gridDataPostProcessCalculatedFields(&$params, &$model, &$records) { + $model_alias = $model->alias; + + foreach ($records AS &$record) { + // Add the calculated fields (if any), to the model fields + if (isset($record[0])) { + $record[$model_alias] += $record[0]; + unset($record[0]); + } + } + } + + function gridDataPostProcessSubtotal(&$params, &$model, &$records) { + $model_alias = $model->alias; + + // REVISIT
\n$xml\n\n"); - } - } } ?> \ No newline at end of file diff --git a/controllers/accounts_controller.php b/controllers/accounts_controller.php index 4b65740..41fd841 100644 --- a/controllers/accounts_controller.php +++ b/controllers/accounts_controller.php @@ -35,34 +35,34 @@ class AccountsController extends AppController { */ function index() { $this->all(); } - function asset() { $this->jqGridView('Asset Accounts'); } - function liability() { $this->jqGridView('Liability Accounts'); } - function equity() { $this->jqGridView('Equity Accounts'); } - function income() { $this->jqGridView('Income Accounts'); } - function expense() { $this->jqGridView('Expense Accounts'); } - function all() { $this->jqGridView('All Accounts', 'all'); } + function asset() { $this->gridView('Asset Accounts'); } + function liability() { $this->gridView('Liability Accounts'); } + function equity() { $this->gridView('Equity Accounts'); } + function income() { $this->gridView('Income Accounts'); } + function expense() { $this->gridView('Expense Accounts'); } + function all() { $this->gridView('All Accounts', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); if (!isset($params['action'])) $params['action'] = 'all'; } - function jqGridDataCountTables(&$params, &$model) { - return parent::jqGridDataTables($params, $model); + function gridDataCountTables(&$params, &$model) { + return parent::gridDataTables($params, $model); } - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { return array ('link' => array(// Models @@ -74,13 +74,13 @@ class AccountsController extends AppController { ); } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { return array_merge(array('Account.*'), $this->Account->Ledger->LedgerEntry->debitCreditFields(true, 'LedgerEntry', 'CurrentLedger')); } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if (in_array($params['action'], array('asset', 'liability', 'equity', 'income', 'expense'))) { $conditions[] = array('Account.type' => strtoupper($params['action'])); @@ -89,9 +89,9 @@ class AccountsController extends AppController { return $conditions; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Account'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/contacts_controller.php b/controllers/contacts_controller.php index 19be865..eb09b2e 100644 --- a/controllers/contacts_controller.php +++ b/controllers/contacts_controller.php @@ -23,20 +23,20 @@ class ContactsController extends AppController { */ function index() { $this->all(); } - function all() { $this->jqGridView('All Contacts', 'all'); } + function all() { $this->gridView('All Contacts', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataOrder(&$params, &$model, $index, $direction) { - $order = parent::jqGridDataOrder($params, $model, $index, $direction); + function gridDataOrder(&$params, &$model, $index, $direction) { + $order = parent::gridDataOrder($params, $model, $index, $direction); if ($index === 'Contact.last_name') { $order[] = 'Contact.first_name ' . $direction; } @@ -46,9 +46,9 @@ class ContactsController extends AppController { return $order; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Contact'] = array('id'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/customers_controller.php b/controllers/customers_controller.php index 796a91e..0a7844c 100644 --- a/controllers/customers_controller.php +++ b/controllers/customers_controller.php @@ -31,25 +31,25 @@ class CustomersController extends AppController { */ function index() { $this->current(); } - function current() { $this->jqGridView('Current Tenants', 'current'); } - function past() { $this->jqGridView('Past Tenants'); } - function all() { $this->jqGridView('All Customers'); } + function current() { $this->gridView('Current Tenants', 'current'); } + function past() { $this->gridView('Past Tenants'); } + function all() { $this->gridView('All Customers'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); } - function jqGridDataCountTables(&$params, &$model) { + function gridDataCountTables(&$params, &$model) { return array ('link' => array(// Models @@ -59,13 +59,13 @@ class CustomersController extends AppController { ); } - function jqGridDataTables(&$params, &$model) { - $link = $this->jqGridDataCountTables($params, $model); + function gridDataTables(&$params, &$model) { + $link = $this->gridDataCountTables($params, $model); $link['link']['StatementEntry'] = array('fields' => array()); return $link; } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { $db = &$model->getDataSource(); $fields = $db->fields($model, $model->alias); $fields[] = ('COUNT(DISTINCT CurrentLease.id) AS lease_count'); @@ -74,8 +74,8 @@ class CustomersController extends AppController { return $fields; } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if ($params['action'] === 'current') { $conditions[] = 'CurrentLease.id IS NOT NULL'; @@ -87,24 +87,24 @@ class CustomersController extends AppController { return $conditions; } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { $order = array(); - $order[] = parent::jqGridDataOrder($params, $model, $index, $direction); + $order[] = parent::gridDataOrder($params, $model, $index, $direction); if ($index !== 'PrimaryContact.last_name') - $order[] = parent::jqGridDataOrder($params, $model, + $order[] = parent::gridDataOrder($params, $model, 'PrimaryContact.last_name', $direction); if ($index !== 'PrimaryContact.first_name') - $order[] = parent::jqGridDataOrder($params, $model, + $order[] = parent::gridDataOrder($params, $model, 'PrimaryContact.first_name', $direction); if ($index !== 'Customer.id') - $order[] = parent::jqGridDataOrder($params, $model, + $order[] = parent::gridDataOrder($params, $model, 'Customer.id', $direction); return $order; } - function jqGridDataRecordCount(&$params, &$model, $query) { + function gridDataCount(&$params, &$model, $query) { // We don't have a good way to use the query to obtain // our count. The problem is that we're relying on the @@ -112,7 +112,7 @@ class CustomersController extends AppController { // whether we omit the group by or leave it in. // So, build a fresh query for counting. - $query['conditions'] = parent::jqGridDataConditions($params, $model); + $query['conditions'] = parent::gridDataConditions($params, $model); $count = $model->find('count', array_merge(array('link' => array_diff_key($query['link'], @@ -137,9 +137,9 @@ class CustomersController extends AppController { return $count; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Customer'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/leases_controller.php b/controllers/leases_controller.php index 2dc4da3..a8b9bd1 100644 --- a/controllers/leases_controller.php +++ b/controllers/leases_controller.php @@ -29,39 +29,39 @@ class LeasesController extends AppController { */ function index() { $this->all(); } - function active() { $this->jqGridView('Active Leases'); } - function closed() { $this->jqGridView('Closed Leases'); } - function all() { $this->jqGridView('All Leases', 'all'); } + function active() { $this->gridView('Active Leases'); } + function closed() { $this->gridView('Closed Leases'); } + function all() { $this->gridView('All Leases', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); if (!isset($params['action'])) $params['action'] = 'all'; } - function jqGridDataCountTables(&$params, &$model) { + function gridDataCountTables(&$params, &$model) { return array ('link' => array('Unit' => array('fields' => array('Unit.id', 'Unit.name')), 'Customer' => array('fields' => array('Customer.id', 'Customer.name')))); } - function jqGridDataTables(&$params, &$model) { - $link = $this->jqGridDataCountTables($params, $model); + function gridDataTables(&$params, &$model) { + $link = $this->gridDataCountTables($params, $model); $link['link']['StatementEntry'] = array('fields' => array()); return $link; } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { $db = &$model->getDataSource(); $fields = $db->fields($model, $model->alias); $fields = array_merge($fields, @@ -69,8 +69,8 @@ class LeasesController extends AppController { return $fields; } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if ($params['action'] === 'active') { $conditions[] = 'Lease.close_date IS NULL'; @@ -85,7 +85,7 @@ class LeasesController extends AppController { return $conditions; } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { // Do not sort by number, which is type varchar and // sorts on an ascii basis. Sort by ID instead. if ($index === 'Lease.number') @@ -96,31 +96,31 @@ class LeasesController extends AppController { $index = 'Unit.sort_order'; $order = array(); - $order[] = parent::jqGridDataOrder($params, $model, $index, $direction); + $order[] = parent::gridDataOrder($params, $model, $index, $direction); // If sorting by anything other than id/number // add sorting by id as a secondary condition. if ($index !== 'Lease.id' && $index !== 'Lease.number') - $order[] = parent::jqGridDataOrder($params, $model, + $order[] = parent::gridDataOrder($params, $model, 'Lease.id', $direction); return $order; } -/* function jqGridRecordsPostProcess(&$params, &$model, &$records) { */ +/* function gridDataPostProcess(&$params, &$model, &$records) { */ /* foreach ($records AS &$record) { */ /* $record['Lease']['through_date'] */ /* = $this->Lease->rentChargeThrough($record['Lease']['id']); */ /* } */ -/* parent::jqGridRecordsPostProcess($params, $model, $records); */ +/* parent::gridDataPostProcess($params, $model, $records); */ /* } */ - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Lease'] = array('number'); $links['Unit'] = array('name'); $links['Customer'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/ledger_entries_controller.php b/controllers/ledger_entries_controller.php index 0a8cec2..cdd1d22 100644 --- a/controllers/ledger_entries_controller.php +++ b/controllers/ledger_entries_controller.php @@ -19,19 +19,19 @@ class LedgerEntriesController extends AppController { /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); if (isset($params['custom']['collected_account_id'])) $params['custom']['account_id'] = $params['custom']['collected_account_id']; } - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { $link = array(// Models 'Account' => @@ -97,8 +97,8 @@ class LedgerEntriesController extends AppController { return array('link' => $link); } - function jqGridDataFields(&$params, &$model) { - $fields = parent::jqGridDataFields($params, $model); + function gridDataFields(&$params, &$model) { + $fields = parent::gridDataFields($params, $model); if (!isset($fields)) $fields = array('Entry.*'); @@ -142,8 +142,8 @@ class LedgerEntriesController extends AppController { return $fields; } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if ($params['action'] === 'collected') { extract($params['custom']); @@ -225,7 +225,7 @@ class LedgerEntriesController extends AppController { return $conditions; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Transaction'] = array('id'); $links['Entry'] = array('id'); $links['Account'] = array('controller' => 'accounts', 'name'); @@ -235,17 +235,17 @@ class LedgerEntriesController extends AppController { $links['Customer'] = array('name'); $links['Lease'] = array('number'); $links['Unit'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } - function jqGridDataGroup(&$params, &$model) { - return parent::jqGridDataGroup($params, $model); + function gridDataGroup(&$params, &$model) { + return parent::gridDataGroup($params, $model); } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { /* if ($index === 'balance') */ /* return ($index .' '. $direction); */ - $order = parent::jqGridDataOrder($params, $model, $index, $direction); + $order = parent::gridDataOrder($params, $model, $index, $direction); if ($index === 'Transaction.stamp') { $order[] = 'Entry.id ' . $direction; @@ -254,7 +254,7 @@ class LedgerEntriesController extends AppController { return $order; } - function jqGridDataRecords(&$params, &$model, $query) { + function gridDataRecords(&$params, &$model, $query) { if ($params['action'] === 'collected') { $tquery = array_diff_key($query, array(/*'fields'=>1,*/'group'=>1,'limit'=>1,'order'=>1)); $tquery['group'] = array('AppliedPayment.id'); @@ -275,7 +275,7 @@ class LedgerEntriesController extends AppController { $params['userdata']['balance'] = $total[0]['balance']; } - return parent::jqGridDataRecords($params, $model, $query); + return parent::gridDataRecords($params, $model, $query); } diff --git a/controllers/ledgers_controller.php b/controllers/ledgers_controller.php index ac11490..528fd1a 100644 --- a/controllers/ledgers_controller.php +++ b/controllers/ledgers_controller.php @@ -29,31 +29,31 @@ class LedgersController extends AppController { */ function index() { $this->all(); } - function current() { $this->jqGridView('Current Ledgers'); } - function closed() { $this->jqGridView('Closed Ledgers'); } - function all() { $this->jqGridView('All Ledgers', 'all'); } + function current() { $this->gridView('Current Ledgers'); } + function closed() { $this->gridView('Closed Ledgers'); } + function all() { $this->gridView('All Ledgers', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); if (!isset($params['action'])) $params['action'] = 'all'; } - function jqGridDataCountTables(&$params, &$model) { + function gridDataCountTables(&$params, &$model) { return array('contain' => false); } - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { return array ('link' => array(// Models @@ -64,14 +64,14 @@ class LedgersController extends AppController { ); } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { return array_merge(array('Ledger.*', 'CONCAT(Account.id, "-", Ledger.sequence) AS id_sequence'), $this->Ledger->LedgerEntry->debitCreditFields(true)); } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if ($params['action'] === 'current') { $conditions[] = array('NOT' => array('Ledger.closed')); @@ -83,14 +83,14 @@ class LedgersController extends AppController { return $conditions; } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { $id_sequence = false; if ($index === 'id_sequence') { $id_sequence = true; $index = 'Ledger.account_id'; } - $order = parent::jqGridDataOrder($params, $model, $index, $direction); + $order = parent::gridDataOrder($params, $model, $index, $direction); if ($id_sequence) { $order[] = 'Ledger.sequence ' . $direction; @@ -99,10 +99,10 @@ class LedgersController extends AppController { return $order; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Ledger'] = array('id_sequence'); $links['Account'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/maps_controller.php b/controllers/maps_controller.php index ebeb991..cda6434 100644 --- a/controllers/maps_controller.php +++ b/controllers/maps_controller.php @@ -15,28 +15,28 @@ class MapsController extends AppController { */ function index() { $this->all(); } - function all() { $this->jqGridView('All Maps', 'all'); } + function all() { $this->gridView('All Maps', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { return array ('link' => array('SiteArea' => array('fields' => array('SiteArea.id', 'SiteArea.name')), ), ); } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Map'] = array('id'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/monetary_sources_controller.php b/controllers/monetary_sources_controller.php index 5fb50bd..fa7cd55 100644 --- a/controllers/monetary_sources_controller.php +++ b/controllers/monetary_sources_controller.php @@ -24,27 +24,27 @@ class MonetarySourcesController extends AppController { */ function index() { $this->all(); } - function all() { $this->jqGridView('All MonetarySources', 'all'); } + function all() { $this->gridView('All MonetarySources', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { return array ('contain' => false, ); } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['MonetarySource'] = array('id'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/statement_entries_controller.php b/controllers/statement_entries_controller.php index 00395b3..bd8eccf 100644 --- a/controllers/statement_entries_controller.php +++ b/controllers/statement_entries_controller.php @@ -19,17 +19,17 @@ class StatementEntriesController extends AppController { /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); } - function jqGridDataTables(&$params, &$model) { + function gridDataTables(&$params, &$model) { $link = array(// Models 'Transaction' => @@ -67,8 +67,8 @@ class StatementEntriesController extends AppController { return array('link' => $link); } - function jqGridDataFields(&$params, &$model) { - $fields = parent::jqGridDataFields($params, $model); + function gridDataFields(&$params, &$model) { + $fields = parent::gridDataFields($params, $model); if (!isset($fields)) $fields = array('StatementEntry.*'); @@ -97,8 +97,8 @@ class StatementEntriesController extends AppController { return $fields; } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); extract($params['custom']); if (isset($transaction_id)) @@ -138,22 +138,22 @@ class StatementEntriesController extends AppController { return $conditions; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['StatementEntry'] = array('id'); $links['Transaction'] = array('id'); $links['Account'] = array('name'); $links['Customer'] = array('name'); $links['Lease'] = array('number'); $links['Unit'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } - function jqGridDataGroup(&$params, &$model) { - return parent::jqGridDataGroup($params, $model); + function gridDataGroup(&$params, &$model) { + return parent::gridDataGroup($params, $model); } - function jqGridDataOrder(&$params, &$model, $index, $direction) { - $order = parent::jqGridDataOrder($params, $model, $index, $direction); + function gridDataOrder(&$params, &$model, $index, $direction) { + $order = parent::gridDataOrder($params, $model, $index, $direction); if ($index === 'Transaction.stamp') $order[] = 'StatementEntry.id ' . $direction; @@ -161,7 +161,7 @@ class StatementEntriesController extends AppController { return $order; } - function jqGridDataRecords(&$params, &$model, $query) { + function gridDataRecords(&$params, &$model, $query) { if ($params['action'] === 'collected') { $tquery = array_diff_key($query, array(/*'fields'=>1,*/'group'=>1,'limit'=>1,'order'=>1)); $tquery['group'] = array('AppliedPayment.id'); @@ -182,7 +182,7 @@ class StatementEntriesController extends AppController { $params['userdata']['balance'] = $total[0]['balance']; } - return parent::jqGridDataRecords($params, $model, $query); + return parent::gridDataRecords($params, $model, $query); } diff --git a/controllers/transactions_controller.php b/controllers/transactions_controller.php index 87c8895..3327c5f 100644 --- a/controllers/transactions_controller.php +++ b/controllers/transactions_controller.php @@ -29,21 +29,21 @@ class TransactionsController extends AppController { */ function index() { $this->all(); } - function all() { $this->jqGridView('All Transactions', 'all'); } + function all() { $this->gridView('All Transactions', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Transaction'] = array('id'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/controllers/units_controller.php b/controllers/units_controller.php index 1ed2513..63c469a 100644 --- a/controllers/units_controller.php +++ b/controllers/units_controller.php @@ -30,28 +30,28 @@ class UnitsController extends AppController { */ function index() { $this->all(); } - function unavailable() { $this->jqGridView('Unavailable Units'); } - function vacant() { $this->jqGridView('Vacant Units'); } - function occupied() { $this->jqGridView('Occupied Units'); } - function all() { $this->jqGridView('All Units', 'all'); } + function unavailable() { $this->gridView('Unavailable Units'); } + function vacant() { $this->gridView('Vacant Units'); } + function occupied() { $this->gridView('Occupied Units'); } + function all() { $this->gridView('All Units', 'all'); } /************************************************************************** ************************************************************************** ************************************************************************** - * virtuals: jqGridData - * - With the application controller handling the jqGridData action, + * virtuals: gridData + * - With the application controller handling the gridData action, * these virtual functions ensure that the correct data is passed * to jqGrid. */ - function jqGridDataSetup(&$params) { - parent::jqGridDataSetup($params); + function gridDataSetup(&$params) { + parent::gridDataSetup($params); if (!isset($params['action'])) $params['action'] = 'all'; } - function jqGridDataCountTables(&$params, &$model) { + function gridDataCountTables(&$params, &$model) { $link = array ('link' => array(// Models @@ -70,8 +70,8 @@ class UnitsController extends AppController { return $link; } - function jqGridDataTables(&$params, &$model) { - $link = $this->jqGridDataCountTables($params, $model); + function gridDataTables(&$params, &$model) { + $link = $this->gridDataCountTables($params, $model); $link['link']['CurrentLease']['LedgerEntry'] = array('fields' => array()); $link['link']['CurrentLease']['LedgerEntry']['Ledger'] = array('fields' => array()); $link['link']['CurrentLease']['LedgerEntry']['Ledger']['Account'] = array('fields' => array()); @@ -89,7 +89,7 @@ class UnitsController extends AppController { return $link; } - function jqGridDataFields(&$params, &$model) { + function gridDataFields(&$params, &$model) { $db = &$model->getDataSource(); $fields = $db->fields($model, $model->alias); $fields[] = ("SUM(IF(Account.id IS NULL, 0," . @@ -99,8 +99,8 @@ class UnitsController extends AppController { return $fields; } - function jqGridDataConditions(&$params, &$model) { - $conditions = parent::jqGridDataConditions($params, $model); + function gridDataConditions(&$params, &$model) { + $conditions = parent::gridDataConditions($params, $model); if ($params['action'] === 'unavailable') { $conditions[] = $this->Unit->conditionUnavailable(); @@ -118,27 +118,27 @@ class UnitsController extends AppController { return $conditions; } - function jqGridDataOrder(&$params, &$model, $index, $direction) { + function gridDataOrder(&$params, &$model, $index, $direction) { // Instead of sorting by name, sort by defined order if ($index === 'Unit.name') $index = 'Unit.sort_order'; $order = array(); - $order[] = parent::jqGridDataOrder($params, $model, $index, $direction); + $order[] = parent::gridDataOrder($params, $model, $index, $direction); // If sorting by anything other than name (defined order) // add the sort-order as a secondary condition if ($index !== 'Unit.name') - $order[] = parent::jqGridDataOrder($params, $model, + $order[] = parent::gridDataOrder($params, $model, 'Unit.sort_order', $direction); return $order; } - function jqGridRecordLinks(&$params, &$model, &$records, $links) { + function gridDataPostProcessLinks(&$params, &$model, &$records, $links) { $links['Unit'] = array('name'); $links['UnitSize'] = array('name'); - return parent::jqGridRecordLinks($params, $model, $records, $links); + return parent::gridDataPostProcessLinks($params, $model, $records, $links); } diff --git a/views/elements/jqGrid.ctp b/views/elements/jqGrid.ctp index e098ee5..1715759 100644 --- a/views/elements/jqGrid.ctp +++ b/views/elements/jqGrid.ctp @@ -62,7 +62,7 @@ $javascript->link('pmgr_jqGrid', false); // we'll just pass the desired fields to the controller // as part of the data fetch. $url = $html->url(array('controller' => $controller, - 'action' => 'jqGridData', + 'action' => 'gridData', 'debug' => 0, ));