From a6365b3f699e29795efb950527d173471a336977 Mon Sep 17 00:00:00 2001
From: Allan Jardine <allan.jardine@sprymedia.co.uk>
Date: Fri, 29 Oct 2010 08:48:13 +0100
Subject: [PATCH] Updated: Server-side processing script for column re-ordering
 has been updated to take account of sNames parameter which is sent in from
 DataTables, and also brought up to date with the main server-side processing
 script.

Changed: From the previous commit sNames sent from the client to server is now a comma seperated list of sNames and is always sent regardless of if names are given or not. This matches the sName formatting for the server-to-client return.
---
 .../server_processing_ordering.php            | 204 +++++++++++++-----
 media/js/jquery.dataTables.js                 |   7 +-
 2 files changed, 156 insertions(+), 55 deletions(-)

diff --git a/examples/examples_support/server_processing_ordering.php b/examples/examples_support/server_processing_ordering.php
index 4031b0a5..d38bced6 100644
--- a/examples/examples_support/server_processing_ordering.php
+++ b/examples/examples_support/server_processing_ordering.php
@@ -1,14 +1,77 @@
 <?php
-  /* MySQL connection */
-	include( $_SERVER['DOCUMENT_ROOT']."/datatables/mysql.php" ); /* ;-) */
+	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+	 * Readme...
+	 * 
+	 * This script is basically the same as the server_processing.php script, but with a couple of
+	 * modifications to show how column reordering can be handled by DataTables. This is in two
+	 * parts:
+	 * 
+	 *   1. Data from server to client - notice that the $aColumns array below is in a different
+	 * order to that from the array in server_processing.php, but DataTables will render the
+	 * table in the same order. This reordering is done on the client-side by using the sNames 
+	 * parameter which is passed back, stating the order which the server is sending data back in.
+	 * DataTables will compaire this to the sName parameter for each column and reorder as needed.
+	 * 
+	 *   2. Data from client to server - in order that the columns can be sent to the server in
+	 * any order (it is expected in this script that the server-side will always work with a static
+	 * array which is not reordered dynamically) DataTables will send the parameter 'sNames' which
+	 * like it's return counterpart is a comma seperated list of the column names, telling the
+	 * server-side what order the columns are being shown on the client-side. As such it is now
+	 * possible to realise what column sSearch_{i} (for example) refers to. This is done by a look
+	 * up of the aColumns array from the names sent in. Note that I've used the same names for the
+	 * db table columns and the html table columns to make things a little clearer, but this is not
+	 * required.
+	 */
 	
+	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+	 * Easy set variables
+	 */
+	
+	/* Array of database columns which should be read and sent back to DataTables. Use a space where
+	 * you want to insert a non-database field (for example a counter or static image)
+	 */
+	$aColumns = array( 'browser', 'platform', 'version', 'grade', 'engine' );
+	
+	/* Indexed column (used for fast and accurate table cardinality) */
+	$sIndexColumn = "id";
+	
+	/* DB table to use */
+	$sTable = "ajax";
+	
+	/* Database connection information */
+	$gaSql['user']       = "";
+	$gaSql['password']   = "";
+	$gaSql['db']         = "";
+	$gaSql['server']     = "localhost";
+	
+	/* REMOVE THIS LINE (it just includes my SQL connection user/pass) */
+	include( $_SERVER['DOCUMENT_ROOT']."/datatables/mysql.php" );
+	
+	
+	/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+	 * If you just want to use the basic configuration for DataTables with PHP server-side, there is
+	 * no need to edit below this line
+	 */
+	
+	/* 
+	 * MySQL connection
+	 */
 	$gaSql['link'] =  mysql_pconnect( $gaSql['server'], $gaSql['user'], $gaSql['password']  ) or
 		die( 'Could not open connection to server' );
 	
 	mysql_select_db( $gaSql['db'], $gaSql['link'] ) or 
 		die( 'Could not select database '. $gaSql['db'] );
 	
