MDL-48334 tool_messageinbound: cleanup @package @category
[moodle.git] / admin / tool / messageinbound / classes / task / cleanup_task.php
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/>.
17 /**
18  * A scheduled task to handle cleanup of old, unconfirmed e-mails.
19  *
20  * @package    tool_messageinbound
21  * @category   task
22  * @copyright  2014 Andrew Nicols
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 namespace tool_messageinbound\task;
28 defined('MOODLE_INTERNAL') || die();
30 /**
31  * A scheduled task to handle cleanup of old, unconfirmed e-mails.
32  *
33  * @copyright  2014 Andrew Nicols
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class cleanup_task extends \core\task\scheduled_task {
38     /**
39      * Get a descriptive name for this task (shown to admins).
40      *
41      * @return string
42      */
43     public function get_name() {
44         return get_string('taskcleanup', 'tool_messageinbound');
45     }
47     /**
48      * Execute the main Inbound Message pickup task.
49      */
50     public function execute() {
51         $manager = new \tool_messageinbound\manager();
52         return $manager->tidy_old_messages();
53     }
54 }