mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 00:42:54 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-57635-38_tool_usertours_filter_shown' of https://github.com/tomdickman/moodle

Browse Source
This commit is contained in:
Sara Arjona 2019-12-04 10:48:11 +01:00
commit 03299347e7
4 changed files with 374 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

227
admin/tool/usertours/classes/local/filter/accessdate.php Normal file
View File

@ -0,0 +1,227 @@
<?php
// 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/>.
/**
* Access Date filter.
*
* @package tool_usertours
* @copyright 2019 Tom Dickman <tomdickman@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace tool_usertours\local\filter;
defined('MOODLE_INTERNAL') || die();
use context;
use tool_usertours\tour;
/**
* Access date filter. Used to determine if USER should see a tour based on a particular access date.
*
* @copyright 2019 Tom Dickman <tomdickman@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class accessdate extends base {
/**
* Access date filtering constant for setting base date as account creation date.
*/
const FILTER_ACCOUNT_CREATION = 'tool_usertours_accountcreation';
/**
* Access date filtering constant for setting base date as account first login date.
*/
const FILTER_FIRST_LOGIN = 'tool_usertours_firstlogin';
/**
* Access date filtering constant for setting base date as account last login date.
*/
const FILTER_LAST_LOGIN = 'tool_usertours_lastlogin';
/**
* Default this filter to not be enabled.
*/
const FILTER_ENABLED_DEFAULT = 0;
/**
* The name of the filter.
*
* @return string
*/
public static function get_filter_name() {
return 'accessdate';
}
/**
* Retrieve the list of available filter options.
*
* @return array An array whose keys are the valid options
* And whose values are the values to display
* @throws \coding_exception
*/
public static function get_filter_options() {
return array(
self::FILTER_ACCOUNT_CREATION => get_string('filter_date_account_creation', 'tool_usertours'),
self::FILTER_FIRST_LOGIN => get_string('filter_date_first_login', 'tool_usertours'),
self::FILTER_LAST_LOGIN => get_string('filter_date_last_login', 'tool_usertours'),
);
}
/**
* Add the form elements for the filter to the supplied form.
*
* @param \MoodleQuickForm $mform The form to add filter settings to.
*
* @throws \coding_exception
*/
public static function add_filter_to_form(\MoodleQuickForm &$mform) {
$filtername = static::get_filter_name();
$key = "filter_{$filtername}";
$range = "{$key}_range";
$enabled = "{$key}_enabled";
$mform->addElement('advcheckbox', $enabled, get_string($key, 'tool_usertours'),
get_string('filter_accessdate_enabled', 'tool_usertours'), null, array(0, 1));
$mform->addHelpButton($enabled, $enabled, 'tool_usertours');
$mform->addElement('select', $key, ' ', self::get_filter_options());
$mform->setDefault($key, self::FILTER_ACCOUNT_CREATION);
$mform->hideIf($key, $enabled, 'notchecked');
$mform->addElement('duration', $range, null, [
'optional' => false,
'defaultunit' => DAYSECS,
]);
$mform->setDefault($range, 90 * DAYSECS);
$mform->hideIf($range, $enabled, 'notchecked');
}
/**
* Prepare the filter values for the form.
*
* @param tour $tour The tour to prepare values from
* @param stdClass $data The data value
* @return stdClass
*/
public static function prepare_filter_values_for_form(tour $tour, \stdClass $data) {
$filtername = static::get_filter_name();
$key = "filter_{$filtername}";
$range = "{$key}_range";
$enabled = "{$key}_enabled";
$values = $tour->get_filter_values($filtername);
// Prepare the advanced checkbox value and prepare filter values based on previously set values.
if (!empty($values)) {
$data->$enabled = $values->$enabled ? $values->$enabled : self::FILTER_ENABLED_DEFAULT;
if ($data->$enabled) {
if (isset($values->$key)) {
$data->$key = $values->$key;
}
if (isset($values->$range)) {
$data->$range = $values->$range;
}
}
} else {
$data->$enabled = self::FILTER_ENABLED_DEFAULT;
}
return $data;
}
/**
* Save the filter values from the form to the tour.
*
* @param tour $tour The tour to save values to
* @param \stdClass $data The data submitted in the form
*/
public static function save_filter_values_from_form(tour $tour, \stdClass $data) {
$filtername = static::get_filter_name();
$key = "filter_{$filtername}";
$range = "{$key}_range";
$enabled = "{$key}_enabled";
$savedata = [];
$savedata[$key] = $data->$key;
$savedata[$range] = $data->$range;
$savedata[$enabled] = $data->$enabled;
$tour->set_filter_values($filtername, $savedata);
}
/**
* Check whether the filter matches the specified tour and/or context.
*
* @param tour $tour The tour to check
* @param context $context The context to check
* @return boolean
*/
public static function filter_matches(tour $tour, context $context) {
global $USER;
$filtername = static::get_filter_name();
$key = "filter_{$filtername}";
$range = "{$key}_range";
$enabled = "{$key}_enabled";
// Default behaviour is to match filter.
$result = true;
$values = (array) $tour->get_filter_values(self::get_filter_name());
// If the access date filter is not enabled, end here.
if (empty($values[$enabled])) {
return $result;
}
if (!empty($values[$key])) {
switch ($values[$key]) {
case (self::FILTER_ACCOUNT_CREATION):
$filterbasedate = (int) $USER->timecreated;
break;
case (self::FILTER_FIRST_LOGIN):
$filterbasedate = (int) $USER->firstaccess;
break;
case (self::FILTER_LAST_LOGIN):
$filterbasedate = (int) $USER->lastlogin;
break;
default:
// Use account creation as default.
$filterbasedate = (int) $USER->timecreated;
break;
}
// If the base date has no value because a user hasn't accessed Moodle yet, default to account creation.
if (empty($filterbasedate)) {
$filterbasedate = (int) $USER->timecreated;
}
if (!empty($values[$range])) {
$filterrange = (int) $values[$range];
} else {
$filterrange = 90 * DAYSECS;
}
// If we're outside the set range from the set base date, filter out tour.
if ((time() > ($filterbasedate + $filterrange))) {
$result = false;
}
}
return $result;
}
}