-	/* Paging */
+	
+	/*
+	 * Names - this is specific to server-side column re-ordering
+	 */
+	$aNames = explode( ',', $_GET['sNames'] );
+	
+	
+	/* 
+	 * Paging
+	 */
 	$sLimit = "";
 	if ( isset( $_GET['iDisplayStart'] ) && $_GET['iDisplayLength'] != '-1' )
 	{
@@ -16,38 +79,82 @@
 			mysql_real_escape_string( $_GET['iDisplayLength'] );
 	}
 	
-	/* Ordering */
+	
+	/*
+	 * Ordering
+	 */
 	if ( isset( $_GET['iSortCol_0'] ) )
 	{
 		$sOrder = "ORDER BY  ";
-		for ( $i=0 ; $i<mysql_real_escape_string( $_GET['iSortingCols'] ) ; $i++ )
+		for ( $i=0 ; $i<intval( $_GET['iSortingCols'] ) ; $i++ )
 		{
-			$sOrder .= fnColumnToField(mysql_real_escape_string( $_GET['iSortCol_'.$i] ))."
-			 	".mysql_real_escape_string( $_GET['sSortDir_'.$i] ) .", ";
+			if ( $_GET[ 'bSortable_'.intval($_GET['iSortCol_'.$i]) ] == "true" )
+			{
+				$iColumnIndex = array_search( $aNames[intval( $_GET['iSortCol_'.$i] )], $aColumns );
+				$sOrder .= $aColumns[ $iColumnIndex ]."
+				 	".mysql_real_escape_string( $_GET['sSortDir_'.$i] ) .", ";
+			}
 		}
+		
 		$sOrder = substr_replace( $sOrder, "", -2 );
+		if ( $sOrder == "ORDER BY" )
+		{
+			$sOrder = "";
+		}
 	}
 	
-	/* Filtering */
+	
+	/* 
+	 * Filtering
+	 * NOTE this does not match the built-in DataTables filtering which does it
+	 * word by word on any field. It's possible to do here, but concerned about efficiency
+	 * on very large tables, and MySQL's regex functionality is very limited
+	 */
 	$sWhere = "";
 	if ( $_GET['sSearch'] != "" )
 	{
-		$sWhere = "WHERE engine LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%' OR ".
-		                "browser LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%' OR ".
-		                "platform LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%' OR ".
-		                "version LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%' OR ".
-		                "grade LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%'";
+		$sWhere = "WHERE (";
+		for ( $i=0 ; $i<count($aColumns) ; $i++ )
+		{
+			$sWhere .= $aColumns[$i]." LIKE '%".mysql_real_escape_string( $_GET['sSearch'] )."%' OR ";
+		}
+		$sWhere = substr_replace( $sWhere, "", -3 );
+		$sWhere .= ')';
 	}
 	
+	/* Individual column filtering */
+	for ( $i=0 ; $i<count($aColumns) ; $i++ )
+	{
+		if ( $_GET['bSearchable_'.$i] == "true" && $_GET['sSearch_'.$i] != '' )
+		{
+			if ( $sWhere == "" )
+			{
+				$sWhere = "WHERE ";
+			}
+			else
+			{
+				$sWhere .= " AND ";
+			}
+			$iColumnIndex = array_search( $aNames[$i], $aColumns );
+			$sWhere .= $aColumns[$iColumnIndex]." LIKE '%".mysql_real_escape_string($_GET['sSearch_'.$i])."%' ";
+		}
+	}
+	
+	
+	/*
+	 * SQL queries
+	 * Get data to display
+	 */
 	$sQuery = "
-		SELECT SQL_CALC_FOUND_ROWS id, engine, browser, platform, version, grade
-		FROM   ajax
+		SELECT SQL_CALC_FOUND_ROWS ".str_replace(" , ", " ", implode(", ", $aColumns))."
+		FROM   $sTable
 		$sWhere
 		$sOrder
 		$sLimit
 	";
 	$rResult = mysql_query( $sQuery, $gaSql['link'] ) or die(mysql_error());
 	
+	/* Data set length after filtering */
 	$sQuery = "
 		SELECT FOUND_ROWS()
 	";
