File Source for gradebook_data

<?php
/**
* Class to select, sort and transform object data into array data,
* used for the general gradebook view
* @author Bert Stepp�
*/
class GradebookDataGenerator
{
// Sorting types constants
const GDG_SORT_TYPE = 1;
const GDG_SORT_NAME = 2;
const GDG_SORT_DESCRIPTION = 4;
const GDG_SORT_WEIGHT = 8;
const GDG_SORT_DATE = 16;
const GDG_SORT_ASC = 32;
const GDG_SORT_DESC = 64;
private $items;
function GradebookDataGenerator($cats = array(), $evals = array(), $links = array())
{
$allcats = (isset($cats) ? $cats : array());
$allevals = (isset($evals) ? $evals : array());
$alllinks = (isset($links) ? $links : array());
// merge categories, evaluations and links
$this->items = array_merge($allcats, $allevals, $alllinks);
}
/**
* Get total number of items (rows)
*/
public function get_total_items_count()
{
return count($this->items);
}
/**
* Get actual array data
* @return array 2-dimensional array - each array contains the elements:
* 0: cat/eval/link object
* 1: item name
* 2: description
* 3: weight
* 4: date
* 5: student's score (if student logged in)
*/
public function get_data ($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
{
// do some checks on count, redefine if invalid value
if (!isset($count))
$count = count ($this->items) - $start;
if ($count < 0)
$count = 0;
$allitems = $this->items;
// sort array
if ($sorting & self :: GDG_SORT_TYPE)
usort($allitems, array('GradebookDataGenerator', 'sort_by_type'));
elseif ($sorting & self :: GDG_SORT_NAME)
usort($allitems, array('GradebookDataGenerator', 'sort_by_name'));
elseif ($sorting & self :: GDG_SORT_DESCRIPTION)
usort($allitems, array('GradebookDataGenerator', 'sort_by_description'));
elseif ($sorting & self :: GDG_SORT_WEIGHT)
usort($allitems, array('GradebookDataGenerator', 'sort_by_weight'));
elseif ($sorting & self :: GDG_SORT_DATE)
usort($allitems, array('GradebookDataGenerator', 'sort_by_date'));
if ($sorting & self :: GDG_SORT_DESC)
$allitems = array_reverse($allitems);
// get selected items
$visibleitems = array_slice($allitems, $start, $count);
// generate the data to display
$data = array();
foreach ($visibleitems as $item)
{
$row = array ();
$row[] = $item;
$row[] = $item->get_name();
$row[] = $item->get_description();
$row[] = $item->get_weight();
$row[] = $this->build_date_column ($item);
if (!api_is_allowed_to_create_course())
$row[] = $this->build_result_column ($item, $ignore_score_color);
$row[] = $this->get_certificate_link ($item);
$data[] = $row;
}
return $data;
}
/**
* Returns the link to the certificate generation, if the score is enough, otherwise
* returns an empty string. This only works with categories.
* @param object Item
*/
function get_certificate_link($item)
{
if(is_a($item, 'Category'))
{
if($item->is_certificate_available(api_get_user_id()))
{
$link = '<a href="gradebook.php?export_certificate=1&cat='.$item->get_id().'&user='.api_get_user_id().'">'.get_lang('Certificate').'</a>';
return $link;
}
}
return '';
}
// Sort functions
// Make sure to only use functions as defined in the GradebookItem interface !
function sort_by_name($item1, $item2)
{
if (strtolower($item1->get_name()) == strtolower($item2->get_name()))
return 0;
else
return (strtolower($item1->get_name()) < strtolower($item2->get_name()) ? -1 : 1);
}
function sort_by_type($item1, $item2)
{
if ($item1->get_item_type() == $item2->get_item_type())
return $this->sort_by_name($item1,$item2);
else
return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
}
function sort_by_description($item1, $item2)
{
if (strtolower($item1->get_description()) == strtolower($item2->get_description()))
return $this->sort_by_name($item1,$item2);
else
return (strtolower($item1->get_description()) < strtolower($item2->get_description()) ? -1 : 1);
}
function sort_by_weight($item1, $item2)
{
if ($item1->get_weight() == $item2->get_weight())
return $this->sort_by_name($item1,$item2);
else
return ($item1->get_weight() < $item2->get_weight() ? -1 : 1);
}
function sort_by_date($item1, $item2)
{
if ($item1->get_date() == $item2->get_date())
return $this->sort_by_name($item1,$item2);
else
return ($item1->get_date() < $item2->get_date() ? -1 : 1);
}
// Other functions
private function build_result_column ($item, $ignore_score_color)
{
$scoredisplay = ScoreDisplay :: instance();
$score = $item->calc_score(api_get_user_id());
switch ($item->get_item_type())
{
// category
case 'C' :
if ($score != null)
{
$displaytype = SCORE_PERCENT;
if ($ignore_score_color)
$displaytype |= SCORE_IGNORE_SPLIT;
return get_lang('Total') . ' : '
. $scoredisplay->display_score($score,$displaytype);
}
else
return '';
// evaluation and link
case 'E' :
case 'L' :
$displaytype = SCORE_DIV_PERCENT;
if ($ignore_score_color)
$displaytype |= SCORE_IGNORE_SPLIT;
return $scoredisplay->display_score($score,$displaytype);
}
}
private function build_date_column ($item)
{
$date = $item->get_date();
if (!isset($date) || empty($date))
return '';
else
return date("j/n/Y g:i", $date);
}
}
?>

Source for file gradebook_data_generator.class.php