MDL-63352 block_timeline: Persist user preference on timeline
[moodle.git] / blocks / timeline / lib.php
CommitLineData
9e95193e
P
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Library functions for timeline
19 *
20 * @package block_timeline
21 * @copyright 2018 Peter Dias
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24defined('MOODLE_INTERNAL') || die();
25
26/**
27 * Define constants to store the SORT user preference
28 */
29define('BLOCK_TIMELINE_SORT_BY_DATES', 'sortbydates');
30define('BLOCK_TIMELINE_SORT_BY_COURSES', 'sortbycourses');
31
32/**
33 * Define constants to store the FILTER user preference
34 */
35define('BLOCK_TIMELINE_FILTER_BY_NONE', 'all');
36define('BLOCK_TIMELINE_FILTER_BY_OVERDUE', 'overdue');
37define('BLOCK_TIMELINE_FILTER_BY_7_DAYS', 'next7days');
38define('BLOCK_TIMELINE_FILTER_BY_30_DAYS', 'next30days');
39define('BLOCK_TIMELINE_FILTER_BY_3_MONTHS', 'next3months');
40define('BLOCK_TIMELINE_FILTER_BY_6_MONTHS', 'next6months');
41
42/**
43 * Returns the name of the user preferences as well as the details this plugin uses.
44 *
45 * @return array
46 */
47function block_timeline_user_preferences() {
48 $preferences['block_timeline_user_sort_preference'] = array(
49 'null' => NULL_NOT_ALLOWED,
50 'default' => BLOCK_TIMELINE_SORT_BY_DATES,
51 'type' => PARAM_ALPHA,
52 'choices' => array(BLOCK_TIMELINE_SORT_BY_DATES, BLOCK_TIMELINE_SORT_BY_COURSES)
53 );
54
55 $preferences['block_timeline_user_filter_preference'] = array(
56 'null' => NULL_NOT_ALLOWED,
57 'default' => BLOCK_TIMELINE_FILTER_BY_30_DAYS,
58 'type' => PARAM_ALPHANUM,
59 'choices' => array(
60 BLOCK_TIMELINE_FILTER_BY_NONE,
61 BLOCK_TIMELINE_FILTER_BY_OVERDUE,
62 BLOCK_TIMELINE_FILTER_BY_7_DAYS,
63 BLOCK_TIMELINE_FILTER_BY_30_DAYS,
64 BLOCK_TIMELINE_FILTER_BY_3_MONTHS,
65 BLOCK_TIMELINE_FILTER_BY_6_MONTHS
66 )
67 );
68
69 return $preferences;
70}