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

MDL-66297 forumreport_summary: Added filter data to forum export links

Browse Source 
From/to date filter timestamps, as well as discussion IDs of any
filtered groups.
This commit is contained in:
Michael Hawkins
2019-11-08 11:13:36 +08:00
parent 2e7a16b954
commit 64da1d093a
12 changed files with 130 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
mod/forum/report/summary/amd/build/filters.min.js
Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
mod/forum/report/summary/amd/build/filters.min.js.map
+1 -1
View File
File diff suppressed because one or more lines are too long
mod/forum/report/summary/amd/build/selectors.min.js
Vendored
+1 -1
View File
@@ -1,2 +1,2 @@
define ("forumreport_summary/selectors",["exports"],function(a){"use strict";Object.defineProperty(a,"__esModule",{value:!0});a.default=void 0;a.default={filters:{group:{checkbox:"[data-region=\"filter-groups\"] input[type=\"checkbox\"]",clear:"[data-region=\"filter-groups\"] .filter-clear",popover:"#filter-groups-popover",save:"[data-region=\"filter-groups\"] .filter-save",selectall:"[data-region=\"filter-groups\"] .select-all",trigger:"#filter-groups-button"},date:{calendar:"#dateselector-calendar-panel",calendariconfrom:"#id_filterdatefrompopover_calendar",calendariconto:"#id_filterdatetopopover_calendar",popover:"#filter-dates-popover",save:"[data-region=\"filter-dates\"] .filter-save",trigger:"#filter-dates-button"}}};return a.default});
define ("forumreport_summary/selectors",["exports"],function(a){"use strict";Object.defineProperty(a,"__esModule",{value:!0});a.default=void 0;a.default={filters:{group:{checkbox:"[data-region=\"filter-groups\"] input[type=\"checkbox\"]",clear:"[data-region=\"filter-groups\"] .filter-clear",popover:"#filter-groups-popover",save:"[data-region=\"filter-groups\"] .filter-save",selectall:"[data-region=\"filter-groups\"] .select-all",trigger:"#filter-groups-button"},date:{calendar:"#dateselector-calendar-panel",calendariconfrom:"#id_filterdatefrompopover_calendar",calendariconto:"#id_filterdatetopopover_calendar",popover:"#filter-dates-popover",save:"[data-region=\"filter-dates\"] .filter-save",trigger:"#filter-dates-button"},exportlink:{link:"#summaryreport #forumreport_summary_table button.export-link"}}};return a.default});
//# sourceMappingURL=selectors.min.js.map
mod/forum/report/summary/amd/build/selectors.min.js.map
+1 -1
View File
@@ -1 +1 @@
{"version":3,"sources":["../src/selectors.js"],"names":["filters","group","checkbox","clear","popover","save","selectall","trigger","date","calendar","calendariconfrom","calendariconto"],"mappings":"yJAwBe,CACXA,OAAO,CAAE,CACLC,KAAK,CAAE,CACHC,QAAQ,CAAE,0DADP,CAEHC,KAAK,CAAE,+CAFJ,CAGHC,OAAO,CAAE,wBAHN,CAIHC,IAAI,CAAE,8CAJH,CAKHC,SAAS,CAAE,6CALR,CAMHC,OAAO,CAAE,uBANN,CADF,CASLC,IAAI,CAAE,CACFC,QAAQ,CAAE,8BADR,CAEFC,gBAAgB,CAAE,oCAFhB,CAGFC,cAAc,CAAE,kCAHd,CAIFP,OAAO,CAAE,uBAJP,CAKFC,IAAI,CAAE,6CALJ,CAMFE,OAAO,CAAE,sBANP,CATD,CADE,C","sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module containing the selectors for the forum summary report.\n *\n * @module forumreport_summary/selectors\n * @package forumreport_summary\n * @copyright 2019 Jun Pataleta\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nexport default {\n filters: {\n group: {\n checkbox: '[data-region=\"filter-groups\"] input[type=\"checkbox\"]',\n clear: '[data-region=\"filter-groups\"] .filter-clear',\n popover: '#filter-groups-popover',\n save: '[data-region=\"filter-groups\"] .filter-save',\n selectall: '[data-region=\"filter-groups\"] .select-all',\n trigger: '#filter-groups-button',\n },\n date: {\n calendar: '#dateselector-calendar-panel',\n calendariconfrom: '#id_filterdatefrompopover_calendar',\n calendariconto: '#id_filterdatetopopover_calendar',\n popover: '#filter-dates-popover',\n save: '[data-region=\"filter-dates\"] .filter-save',\n trigger: '#filter-dates-button',\n }\n }\n};\n"],"file":"selectors.min.js"}
{"version":3,"sources":["../src/selectors.js"],"names":["filters","group","checkbox","clear","popover","save","selectall","trigger","date","calendar","calendariconfrom","calendariconto","exportlink","link"],"mappings":"yJAwBe,CACXA,OAAO,CAAE,CACLC,KAAK,CAAE,CACHC,QAAQ,CAAE,0DADP,CAEHC,KAAK,CAAE,+CAFJ,CAGHC,OAAO,CAAE,wBAHN,CAIHC,IAAI,CAAE,8CAJH,CAKHC,SAAS,CAAE,6CALR,CAMHC,OAAO,CAAE,uBANN,CADF,CASLC,IAAI,CAAE,CACFC,QAAQ,CAAE,8BADR,CAEFC,gBAAgB,CAAE,oCAFhB,CAGFC,cAAc,CAAE,kCAHd,CAIFP,OAAO,CAAE,uBAJP,CAKFC,IAAI,CAAE,6CALJ,CAMFE,OAAO,CAAE,sBANP,CATD,CAiBLK,UAAU,CAAE,CACRC,IAAI,CAAE,8DADE,CAjBP,CADE,C","sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module containing the selectors for the forum summary report.\n *\n * @module forumreport_summary/selectors\n * @package forumreport_summary\n * @copyright 2019 Jun Pataleta\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nexport default {\n filters: {\n group: {\n checkbox: '[data-region=\"filter-groups\"] input[type=\"checkbox\"]',\n clear: '[data-region=\"filter-groups\"] .filter-clear',\n popover: '#filter-groups-popover',\n save: '[data-region=\"filter-groups\"] .filter-save',\n selectall: '[data-region=\"filter-groups\"] .select-all',\n trigger: '#filter-groups-button',\n },\n date: {\n calendar: '#dateselector-calendar-panel',\n calendariconfrom: '#id_filterdatefrompopover_calendar',\n calendariconto: '#id_filterdatetopopover_calendar',\n popover: '#filter-dates-popover',\n save: '[data-region=\"filter-dates\"] .filter-save',\n trigger: '#filter-dates-button',\n },\n exportlink: {\n link: '#summaryreport #forumreport_summary_table button.export-link'\n }\n }\n};\n"],"file":"selectors.min.js"}
mod/forum/report/summary/amd/src/filters.js
+11
View File
@@ -240,6 +240,17 @@ export const init = (root) => {
submitWithFilter('#filter-groups-popover');
});
// Listeners for export buttons.
// These allow fetching of the relevant export URL, before submitting the request with
// any POST data that is common to all of the export links. This allows filters to be
// applied that contain potentially a lot of data (eg discussion IDs for groups filtering).
document.querySelectorAll(Selectors.filters.exportlink.link).forEach(function(exportbutton) {
exportbutton.addEventListener('click', function(event) {
document.forms.exportlinkform.action = event.target.dataset.url;
document.forms.exportlinkform.submit();
});
});
// Dates filter specific handlers.
// Event handler for showing dates filter popover.
mod/forum/report/summary/amd/src/selectors.js
+3
View File
@@ -39,6 +39,9 @@ export default {
popover: '#filter-dates-popover',
save: '[data-region="filter-dates"] .filter-save',
trigger: '#filter-dates-button',
},
exportlink: {
link: '#summaryreport #forumreport_summary_table button.export-link'
}
}
};
mod/forum/report/summary/classes/output/filters.php
+31
View File
@@ -70,6 +70,17 @@ class filters implements renderable, templatable {
*/
protected $groupsselected = [];
/**
* IDs of discussions required for export links.
* If a subset of groups available are selected, this will include the discussion IDs
* within that group in the forum.
* If all groups are selected, or no groups mode is enabled, this will be empty as
* no discussion filtering is required in the export.
*
* @var array $discussionids
*/
protected $discussionids = [];
/**
* HTML for dates filter.
*
@@ -147,6 +158,23 @@ class filters implements renderable, templatable {
// Overwrite groups properties.
$this->groupsavailable = $groupsavailable;
$this->groupsselected = $groupsselected;
// If export links will require discussion filtering, find and set the discussion IDs.
$groupsselectedcount = count($groupsselected);
if ($groupsselectedcount > 0 && $groupsselectedcount < count($groupsavailable)) {
list($groupidin, $groupidparams) = $DB->get_in_or_equal($groupsselected, SQL_PARAMS_NAMED);
$dwhere = "course = :courseid AND forum = :forumid AND groupid {$groupidin}";
$dparams = [
'courseid' => $this->cm->course,
'forumid' => $this->cm->instance,
];
$dparams += $groupidparams;
$discussionids = $DB->get_fieldset_select('forum_discussions', 'DISTINCT id', $dwhere, $dparams);
foreach ($discussionids as $discussionid) {
$this->discussionids[] = ['discid' => $discussionid];
}
}
}
/**
@@ -263,6 +291,9 @@ class filters implements renderable, templatable {
$output->hasgroups = false;
}
// Set discussion IDs for use by export links (always included, as it will be empty if not required).
$output->discussionids = $this->discussionids;
// Set date button and generate dates popover mform.
$datesformdata = [];
mod/forum/report/summary/classes/summary_table.php
+34 -6
View File
@@ -94,6 +94,11 @@ class summary_table extends table_sql {
*/
protected $canseeprivatereplies;
/**
* @var array Validated filter data, for use in GET parameters by export links.
*/
protected $exportfilterdata = [];
/**
* Forum report table constructor.
*
@@ -158,7 +163,7 @@ class summary_table extends table_sql {
$columnheaders['latestpost'] = get_string('latestpost', 'forumreport_summary');
if ($canexport) {
$columnheaders['export'] = '';
$columnheaders['export'] = get_string('exportposts', 'forumreport_summary');
}
$this->define_columns(array_keys($columnheaders));
@@ -291,12 +296,33 @@ class summary_table extends table_sql {
public function col_export(\stdClass $data): string {
global $OUTPUT;
// If no posts, nothing to export.
if (empty($data->earliestpost)) {
return '';
}
$params = [
'id' => $this->cm->instance, // Forum id.
'userids[]' => $data->userid // User id.
'userids[]' => $data->userid, // User id.
];
return $OUTPUT->action_link(new \moodle_url('/mod/forum/export.php', $params), get_string('export', 'mod_forum'));
// Add relevant filter params.
foreach ($this->exportfilterdata as $name => $data) {
if (is_array($data)) {
foreach ($data as $key => $value) {
$params["{$name}[{$key}]"] = $value;
}
} else {
$params[$name] = $data;
}
}
$buttoncontext = [
'url' => new \moodle_url('/mod/forum/export.php', $params),
'label' => get_string('exportpostslabel', 'forumreport_summary', fullname($data)),
];
return $OUTPUT->render_from_template('forumreport_summary/export_link_button', $buttoncontext);
}
/**
@@ -376,18 +402,17 @@ class summary_table extends table_sql {
// Skip adding filter if not applied, or all valid options are selected.
if (!empty($groups)) {
list($groupidin, $groupidparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED);
// Posts within selected groups and/or not in any groups (group ID -1) are included.
// No user filtering as anyone enrolled can potentially post to unrestricted discussions.
if (array_search(-1, $groups) !== false) {
list($groupidin, $groupidparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED);
$this->sql->filterwhere .= " AND d.groupid {$groupidin}";
$this->sql->params += $groupidparams;
} else {
// Only posts and users within selected groups are included.
list($groupusersin, $groupusersparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED);
list($groupidin, $groupidparams) = $DB->get_in_or_equal($groups, SQL_PARAMS_NAMED);
// No joins required (handled by where to prevent data duplication).
$this->sql->filterwhere .= "
@@ -421,6 +446,7 @@ class summary_table extends table_sql {
$this->sql->params['fromdate'] = $values['from']['timestamp'];
$this->sql->filterbase['dateslog'] .= ' AND timecreated >= :fromdate';
$this->sql->filterbase['dateslogparams']['fromdate'] = $values['from']['timestamp'];
$this->exportfilterdata['timestampfrom'] = $values['from']['timestamp'];
}
// To date.
@@ -431,6 +457,7 @@ class summary_table extends table_sql {
$this->sql->params['todate'] = $values['to']['timestamp'];
$this->sql->filterbase['dateslog'] .= ' AND timecreated <= :todate';
$this->sql->filterbase['dateslogparams']['todate'] = $values['to']['timestamp'];
$this->exportfilterdata['timestampto'] = $values['to']['timestamp'];
}
}
@@ -457,6 +484,7 @@ class summary_table extends table_sql {
$this->pageable(true);
$this->is_downloadable(true);
$this->no_sorting('select');
$this->no_sorting('export');
$this->set_attribute('id', 'forumreport_summary_table');
$this->sql = new \stdClass();
$this->sql->params = [];
mod/forum/report/summary/index.php
+1 -1
View File
@@ -80,7 +80,7 @@ $PAGE->navbar->add(get_string('nodetitle', "forumreport_summary"));
// Prepare and display the report.
$allowbulkoperations = !$download && !empty($CFG->messaging) && has_capability('moodle/course:bulkmessaging', $context);
$canseeprivatereplies = has_capability('mod/forum:readprivatereplies', $context);
$canexport = has_capability('mod/forum:exportforum', $context);
$canexport = !$download && has_capability('mod/forum:exportforum', $context);
$table = new \forumreport_summary\summary_table($courseid, $filters, $allowbulkoperations,
$canseeprivatereplies, $perpage, $canexport);
mod/forum/report/summary/lang/en/forumreport_summary.php
+2
View File
@@ -37,6 +37,8 @@ $string['filter:groupsname'] = 'Groups';
$string['filter:groupscountall'] = 'Groups (all)';
$string['filter:groupscountnumber'] = 'Groups ({$a})';
$string['latestpost'] = 'Most recent post';
$string['exportposts'] = 'Export posts';
$string['exportpostslabel'] = 'Export posts for {$a}';
$string['nodetitle'] = 'Summary report';
$string['pluginname'] = 'Forum summary report';
$string['postcount'] = 'Number of discussions posted';
mod/forum/report/summary/templates/export_link_button.mustache
+31
View File
@@ -0,0 +1,31 @@
{{!
This file is part of Moodle - http://moodle.org/
Moodle 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 3 of the License, or
(at your option) any later version.
Moodle is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
}}
{{!
@template forumreport_summary/export_link_button
Summary report filters.
Example context (json):
{
"url": "wwwroot/moodle/mod/forum/export.php?userids[]=12",
"label": "Export posts for Joey Jojo"
}
}}
<button class="btn btn-primary export-link" data-url="{{{url}}}" aria-label="{{label}}" title="{{label}}">
{{# str}}export, mod_forum{{/ str}}
</button>
mod/forum/report/summary/templates/filters.mustache
+13
View File
@@ -49,6 +49,14 @@
"timestamp": "725673600",
"enabled": "1"
}
],
"discussionids": [
{
"discid": 123
},
{
"discid": 456
}
]
}
}}
@@ -62,6 +70,11 @@
{{> forumreport_summary/filter_groups}}
</div>
</form>
<form id="exportlinkform" name="exportlinkform" method="post" action="#">
{{#discussionids}}
<input type="hidden" name="discids[]" value="{{discid}}">
{{/discussionids}}
</form>
{{! Dates filter popover - mform must exist outside of the filtersform }}
{{> forumreport_summary/filter_dates_popover}}