Show statsUtils.lib.inc.php syntax highlighted
<?php // $Id: statsUtils.lib.inc.php 2 2005-07-15 13:01:38Z roane $
/*
==============================================================================
Dokeos - elearning and course management software
Copyright (c) 2004 Dokeos S.A.
Copyright (c) 2003 University of Ghent (UGent)
Copyright (c) 2001 Universite catholique de Louvain (UCL)
Copyright (c) various contributors
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: Dokeos, 181 rue Royale, B-1000 Brussels, Belgium, info@dokeos.com
==============================================================================
*/
/**
==============================================================================
* This is the statistic utility functions library for Dokeos.
* Include/require it in your code to use its functionality.
*
* @package dokeos.library
==============================================================================
*/
/*
==============================================================================
FUNCTIONS
==============================================================================
*/
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @desc return one result from a sql query (1 single result)
*/
function getOneResult($sql)
{
$query = @mysql_query($sql);
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
}
$res = @mysql_fetch_array($query);
return $res[0];
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @desc Return many results of a query in a 1 column tab
*/
function getManyResults1Col($sql)
{
$res = mysql_query($sql);
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
}
else
{
$i = 0;
while ($resA = mysql_fetch_array($res))
{
$resu[$i++]=$resA[0];
}
}
return $resu;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @desc Return many results of a query
*/
function getManyResults2Col($sql)
{
$res = mysql_query($sql);
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
}
else
{
$i = 0;
while ($resA = mysql_fetch_array($res))
{
$resu[$i][0] = $resA[0];
$resu[$i][1] = $resA[1];
$i++;
}
}
return $resu;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @desc Return many results of a query in a 3 column tab
in $resu[$i][0], $resu[$i][1],$resu[$i][2]
*/
function getManyResults3Col($sql)
{
$res = mysql_query($sql);
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
}
else
{
$i = 0;
while ($resA = mysql_fetch_array($res))
{
$resu[$i][0]=$resA[0];
$resu[$i][1]=$resA[1];
$resu[$i][2]=$resA[2];
$i++;
}
}
return $resu;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @desc Return many results of a query in a X column tab
in $resu[$i][0], $resu[$i][1],$resu[$i][2],...
this function is more 'standard' but use a little
more ressources
So I encourage to use the dedicated for 1, 2 or 3
columns of results
*/
function getManyResultsXCol($sql,$X)
{
$res = mysql_query($sql);
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
}
else
{
$i = 0;
while ($resA = mysql_fetch_array($res))
{
for($j = 0; $j < $X ; $j++)
{
$resu[$i][$j]=$resA[$j];
}
$i++;
}
}
return $resu;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @return hours_array
* @desc Return an assoc array. Keys are the hours, values are
the number of time this hours was found.
key "total" return the sum of all number of time hours
appear
*/
function hoursTab($sql)
{
$query = mysql_query( $sql );
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
$hours_array["total"] = 0;
}
else
{
$hours_array["total"] = 0;
while( $row = mysql_fetch_row( $query ) )
{
$date_array = getdate($row[0]);
if($date_array["hours"] == $last_hours )
{
$hours_array[$date_array["hours"]]++;
}
else
{
$hours_array[$date_array["hours"]] = 1;
$last_hours = $date_array["hours"];
}
$hours_array["total"]++;
}
mysql_free_result ($query);
}
return $hours_array;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @return days_array
* @desc Return an assoc array. Keys are the days, values are
the number of time this hours was found.
key "total" return the sum of all number of time days
appear
*/
function daysTab($sql)
{
$MonthsShort = array (get_lang("JanuaryShort"), get_lang("FebruaryShort"), get_lang("MarchShort"), get_lang("AprilShort"), get_lang("MayShort"), get_lang("JuneShort"), get_lang("JulyShort"), get_lang("AugustShort"), get_lang("SeptemberShort"), get_lang("OctoberShort"), get_lang("NovemberShort"), get_lang("DecemberShort"));
$query = mysql_query( $sql );
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
$days_array["total"] = 0;
}
else
{
$days_array["total"] = 0;
while( $row = mysql_fetch_row( $query ) )
{
$date_array = getdate($row[0]);
$display_date = $date_array["mday"]." ".$MonthsShort[$date_array["mon"]-1]." ".$date_array["year"];
if ($date_array["mday"] == $last_day)
{
$days_array[$display_date]++;
}
else
{
$days_array[$display_date] = 1;
$last_day = $display_date;
}
$days_array["total"]++;
}
mysql_free_result ($query);
}
return $days_array;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param sql : a sql query (as a string)
* @return month_array
* @desc Return an assoc array. Keys are the days, values are
the number of time this hours was found.
key "total" return the sum of all number of time days
appear
*/
function monthTab($sql)
{
$MonthsLong = array (get_lang("JanuaryLong"), get_lang("FebruaryLong"), get_lang("MarchLong"), get_lang("AprilLong"), get_lang("MayLong"), get_lang("JuneLong"), get_lang("JulyLong"), get_lang("AugustLong"), get_lang("SeptemberLong"), get_lang("OctoberLong"), get_lang("NovemberLong"), get_lang("DecemberLong"));
$query = mysql_query( $sql );
if (mysql_errno())
{
echo "\n<!-- **** ".mysql_errno().": ".mysql_error()." In : $sql **** -->\n";
$days_array["total"] = 0;
}
else
{
// init tab with all month
for($i = 0;$i < 12; $i++)
{
$month_array[$MonthsLong[$i]] = 0;
}
// and with total
$month_array["total"] = 0;
while( $row = mysql_fetch_row( $query ) )
{
$date_array = getdate($row[0]);
$month_array[$MonthsLong[$date_array["mon"]-1]]++;
$month_array["total"]++;
}
mysql_free_result ($query);
}
return $month_array;
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param period_array : an array provided by hoursTab($sql) or daysTab($sql)
* @param periodTitle : title of the first column, type of period
* @param linkOnPeriod :
* @desc Display a 4 column array
Columns are : hour of day, graph, number of hits and %
First line are titles
next are informations
Last is total number of hits
*/
function makeHitsTable($period_array,$periodTitle,$linkOnPeriod = "???")
{
global $langHits;
global $langTotal;
echo "<table width='100%' cellpadding='0' cellspacing='1' border='0' align=center class='minitext'>";
// titles
echo "<tr bgcolor='#E6E6E6' align='center'>
<td width='15%' >
<b>$periodTitle</b>
</td>
<td width='60%' >
</td>
<td width='10%'>
<b>$langHits</b>
</td>
<td width='15%'>
<b>%</b>
</td>
</tr>
";
$factor = 4;
$maxSize = $factor * 100; //pixels
while(list($periodPiece,$cpt) = each($period_array))
{
if($periodPiece != "total")
{
$pourcent = round(100 * $cpt / $period_array["total"]);
$barwidth = $factor * $pourcent ;
echo "<tr>
<td align='center' width='15%'>";
echo $periodPiece;
echo "</td>
<td width='60%' style='padding-top : 3px;' align='center'>"
// display hitbar
."<img src='../img/bar_1.gif' width='1' height='12' alt='$periodPiece : $cpt hits - $pourcent %'>";
if($pourcent != 0)
echo "<img src='../img/bar_1u.gif' width='$barwidth' height='12' alt='$periodPiece : $cpt hits - $pourcent %'>";
// display 100% bar
if($pourcent != 100 && $pourcent != 0)
echo "<img src='../img/bar_1m.gif' width='1' height='12' alt='$periodPiece : $cpt hits - $pourcent %'>";
if($pourcent != 100)
echo "<img src='../img/bar_1r.gif' width='".($maxSize-$barwidth)."' height='12' alt='$periodPiece : $cpt hits - $pourcent %'>";
echo "<img src='../img/bar_1.gif' width='1' height='12' alt='$periodPiece : $cpt hits - $pourcent %'>
</td>
<td align='center' width='10%'>
$cpt
</td>
<td align='center' width='15%'>
$pourcent %
</td>
</tr>
";
}
}
echo "<tr bgcolor='#E6E6E6' >
<td width='15%' align='center'>
$langTotal
</td>
<td align='right' width='60%'>
</td>
<td align='center' width='10%'>
".$period_array["total"]."
</td>
<td width='15%'>
</td>
</tr>
";
echo "</table>";
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param tableau : a 2 columns array
* @param title1 : string, title of the first column
* @param title2 : string, title of the ... second column
* @desc display a 2 column tab from an array
titles of columns are title1 and title2
*/
function buildTab2col($array_of_results,$title1,$title2)
{
global $langNoResult;
echo "<table cellpadding='2' cellspacing='1' border='1' align='center'>";
echo "<tr>
<td bgcolor='#E6E6E6'>
$title1
</td>
<td bgcolor='#E6E6E6'>
$title2
</td>
</tr>";
if (is_array($tableau))
{
for($j = 0 ; $j < count($array_of_results) ; $j++)
{
echo "<tr>";
echo "<td bgcolor='#eeeeee'>".$array_of_results[$j][0]."</td>";
echo "<td align='right'>".$array_of_results[$j][1]."</td>";
echo"</tr>";
}
}
else
{
echo "<tr>";
echo "<td colspan='2'><center>".$langNoResult."</center></td>";
echo"</tr>";
}
echo "</table>";
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param tableau : a 2 columns array
* @desc display a 2 column tab from an array
this tab has no title
*/
function buildTab2ColNoTitle($array_of_results)
{
global $langNoResult;
echo "<table cellpadding='3' cellspacing='1' border='0' align='center'>";
if (is_array($array_of_results))
{
for($j = 0 ; $j < count($array_of_results) ; $j++)
{
echo "<tr>";
echo "<td bgcolor='#eeeeee'>".$array_of_results[$j][0]."</td>";
echo "<td align='right'> ".$array_of_results[$j][1]."</td>";
echo"</tr>";
}
}
else
{
echo "<tr>";
echo "<td colspan='2'><center>".$langNoResult."</center></td>";
echo"</tr>";
}
echo "</table>";
}
/**
* @author Sebastien Piraux <piraux_seb@hotmail.com>
* @param tableau : a 2 columns array
* @desc this function is used to display
integrity errors in the platform
if array_of_results is not an array there is
no error, else errors are displayed
*/
function buildTabDefcon($array_of_results)
{
global $langDefcon;
global $langAllRight;
global $langNULLValue;
echo "<table width='60%' cellpadding='2' cellspacing='1' border='0' align=center class='minitext'>";
if (is_array($array_of_results))
{
// there is some strange cases ...
echo "<tr>";
echo "<td colspan='2' bgcolor='#eeeeee'><font color='#ff0000'><center>".$langDefcon."</center></font></td>";
echo"</tr>";
for($j = 0 ; $j < count($array_of_results) ; $j++)
{
if($array_of_results[$j][0] == "")
{
$key = $langNULLValue;
}
else
{
$key = $array_of_results[$j][0];
}
echo "<tr>";
echo "<td width='70%' class='content'>".$key."</td>";
echo "<td width='30%' align='right'>".$array_of_results[$j][1]."</td>";
echo"</tr>";
}
}
else
{
// all right
echo "<tr>";
echo "<td colspan='2'><font color='#00ff00'><center>".$langAllRight."</center></font></td>";
echo"</tr>";
}
echo "</table>";
}
/**
* @author Christophe Gesché <gesche@ipm.ucl.ac.be>
* @param formatOfDate
see http://www.php.net/manual/en/function.strftime.php
for syntax to use for this string
* @param timestamp timestamp of date to format
* @desc display a date at localized format
*/
function dateLocalizer($formatOfDate,$timestamp = -1) //PMAInspiration :)
{
//$langMonthNames = $GLOBALS["langMonthNames"];
//$langDay_of_weekNames = $GLOBALS["langDay_of_weekNames"];
// the variables for the days and the months
// Defining the shorts for the days
$DaysShort = array (get_lang("SundayShort"), get_lang("MondayShort"), get_lang("TuesdayShort"), get_lang("WednesdayShort"), get_lang("ThursdayShort"), get_lang("FridayShort"), get_lang("SaturdayShort"));
// Defining the days of the week to allow translation of the days
$DaysLong = array (get_lang("SundayLong"), get_lang("MondayLong"), get_lang("TuesdayLong"), get_lang("WednesdayLong"), get_lang("ThursdayLong"), get_lang("FridayLong"), get_lang("SaturdayLong"));
// Defining the months of the year to allow translation of the months
$MonthsLong = array (get_lang("JanuaryLong"), get_lang("FebruaryLong"), get_lang("MarchLong"), get_lang("AprilLong"), get_lang("MayLong"), get_lang("JuneLong"), get_lang("JulyLong"), get_lang("AugustLong"), get_lang("SeptemberLong"), get_lang("OctoberLong"), get_lang("NovemberLong"), get_lang("DecemberLong"));
// Defining the months of the year to allow translation of the months
$MonthsShort = array (get_lang("JanuaryShort"), get_lang("FebruaryShort"), get_lang("MarchShort"), get_lang("AprilShort"), get_lang("MayShort"), get_lang("JuneShort"), get_lang("JulyShort"), get_lang("AugustShort"), get_lang("SeptemberShort"), get_lang("OctoberShort"), get_lang("NovemberShort"), get_lang("DecemberShort"));
if ($timestamp == -1)
{
$timestamp = time();
}
// avec un ereg on fait nous même le replace des jours et des mois
// with the ereg we replace %aAbB of date format
//(they can be done by the system when locale date aren't aivailable
$date = ereg_replace('%[A]', $DaysLong[(int)strftime('%w', $timestamp)], $formatOfDate);
$date = ereg_replace('%[a]', $DaysShort[(int)strftime('%w', $timestamp)], $date);
$date = ereg_replace('%[B]', $MonthsLong[(int)strftime('%m', $timestamp)-1], $date);
$date = ereg_replace('%[b]', $MonthsShort[(int)strftime('%m', $timestamp)-1], $date);
return strftime($date, $timestamp);
}
/**
* changeResultOfVisibility($array_of_results)
* @author Christophe Gesché <gesche@ipm.ucl.ac.be>
* @param array_of_results
* @desc complete the content of visibility column a with the litteral meaning
*/
function changeResultOfVisibility($array_of_results)
{
global $langNoResult;
$visibilityLabel[0]="closed - hide";
$visibilityLabel[1]="open - hide";
$visibilityLabel[2]="open - visible";
$visibilityLabel[3]="closed - visible";
if (is_array($array_of_results))
{
for($j = 0 ; $j < count($array_of_results) ; $j++)
{
$array_of_results[$j][0] = $array_of_results[$j][0]." <small>(".$visibilityLabel[$array_of_results[$j][0]].")</small>";
$array_of_results[$j][1] = $array_of_results[$j][1];
}
}
return $array_of_results;
}
See more files for this project here