6
admin/tool/usertours/lang/en/tool_usertours.php
View File

@ -54,6 +54,9 @@ $string['event_tour_reset'] = 'Tour reset';
$string['event_tour_ended'] = 'Tour ended';
$string['event_step_shown'] = 'Step shown';
$string['exporttour'] = 'Export tour';
$string['filter_accessdate'] = 'Access date';
$string['filter_accessdate_enabled'] = 'Enable access date filter';
$string['filter_accessdate_enabled_help'] = 'Only show the tour to new users or users who have accessed the site recently.';
$string['filter_category'] = 'Category';
$string['filter_category_help'] = 'Show the tour on a page that is associated with a course in the selected category.';
$string['filter_course'] = 'Courses';
@ -62,6 +65,9 @@ $string['filter_courseformat'] = 'Course format';
$string['filter_courseformat_help'] = 'Show the tour on a page that is associated with a course using the selected course format.';
$string['filter_header'] = 'Tour filters';
$string['filter_help'] = 'Select the conditions under which the tour will be shown. All of the filters must match for a tour to be shown to a user.';
$string['filter_date_account_creation'] = 'User account creation date within';
$string['filter_date_first_login'] = 'User\'s first access date within';
$string['filter_date_last_login'] = 'User\'s last access date within';
$string['filter_theme'] = 'Theme';
$string['filter_theme_help'] = 'Show the tour when the user is using one of the selected themes.';
$string['filter_role'] = 'Role';

140
admin/tool/usertours/tests/accessdate_filter_test.php Normal file
View File

@ -0,0 +1,140 @@
<?php
// 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/>.
/**
* Tests for time filter.
*
* @package tool_usertours
* @copyright 2019 Tom Dickman <tomdickman@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
use tool_usertours\tour;
use tool_usertours\local\filter\accessdate;
/**
* Tests for time filter.
*
* @package tool_usertours
* @copyright 2019 Tom Dickman <tomdickman@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class tool_usertours_accessdate_filter_test extends advanced_testcase {
public function setUp() {
$this->resetAfterTest(true);
}
/**
* Data Provider for filter_matches method.
*
* @return array
*/
public function filter_matches_provider() {
return [
'No config set; Matches' => [
[],
[],
true,
],
'Filter is not enabled; Match' => [
['filter_accessdate' => accessdate::FILTER_ACCOUNT_CREATION, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 0],
['timecreated' => time() - (89 * DAYSECS)],
true,
],
'Filter is not enabled (tour would not be displayed if it was); Match' => [
['filter_accessdate' => accessdate::FILTER_ACCOUNT_CREATION, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 0],
['timecreated' => time() - (91 * DAYSECS)],
true,
],
'Inside range of account creation date; Match' => [
['filter_accessdate' => accessdate::FILTER_ACCOUNT_CREATION, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['timecreated' => time() - (89 * DAYSECS)],
true,
],
'Outside range of account creation date; No match' => [
['filter_accessdate' => accessdate::FILTER_ACCOUNT_CREATION, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['timecreated' => time() - (91 * DAYSECS)],
false,
],
'Inside range of first login date; Match' => [
['filter_accessdate' => accessdate::FILTER_FIRST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['firstaccess' => time() - (89 * DAYSECS)],
true,
],
'Outside range of first login date; No match' => [
['filter_accessdate' => accessdate::FILTER_FIRST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['firstaccess' => time() - (91 * DAYSECS)],
false,
],
'Inside range of last login date; Match' => [
['filter_accessdate' => accessdate::FILTER_LAST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['lastlogin' => time() - (89 * DAYSECS)],
true,
],
'Outside range of last login date; No match' => [
['filter_accessdate' => accessdate::FILTER_LAST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['lastlogin' => time() - (91 * DAYSECS)],
false,
],
'User has never logged in, but tour should be visible; Match' => [
['filter_accessdate' => accessdate::FILTER_LAST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['lastlogin' => 0, 'timecreated' => time() - (89 * DAYSECS)],
true,
],
'User has never logged in, and tour should not be visible; No match' => [
['filter_accessdate' => accessdate::FILTER_LAST_LOGIN, 'filter_accessdate_range' => 90 * DAYSECS,
'filter_accessdate_enabled' => 1],
['lastlogin' => 0, 'timecreated' => time() - (91 * DAYSECS)],
false,
],
];
}
/**
* Test filter matches.
*
* @dataProvider filter_matches_provider
*
* @param array $filtervalues the filter values set.
* @param array $userstate any user state required for test.
* @param bool $expected result expected.
*/
public function test_filter_matches($filtervalues, $userstate, $expected) {
$course = $this->getDataGenerator()->create_course();
$context = \context_course::instance($course->id);
$user = $this->getDataGenerator()->create_user($userstate);
$this->setUser($user);
$tour = new tour();
$tour->set_filter_values('accessdate', $filtervalues);
$this->assertEquals($expected, accessdate::filter_matches($tour, $context));
}
}

2
admin/tool/usertours/version.php
View File

@ -24,6 +24,6 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2019111800; // The current module version (Date: YYYYMMDDXX).
$plugin->version = 2019120400; // The current module version (Date: YYYYMMDDXX).
$plugin->requires = 2019111200; // Requires this Moodle version.
$plugin->component = 'tool_usertours'; // Full name of the plugin (used for diagnostics).