Feature #272 - TableSort class: Cleaning and coding conventions.

main/inc/lib/tablesort.lib.php

@@ -1,47 +1,23 @@
 <?php
-/*
+/* For licensing terms, see /license.txt */
-==============================================================================
-	Dokeos - elearning and course management software
 
-	Copyright (c) 2004-2008 Dokeos S.A.
-	Copyright (c) 2003 Ghent University (UGent)
-	Copyright (c) 2001 Universite catholique de Louvain (UCL)
-	Copyright (c) Bart Mollet (bart.mollet@hogent.be)
-
-	For a full list of contributors, see "credits.txt".
-	The full license can be read in "license.txt".
-
-	This program is free software; you can redistribute it and/or
-	modify it under the terms of the GNU General Public License
-	as published by the Free Software Foundation; either version 2
-	of the License, or (at your option) any later version.
-
-	See the GNU General Public License for more details.
-
-	Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
-	Mail: info@dokeos.com
-==============================================================================
-*/
 /**
-==============================================================================
+ *	This is a library with some functions to sort tabular data
-*	This is a library with some functions to sort tabular data
+ *
-*
+ *	@package chamilo.library
-*	@package dokeos.library
+ */
-==============================================================================
-*/
 
 define('SORT_DATE', 3);
 define('SORT_IMAGE',4);
 
