'table table-bordered data_table', 'id' => $table_id]; } $this->table_id = $table_id; parent::__construct($parameters); $this->table_name = $table_name; $this->additional_parameters = []; $this->param_prefix = $table_name.'_'; $this->defaultColumn = (int) $default_column; $this->defaultItemsPerPage = $default_items_per_page; $this->hideItemSelector = false; $defaultRow = api_get_configuration_value('table_default_row'); if (!empty($defaultRow)) { $this->defaultItemsPerPage = $default_items_per_page = $defaultRow; } $cleanSessionData = Session::read('clean_sortable_table'); if ($cleanSessionData === true) { $this->cleanUrlSessionParams(); } // Allow to change paginate in multiples tabs //Session::erase($this->param_prefix.'per_page'); $this->per_page = Session::read($this->param_prefix.'per_page', $default_items_per_page); // If per page changed, then reset the page to 1 if (!empty($this->per_page) && isset($_GET[$this->param_prefix.'per_page']) && $this->per_page != $_GET[$this->param_prefix.'per_page']) { Session::erase($this->param_prefix.'page_nr'); $_GET[$this->param_prefix.'page_nr'] = 1; } $this->per_page = isset($_GET[$this->param_prefix.'per_page']) ? (int) $_GET[$this->param_prefix.'per_page'] : $this->per_page; if (isset($_GET[$this->param_prefix.'per_page'])) { Session::erase($this->param_prefix.'page_nr'); } $this->page_nr = Session::read($this->param_prefix.'page_nr', 1); $this->page_nr = isset($_GET[$this->param_prefix.'page_nr']) ? (int) $_GET[$this->param_prefix.'page_nr'] : $this->page_nr; $this->column = Session::read($this->param_prefix.'column', $default_column); $this->column = isset($_GET[$this->param_prefix.'column']) ? (int) $_GET[$this->param_prefix.'column'] : $this->column; // Default direction. if (in_array(strtoupper($default_order_direction), ['ASC', 'DESC'])) { $this->direction = $default_order_direction; } $my_session_direction = Session::read($this->param_prefix.'direction'); if (!empty($my_session_direction)) { if (!in_array($my_session_direction, ['ASC', 'DESC'])) { $this->direction = 'ASC'; } else { if ($my_session_direction === 'ASC') { $this->direction = 'ASC'; } elseif ($my_session_direction === 'DESC') { $this->direction = 'DESC'; } } } if (isset($_GET[$this->param_prefix.'direction'])) { $my_get_direction = $_GET[$this->param_prefix.'direction']; if (!in_array($my_get_direction, ['ASC', 'DESC'])) { $this->direction = 'ASC'; } else { if ($my_get_direction === 'ASC') { $this->direction = 'ASC'; } elseif ($my_get_direction === 'DESC') { $this->direction = 'DESC'; } } } Session::write($this->param_prefix.'per_page', $this->per_page); Session::write($this->param_prefix.'direction', $this->direction); Session::write($this->param_prefix.'page_nr', $this->page_nr); Session::write($this->param_prefix.'column', $this->column); $this->pager = null; $this->default_items_per_page = $default_items_per_page; $this->total_number_of_items = -1; $this->get_total_number_function = $get_total_number_function; $this->get_data_function = $get_data_function; $this->column_filters = []; $this->form_actions = []; $this->checkbox_name = null; $this->td_attributes = []; $this->th_attributes = []; $this->other_tables = []; $this->dataFunctionParams = []; } /** * Clean URL params when changing student view. */ public function cleanUrlSessionParams() { Session::erase('clean_sortable_table'); $prefix = $this->param_prefix; Session::erase($prefix.'page_nr'); Session::erase($prefix.'column'); Session::erase($prefix.'direction'); Session::erase($prefix.'per_page'); $_GET[$this->param_prefix.'per_page'] = $this->default_items_per_page; $_GET[$this->param_prefix.'page_nr'] = 1; $_GET[$this->param_prefix.'column'] = $this->defaultColumn; $_GET[$this->param_prefix.'direction'] = $this->direction; } /** * @return array */ public function getDataFunctionParams() { return $this->dataFunctionParams; } /** * @param array $dataFunctionParams * * @return $this */ public function setDataFunctionParams($dataFunctionParams) { $this->dataFunctionParams = $dataFunctionParams; return $this; } /** * Get the Pager object to split the showed data in several pages. * * @return Pager_Sliding */ public function get_pager() { if ($this->pager === null) { $params['mode'] = 'Sliding'; $params['perPage'] = $this->per_page; $params['totalItems'] = $this->get_total_number_of_items(); $params['urlVar'] = $this->param_prefix.'page_nr'; $params['currentPage'] = $this->page_nr; $icon_attributes = ['style' => 'vertical-align: middle;']; $params['prevImg'] = Display:: return_icon( 'action_prev.png', get_lang('Previous page'), $icon_attributes ); $params['nextImg'] = Display:: return_icon( 'action_next.png', get_lang('Next page'), $icon_attributes ); $params['firstPageText'] = Display:: return_icon( 'action_first.png', get_lang('First page'), $icon_attributes ); $params['lastPageText'] = Display:: return_icon( 'action_last.png', get_lang('Last page'), $icon_attributes ); $params['firstPagePre'] = ''; $params['lastPagePre'] = ''; $params['firstPagePost'] = ''; $params['lastPagePost'] = ''; $params['spacesBeforeSeparator'] = ''; $params['spacesAfterSeparator'] = ''; $query_vars = array_keys($_GET); $query_vars_needed = [ $this->param_prefix.'column', $this->param_prefix.'direction', $this->param_prefix.'per_page', ]; if (!empty($this->additional_parameters) && count($this->additional_parameters) > 0) { $query_vars_needed = array_merge( $query_vars_needed, array_keys($this->additional_parameters) ); } $query_vars_exclude = array_diff($query_vars, $query_vars_needed); $params['excludeVars'] = $query_vars_exclude; $this->pager = &Pager::factory($params); } return $this->pager; } /** * Display the table. */ public function display() { echo $this->return_table(); } /** * Displays the table, complete with navigation buttons to browse through * the data-pages. */ public function return_table() { $empty_table = false; $content = $this->get_table_html(); if ($this->get_total_number_of_items() == 0) { $cols = $this->getColCount(); $this->setCellAttributes( 1, 0, 'style="font-style: italic;text-align:center;" colspan='.$cols ); $message_empty = api_xml_http_response_encode(get_lang('Empty')); $this->setCellContents(1, 0, $message_empty); $empty_table = true; } $html = ''; if (!$empty_table) { $table_id = 'form_'.$this->table_name.'_id'; $form = $this->get_page_select_form(); $nav = $this->get_navigation_html(); // Only show pagination info when there are items to paginate if ($this->get_total_number_of_items() > $this->default_items_per_page) { $html = '
$parameters['action'] = 'test'; will be convert in
*
.
*
* @param array $parameters
*/
public function set_additional_parameters($parameters)
{
$this->additional_parameters = $parameters;
}
/**
* Set other tables on the same page.
* If you have other sortable tables on the page displaying this sortable
* tables, you can define those other tables with this function. If you
* don't define the other tables, there sorting and pagination will return
* to their default state when sorting this table.
*
* @param array $tablenames an array of table names
*/
public function set_other_tables($tablenames)
{
$this->other_tables = $tablenames;
}
/**
* Transform all data in a table-row, using the filters defined by the
* function set_column_filter(...) defined elsewhere in this class.
* If you've defined actions, the first element of the given row will be
* converted into a checkbox.
*
* @param array $row a row from the table
*
* @return array
*/
public function filter_data($row)
{
$url_params = $this->get_sortable_table_param_string().'&'.$this->get_additional_url_paramstring();
foreach ($this->column_filters as $column => &$function) {
$firstParam = isset($row[$column]) ? $row[$column] : 0;
$row[$column] = call_user_func($function, $firstParam, $url_params, $row);
}
if (count($this->form_actions) > 0) {
if (strlen($row[0]) > 0) {
$row[0] = '';
}
}
if (is_array($row)) {
foreach ($row as &$value) {
if (empty($value)) {
$value = '-';
}
}
}
return $row;
}
/**
* Get the total number of items. This function calls the function given as
* 2nd argument in the constructor of a SortableTable. Make sure your
* function has the same parameters as defined here.
*/
public function get_total_number_of_items()
{
if ($this->total_number_of_items == -1 && !is_null($this->get_total_number_function)) {
$this->total_number_of_items = call_user_func(
$this->get_total_number_function,
$this->getDataFunctionParams()
);
}
return $this->total_number_of_items;
}
/**
* @param int $value
*/
public function setTotalNumberOfItems($value)
{
$this->total_number_of_items = (int) $value;
}
/**
* Get the data to display. This function calls the function given as
* 2nd argument in the constructor of a SortableTable. Make sure your
* function has the same parameters as defined here.
*
* @param int $from index of the first item to return
* @param int $per_page The number of items to return
* @param int $column The number of the column on which the data should be
* @param bool $sort Whether to sort or not
* sorted
* @param string $direction In which order should the data be sorted (ASC
* or DESC)
*
* @return array
*/
public function get_table_data(
$from = null,
$per_page = null,
$column = null,
$direction = null,
$sort = null
) {
$data = [];
if ($this->get_data_function !== null) {
$data = call_user_func(
$this->get_data_function,
$from,
$this->per_page,
$this->column,
$this->direction,
$this->dataFunctionParams
);
}
return $data;
}
/**
* @param array $data
*/
public function setTableData($data)
{
$this->table_data = $data;
}
}