lib/classes/task/badges_message_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/>.
  16
  17 /**
  18  * A scheduled task.
  19  *
  20  * @package    core
  21  * @copyright  2019 Simey Lameze <simey@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24 namespace core\task;
  25
  26 /**
  27  * Simple task to run the badges cron.
  28  */
  29 class badges_message_task extends scheduled_task {
  30
  31     /**
  32      * Get a descriptive name for this task (shown to admins).
  33      *
  34      * @return string
  35      */
  36     public function get_name() {
  37         return get_string('taskbadgesmessagecron', 'admin');
  38     }
  39
  40     /**
  41      * Reviews criteria and awards badges
  42      *
  43      * First find all badges that can be earned, then reviews each badge.
  44      */
  45     public function execute() {
  46         global $CFG, $DB;
  47
  48         if (!empty($CFG->enablebadges)) {
  49             require_once($CFG->libdir . '/badgeslib.php');
  50             mtrace('Sending scheduled badge notifications.');
  51
  52             $scheduled = $DB->get_records_select('badge', 'notification > ? AND (status != ?) AND nextcron < ?',
  53                 array(BADGE_MESSAGE_ALWAYS, BADGE_STATUS_ARCHIVED, time()),
  54                 'notification ASC', 'id, name, notification, usercreated as creator, timecreated');
  55
  56             foreach ($scheduled as $sch) {
  57                 // Send messages.
  58                 badge_assemble_notification($sch);
  59
  60                 // Update next cron value.
  61                 $nextcron = badges_calculate_message_schedule($sch->notification);
  62                 $DB->set_field('badge', 'nextcron', $nextcron, array('id' => $sch->id));
  63             }
  64         }
  65     }
  66
  67 }