-class TableSort
+class TableSort {
-{
+
 	/**
-	 * Create a string to use in sorting.
+	 * Creates a string to use in sorting.
 	 * @param string $txt The string to convert
 	 * @author René Haentjens
 	 */
-	function orderingstring($txt)
+	function orderingstring($txt) {
-	{
 		return api_strtolower($txt);
 	}
 
@@ -69,14 +45,14 @@ class TableSort
 		}
 		if ($el1 > $el2) {
 			return 1;
-		} elseif ($el1 > $el2) {
+		} elseif ($el1 < $el2) {
 			return -1;
 		}
 		return 0;
 	}
 
 	/**
-	 * Sort 2-dimensional table.
+	 * Sorts 2-dimensional table.
 	 * @param array $data The data to be sorted.
 	 * @param int $column The column on which the data should be sorted (default = 0)
 	 * @param string $direction The direction to sort (SORT_ASC (default) or SORT_DESC)
@@ -85,33 +61,33 @@ class TableSort
 	 * @return array The sorted dataset
 	 * @author bart.mollet@hogent.be
 	 */
-	function sort_table($data, $column = 0, $direction = SORT_ASC, $type = SORT_REGULAR)
+	function sort_table($data, $column = 0, $direction = SORT_ASC, $type = SORT_REGULAR) {
-	{
+		if (!is_array($data) or count($data) == 0) {
-		if(!is_array($data) or count($data)==0){return array();}
+			return array();
-        if($column != strval(intval($column))){return $data;} //probably an attack
+		}
-        if(!in_array($direction,array(SORT_ASC,SORT_DESC))){return $data;} // probably an attack
+        if ($column != strval(intval($column))) {
+        	// Probably an attack
+        	return $data;
+        }
+        if (!in_array($direction, array(SORT_ASC, SORT_DESC))) {
+        	// Probably an attack
+        	return $data;
+        }
+
         $compare_function = '';
-        if ($type == SORT_REGULAR)
+        if ($type == SORT_REGULAR) {
-        {
+			if (TableSort::is_image_column($data, $column)) {
-			if (TableSort::is_image_column($data, $column))
-			{
 				$type = SORT_IMAGE;
-			}
+			} elseif (TableSort::is_date_column($data, $column)) {
-			elseif (TableSort::is_date_column($data, $column))
-			{
 				$type = SORT_DATE;
-			}
+			} elseif (TableSort::is_numeric_column($data, $column)) {
-			elseif (TableSort::is_numeric_column($data, $column))
-			{
 				$type = SORT_NUMERIC;
-			}
+			} else {
-			else
-			{
 				$type = SORT_STRING;
 			}
         }
-		switch ($type)
+
-		{
+		switch ($type) {
 			case SORT_NUMERIC :
 				$compare_function = 'strip_tags($el1) > strip_tags($el2)';
 				break;
@@ -134,77 +110,69 @@ class TableSort
 
 		return $data;
 	}
+
 	/**
-	 * Checks if a column of a 2D-array contains only numeric values
+	 * Checks whether a column of a 2D-array contains only numeric values
 	 * @param array $data The data-array
 	 * @param int $column The index of the column to check
 	 * @return bool true if column contains only dates, false otherwise
 	 * @todo Take locale into account (eg decimal point or comma ?)
 	 * @author bart.mollet@hogent.be
 	 */
-	function is_numeric_column($data, $column)
+	function is_numeric_column($data, $column) {
-	{
 		$is_numeric = true;
 
-		foreach ($data as $index => $row)
+		foreach ($data as $index => $row) {
-		{
 			$is_numeric &= is_numeric(strip_tags($row[$column]));
 		}
 
 		return $is_numeric;
 	}
+
 	/**
-	 * Checks if a column of a 2D-array contains only dates (GNU date syntax)
+	 * Checks whether a column of a 2D-array contains only dates (GNU date syntax)
 	 * @param array $data The data-array
 	 * @param int $column The index of the column to check
 	 * @return bool true if column contains only dates, false otherwise
 	 * @author bart.mollet@hogent.be
 	 */
-	function is_date_column($data, $column)
+	function is_date_column($data, $column) {
-	{
 		$is_date = true;
-		foreach ($data as $index => $row)
+		foreach ($data as $index => $row) {
-		{
 			if (strpos($row[$column], '<!--uts=') !== false) {
 				// A hidden raw date value (an integer Unix time stamp) has been detected. It is needed for precise sorting.
 				$is_date &= true;
-			}
+			} elseif (strlen(strip_tags($row[$column])) != 0) {
-			elseif (strlen(strip_tags($row[$column])) != 0 )
-			{
 				$check_date = strtotime(strip_tags($row[$column]));
 				// strtotime Returns a timestamp on success, FALSE otherwise.
 				// Previous to PHP 5.1.0, this function would return -1 on failure.
 				$is_date &= ($check_date != -1 && $check_date != false);
-			}
+			} else {
-			else
-			{
 				$is_date &= false;
 			}
 		}
 		return $is_date;
 	}
+
 	/**
-	 * Checks if a column of a 2D-array contains only images (<img src="
+	 * Checks whether a column of a 2D-array contains only images (<img src="
 	 * path/file.ext" alt=".."/>)
 	 * @param array $data The data-array
 	 * @param int $column The index of the column to check
 	 * @return bool true if column contains only images, false otherwise
 	 * @author bart.mollet@hogent.be
 	 */
-	function is_image_column($data, $column)
+	function is_image_column($data, $column) {
-	{
 		$is_image = true;
-		foreach ($data as $index => $row)
+		foreach ($data as $index => $row) {
-		{
 			$is_image &= strlen(trim(strip_tags($row[$column],'<img>'))) > 0; // at least one img-tag
 			$is_image &= strlen(trim(strip_tags($row[$column]))) == 0; // and no text outside attribute-values
 		}
 		return $is_image;
 	}
 
-
 	/**
-	 * Sort 2-dimensional table. It is possile of change the columns that will be show and the way that the columns are sorted.
+	 * Sorts 2-dimensional table. It is possile changing the columns that will be shown and the way that the columns are to be sorted.
 	 * @param array $data The data to be sorted.
 	 * @param int $column The column on which the data should be sorted (default = 0)
 	 * @param string $direction The direction to sort (SORT_ASC (default) orSORT_DESC)
@@ -214,47 +182,43 @@ class TableSort
 	 * @return array The sorted dataset
 	 * @author bart.mollet@hogent.be
 	 */
+	function sort_table_config($data, $column = 0, $direction = SORT_ASC, $column_show = null, $column_order = null, $type = SORT_REGULAR) {
+        if (!is_array($data) or count($data) == 0) {
+        	return array();
+        }
+        if ($column != strval(intval($column))) {
+        	// Probably an attack
+        	return $data;
+        }
+        if (!in_array($direction, array(SORT_ASC, SORT_DESC))) {
+        	// Probably an attack
+        	return $data;
+        }
 
-	function sort_table_config($data, $column = 0, $direction = SORT_ASC, $column_show=null, $column_order=null,$type = SORT_REGULAR)
-	{
-        if(!is_array($data) or count($data)==0){return array();}
-        if($column != strval(intval($column))){return $data;} //probably an attack
-        if(!in_array($direction,array(SORT_ASC,SORT_DESC))){return $data;} // probably an attack
         $compare_function = '';
 		// Change columns sort
 	 	// Here we say that the real way of how the columns are going to be order is manage by the $column_order array
-	 	if(is_array($column_order))
+	 	if (is_array($column_order)) {
-	 	{
+			for ($i = 0; $i < count($column_order); $i++) {
-			for($i=0;$i<count($column_order);$i++)
+				if ($column == $i + 1) {
-			{
+					$column = $column_order[$i];
-				if ($column== $i+1)
-				{
-					$column=$column_order[$i];
 				}
 			}
 	 	}
 
-		if ($type == SORT_REGULAR)
+		if ($type == SORT_REGULAR) {
-		{
+			if (TableSort::is_image_column($data, $column)) {
-			if (TableSort::is_image_column($data, $column))
-			{
 				$type = SORT_IMAGE;
-			}
+			} elseif (TableSort::is_date_column($data, $column)) {
-			elseif (TableSort::is_date_column($data, $column))
-			{
 				$type =  SORT_DATE;
-			}
+			} elseif (TableSort::is_numeric_column($data, $column)) {
-			elseif (TableSort::is_numeric_column($data, $column))
-			{
 				$type =  SORT_NUMERIC;
-			}
+			} else {
-			else
-			{
 				$type = SORT_STRING;
 			}
 		}
-	 	switch ($type)
+
-		{
+	 	switch ($type) {
 			case SORT_NUMERIC :
 				$compare_function = 'strip_tags($el1) > strip_tags($el2)';
 				break;
@@ -275,31 +239,22 @@ class TableSort
 		// Sort the content
 		usort($data, create_function('$a,$b', $function_body));
 
+		if (is_array($column_show)) {
 			// We show only the columns data that were set up on the $column_show array
-		$new_order_data=array();
+			$new_order_data = array();
-
+			for ($j = 0; $j < count($data); $j++) {
-		if(is_array($column_show))
+				$k = 0;
-		{
+				for ($i = 0; $i < count($column_show); $i++) {
-
+					if ($column_show[$i]) {
-			for ($j=0;$j<count($data);$j++)
+						$new_order_data[$j][$k] = $data[$j][$i];
-			{
-				$k=0;
-				for ($i=0;$i<count($column_show);$i++)
-				{
-					if ($column_show[$i])
-					{
-						$new_order_data[$j][$k]=$data[$j][$i];
 					}
 					$k++;
 				}
 			}
-			//replace the multi-arrays
+			// Replace the multi-arrays
-			$data=$new_order_data;
+			$data = $new_order_data;
-		}
-		else
-		{
-			return $data;
 		}
+
 		return $data;
 	}