L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-52036 tablelib: Fix the behaviour of resetting table preferences

Browse Source 
The problem with the previous implementation was that the table's
$this->prefs can contain valid non-empty value in its default state -
the default column to sort by. On resetting, we must not throw away
these default prefs.

This patch simplifies the TABLE_VAR_RESET interpretation. If such an
HTTP parameter is passed via the request, the table simply behaves as if
there were no previously stored preferences (does not matter if coming
from the current session, or from the persistent cross-session storage).

The logic that decides on whether or not the reset widget should be
displayed is put into a new method can_be_reset() with unit tests
attached.

Finally, the previously private method render_reset_button() is now
protected and the reset widget is given a new semantic CSS class.
This commit is contained in:
David Mudrák
2015-11-04 15:07:17 +01:00
parent 4cef723c22
commit 19168d0934
3 changed files with 195 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/tablelib.php
+43 -27
View File
@@ -458,7 +458,9 @@ class flexible_table {
} else if (isset($SESSION->flextable[$this->uniqueid])) {
$this->prefs = $SESSION->flextable[$this->uniqueid];
}
if (!$this->prefs) {
// Set up default preferences if needed.
if (!$this->prefs or optional_param($this->request[TABLE_VAR_RESET], false, PARAM_BOOL)) {
$this->prefs = array(
'collapse' => array(),
'sortby' => array(),
@@ -526,17 +528,6 @@ class flexible_table {
$this->prefs['i_first'] = $ifirst;
}
// Allow user to reset table preferences.
if (optional_param($this->request[TABLE_VAR_RESET], 0, PARAM_BOOL) === 1) {
$this->prefs = array(
'collapse' => array(),
'sortby' => array(),
'i_first' => '',
'i_last' => '',
'textsort' => $this->column_textsort,
);
}
// Save user preferences if they have changed.
if ($this->prefs != $oldprefs) {
if ($this->persistent) {
@@ -1416,32 +1407,57 @@ class flexible_table {
/**
* Generate the HTML for the table preferences reset button.
*
* @return string HTML fragment.
* @return string HTML fragment, empty string if no need to reset
*/
private function render_reset_button() {
$userprefs = false;
// Loop through the user table preferences for a setting.
foreach ($this->prefs as $preference) {
if (!empty($preference)) {
// We have a preference.
$userprefs = true;
// We only need one.
break;
}
}
// If no table preferences have been set then don't show the reset button.
if (!$userprefs) {
protected function render_reset_button() {
if (!$this->can_be_reset()) {
return '';
}
$url = $this->baseurl->out(false, array($this->request[TABLE_VAR_RESET] => 1));
$html = html_writer::start_div('mdl-right');
$html = html_writer::start_div('resettable mdl-right');
$html .= html_writer::link($url, get_string('resettable'));
$html .= html_writer::end_div();
return $html;
}
/**
* Are there some table preferences that can be reset?
*
* If true, then the "reset table preferences" widget should be displayed.
*
* @return bool
*/
protected function can_be_reset() {
// Loop through preferences and make sure they are empty or set to the default value.
foreach ($this->prefs as $prefname => $prefval) {
if ($prefname === 'sortby' and !empty($this->sort_default_column)) {
// Check if the actual sorting differs from the default one.
if (empty($prefval) or $prefval !== array($this->sort_default_column => $this->sort_default_order)) {
return true;
}
} else if ($prefname === 'collapse' and !empty($prefval)) {
// Check if there are some collapsed columns (all are expanded by default).
foreach ($prefval as $columnname => $iscollapsed) {
if ($iscollapsed) {
return true;
}
}
} else if (!empty($prefval)) {
// For all other cases, we just check if some preference is set.
return true;
}
}
return false;
}
}