abijah/pmgr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Renamed jqGridData functions to be just gridData. Restructured the virtual function calls with an anticipated need for gridDataCount to be overridden as a whole, instead of just overriding the individual pieces.

Browse Source 
git-svn-id: file:///svn-source/pmgr/branches/yafr_20090716@361 97e9348a-65ac-dc4b-aefc-98561f571b83
This commit is contained in:
abijah
2009-07-22 17:06:44 +00:00
parent 93ebc450fe
commit 7aa026f4e0
13 changed files with 391 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

362
site/app_controller.php
View File

@@ -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 "<?xml version='1.0' encoding='utf-8'?>\n";
echo "<rows>\n";
$this->jqGridDataOutputSummary($params, $model, $page, $total, $count);
$this->jqGridDataOutputRecords($params, $model, $results);
echo "</rows>\n";
// Output the resulting record set
$this->gridDataOutput($params, $model, $records, $pagination);
// Call out to finalize everything
$this->jqGridDataFinalize($params);
$this->gridDataFinalize($params);
}
/**************************************************************************
**************************************************************************
**************************************************************************
* virtual: jqGridData* functions
* - These set up the context for the jqGrid data, and will
**************************************************************************
**************************************************************************
* virtual: gridData* functions
* - These set up the context for the grid data, and will
* need to be overridden in the derived class for anything
* other than the most basic of grids.
*/
function jqGridDataSetup(&$params) {
/**************************************************************************
**************************************************************************
**************************************************************************
* gridData SETUP / CLEANUP
*/
function gridDataModel(&$params) {
return $this->{$this->modelClass};
}
function gridDataSetup(&$params) {
// Assume we're debugging.
// The actual jqGrid request will set this to false
// The actual grid request will set this to false
$debug = true;
if (isset($this->passedArgs['debug']))
@@ -188,7 +168,10 @@ class AppController extends Controller {
$params['debug'] = $debug;
if (!$debug) {
if ($debug) {
ob_start();
}
else {
$this->layout = null;
$this->autoLayout = false;
$this->autoRender = false;
@@ -224,25 +207,117 @@ class AppController extends Controller {
$params['action'] = null;
}
function jqGridDataModel(&$params) {
return $this->{$this->modelClass};
function gridDataFinalize(&$params) {
if ($params['debug']) {
$xml = ob_get_contents();
ob_end_clean();
$xml = preg_replace("/&/", "&amp;", $xml);
$xml = preg_replace("/</", "&lt;", $xml);
$xml = preg_replace("/>/", "&gt;", $xml);
echo ("\n<PRE>\n$xml\n</PRE>\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 <AP>: 20090722
// Horrible solution to something that should be done
// in SQL. But, it works for now, so what the heck...
$subtotals = array();
foreach ($params['fields'] AS $field) {
if (preg_match('/subtotal-(.*)$/', $field, $matches))
@@ -334,13 +444,6 @@ class AppController extends Controller {
}
foreach ($records AS &$record) {
$record['jqGrid_id'] = $record[$model_alias][$id];
// Add the calculated fields (if any), to the model fields
if (isset($record[0])) {
$record[$model_alias] += $record[0];
unset($record[0]);
}
foreach ($subtotals AS &$subtotal) {
$field = $subtotal['field'];
if (preg_match("/\./", $field)) {
@@ -354,12 +457,9 @@ class AppController extends Controller {
}
}
}
// DEBUG PURPOSES ONLY!
//$params['records'] = $records;
}
function jqGridRecordLinks(&$params, &$model, &$records, $links) {
function gridDataPostProcessLinks(&$params, &$model, &$records, $links) {
// Don't create any links if ordered not to.
if (isset($params['nolinks']))
return;
@@ -392,20 +492,44 @@ class AppController extends Controller {
}
}
function jqGridDataOutputHeader(&$params, &$model) {
if ($params['debug']) {
ob_start();
}
else {
/**************************************************************************
**************************************************************************
* gridData OUTPUT
*/
function gridDataOutput(&$params, &$model, &$records, $pagination) {
$this->gridDataOutputHeader($params, $model);
$this->gridDataOutputXMLHeader($params, $model);
$this->gridDataOutputRootNodeBegin($params, $model);
$this->gridDataOutputSummary($params, $model, $pagination);
$this->gridDataOutputRecords($params, $model, $records);
$this->gridDataOutputRootNodeEnd($params, $model);
}
function gridDataOutputHeader(&$params, &$model) {
if (!$params['debug']) {
header("Content-type: text/xml;charset=utf-8");
}
}
function jqGridDataOutputSummary(&$params, &$model, $page, $total, $records) {
function gridDataOutputXMLHeader(&$params, &$model) {
echo "<?xml version='1.0' encoding='utf-8'?>\n";
}
function gridDataOutputRootNodeBegin(&$params, &$model) {
echo "<rows>\n";
}
function gridDataOutputRootNodeEnd(&$params, &$model) {
echo "</rows>\n";
}
function gridDataOutputSummary(&$params, &$model, $pagination) {
echo " <params><![CDATA[\n" . print_r($params, true) . "\n]]></params>\n";
echo " <page>$page</page>\n";
echo " <total>$total</total>\n";
echo " <records>$records</records>\n";
echo " <page>{$pagination['page']}</page>\n";
echo " <total>{$pagination['total']}</total>\n";
echo " <records>{$pagination['record_count']}</records>\n";
if (isset($params['userdata'])) {
foreach ($params['userdata'] AS $field => $value)
@@ -413,23 +537,23 @@ class AppController extends Controller {
}
}
function jqGridDataOutputRecords(&$params, &$model, &$records) {
$id_field = 'jqGrid_id';
function gridDataOutputRecords(&$params, &$model, &$records) {
$id_field = 'grid_id';
foreach ($records AS $record) {
$this->jqGridDataOutputRecord($params, $model, $record,
$this->gridDataOutputRecord($params, $model, $record,
$record[$id_field], $params['fields']);
}
}
function jqGridDataOutputRecord(&$params, &$model, &$record, $id, $fields) {
function gridDataOutputRecord(&$params, &$model, &$record, $id, $fields) {
echo " <row id='$id'>\n";
foreach ($fields AS $field) {
$this->jqGridDataOutputRecordField($params, $model, $record, $field);
$this->gridDataOutputRecordField($params, $model, $record, $field);
}
echo " </row>\n";
}
function jqGridDataOutputRecordField(&$params, &$model, &$record, $field) {
function gridDataOutputRecordField(&$params, &$model, &$record, $field) {
if (preg_match("/\./", $field)) {
list($tbl, $col) = explode(".", $field);
$data = $record[$tbl][$col];
@@ -437,10 +561,10 @@ class AppController extends Controller {
else {
$data = $record[$model->alias][$field];
}
$this->jqGridDataOutputRecordCell($params, $model, $record, $field, $data);
$this->gridDataOutputRecordCell($params, $model, $record, $field, $data);
}
function jqGridDataOutputRecordCell(&$params, &$model, &$record, $field, $data) {
function gridDataOutputRecordCell(&$params, &$model, &$record, $field, $data) {
// be sure to put text data in CDATA
if (preg_match("/^\d*$/", $data))
echo " <cell>$data</cell>\n";
@@ -448,17 +572,5 @@ class AppController extends Controller {
echo " <cell><![CDATA[$data]]></cell>\n";
}
function jqGridDataFinalize(&$params) {
if ($params['debug']) {
$xml = ob_get_contents();
ob_end_clean();
$xml = preg_replace("/&/", "&amp;", $xml);
$xml = preg_replace("/</", "&lt;", $xml);
$xml = preg_replace("/>/", "&gt;", $xml);
echo ("\n<PRE>\n$xml\n</PRE>\n");
}
}
}
?>