[Summary view]

   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  namespace core\task;
  18  
  19  /**
  20   * Simple task to automatically set the course visibility to hidden when the course end date matches the current day.
  21   *
  22   * @package   core
  23   * @copyright 2023 Sara Arjona <sara@moodle.com> based on code from 2016 Tim Gagen and Amanda Doughty
  24   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class hide_ended_courses_task extends show_started_courses_task {
  27  
  28      /**
  29       * Get a descriptive name for this task (shown to admins).
  30       *
  31       * @return string
  32       */
  33      public function get_name() {
  34          return get_string('hideendedcoursestask', 'course');
  35      }
  36  
  37      protected function get_field_date(): string {
  38          return 'enddate';
  39      }
  40  
  41      protected function get_visibility(): int {
  42          return 0;
  43      }
  44  
  45      protected function get_trace_message(): string {
  46          return 'Hide';
  47      }
  48  
  49      protected function get_event_classname(): string {
  50          return '\core\event\course_ended';
  51      }
  52  }