MDL-50287 completion: Rename tasks to remove the word 'cron'
[moodle.git] / lib / classes / task / completion_daily_task.php
CommitLineData
309ae892
DW
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 * A scheduled task.
19 *
20 * @package core
21 * @copyright 2013 onwards Martin Dougiamas http://dougiamas.com
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24namespace core\task;
25
26/**
51e488ea
JW
27 * Simple task to run the daily completion cron.
28 * @copyright 2013 onwards Martin Dougiamas http://dougiamas.com.
29 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
309ae892 30 */
160ccd3d 31class completion_daily_task extends scheduled_task {
309ae892
DW
32
33 /**
34 * Get a descriptive name for this task (shown to admins).
35 *
36 * @return string
37 */
38 public function get_name() {
160ccd3d 39 return get_string('taskcompletiondaily', 'admin');
309ae892
DW
40 }
41
42 /**
43 * Do the job.
44 * Throw exceptions on errors (the job will be retried).
45 */
46 public function execute() {
47 global $CFG;
48
49 if ($CFG->enablecompletion) {
51e488ea 50 // Daily Completion cron.
309ae892 51 require_once($CFG->dirroot.'/completion/cron.php');
0628925b 52 completion_cron_mark_started();
309ae892
DW
53 }
54 }
55
56}