@@ -55,50 +162,45 @@
 	$aResultFilterTotal = mysql_fetch_array($rResultFilterTotal);
 	$iFilteredTotal = $aResultFilterTotal[0];
 	
+	/* Total data set length */
 	$sQuery = "
-		SELECT COUNT(id)
-		FROM   ajax
+		SELECT COUNT(".$sIndexColumn.")
+		FROM   $sTable
 	";
 	$rResultTotal = mysql_query( $sQuery, $gaSql['link'] ) or die(mysql_error());
 	$aResultTotal = mysql_fetch_array($rResultTotal);
 	$iTotal = $aResultTotal[0];
 	
-	$sOutput = '{';
-	$sOutput .= '"sEcho": '.intval($_GET['sEcho']).', ';
-	$sOutput .= '"iTotalRecords": '.$iTotal.', ';
-	$sOutput .= '"iTotalDisplayRecords": '.$iFilteredTotal.', ';
-	$sOutput .= '"sColumns": "platform,engine,browser,grade,version",';
-	$sOutput .= '"aaData": [ ';
+	
+	/*
+	 * Output
+	 */
+	$output = array(
+		"sEcho" => intval($_GET['sEcho']),
+		"sColumns" => implode( ',', $aColumns ),
+		"iTotalRecords" => $iTotal,
+		"iTotalDisplayRecords" => $iFilteredTotal,
+		"aaData" => array()
+	);
+	
 	while ( $aRow = mysql_fetch_array( $rResult ) )
 	{
-		$sOutput .= "[";
-		$sOutput .= '"'.str_replace('"', '\"', $aRow['platform']).'",';
-		$sOutput .= '"'.str_replace('"', '\"', $aRow['engine']).'",';
-		$sOutput .= '"'.str_replace('"', '\"', $aRow['browser']).'",';
-		$sOutput .= '"'.str_replace('"', '\"', $aRow['grade']).'",';
-		if ( $aRow['version'] == "0" )
-			$sOutput .= '"-"';
-		else
-			$sOutput .= '"'.str_replace('"', '\"', $aRow['version']).'"';
-		$sOutput .= "],";
+		$row = array();
+		for ( $i=0 ; $i<count($aColumns) ; $i++ )
+		{
+			if ( $aColumns[$i] == "version" )
+			{
+				/* Special output formatting for 'version' column */
+				$row[] = ($aRow[ $aColumns[$i] ]=="0") ? '-' : $aRow[ $aColumns[$i] ];
+			}
+			else if ( $aColumns[$i] != ' ' )
+			{
+				/* General output */
+				$row[] = $aRow[ $aColumns[$i] ];
+			}
+		}
+		$output['aaData'][] = $row;
 	}
-	$sOutput = substr_replace( $sOutput, "", -1 );
-	$sOutput .= '] }';
 	
-	echo $sOutput;
-	
-	
-	function fnColumnToField( $i )
-	{
-		if ( $i == 0 )
-			return "engine";
-		else if ( $i == 1 )
-			return "browser";
-		else if ( $i == 2 )
-			return "platform";
-		else if ( $i == 3 )
-			return "version";
-		else if ( $i == 4 )
-			return "grade";
-	}
+	echo json_encode( $output );
 ?>
\ No newline at end of file
diff --git a/media/js/jquery.dataTables.js b/media/js/jquery.dataTables.js
index c4ffb45e..929818af 100644
--- a/media/js/jquery.dataTables.js
+++ b/media/js/jquery.dataTables.js
@@ -3158,13 +3158,12 @@
 					oSettings._iDisplayLength : -1 } );
 				
 				/* Column names */
+				var aNames = [];
 				for ( i=0 ; i<iColumns ; i++ )
 				{
-					if ( oSettings.aoColumns[i].sName != '' )
-					{
-						aoData.push( { "name": "sName"+i, "value": oSettings.aoColumns[i].sName } );
-					}
+					aNames.push( oSettings.aoColumns[i].sName );
 				}
+				aoData.push( { "name": "sNames", "value": aNames.join(',') } );
 				
 				/* Filtering */
 				if ( oSettings.oFeatures.bFilter !== false )