Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

Differences Between: [Versions 402 and 403]

   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\event;
  18  
  19  /**
  20   * MoodleNet send attempt event.
  21   *
  22   * @package    core
  23   * @copyright  2023 Michael Hawkins <michaelh@moodle.com>
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  class moodlenet_resource_exported extends \core\event\base {
  27  
  28      /**
  29       * Set basic properties for the event.
  30       *
  31       * @return void
  32       */
  33      protected function init(): void {
  34          $this->data['crud'] = 'c';
  35  
  36          // Used by teachers, but not for direct educational value to their students.
  37          $this->data['edulevel'] = self::LEVEL_OTHER;
  38      }
  39  
  40      /**
  41       * Fetch the localised general event name.
  42       *
  43       * @return string
  44       */
  45      public static function get_name(): string {
  46          return get_string('moodlenet:eventresourceexported');
  47      }
  48  
  49      /**
  50       * Fetch the non-localised event description.
  51       * This description format is designed to work for both single activity and course sharing.
  52       *
  53       * @return string
  54       */
  55      public function get_description() {
  56          $outcome = $this->other['success'] ? 'successfully shared' : 'failed to share';
  57  
  58          if (!empty($this->other['cmids'])) {
  59              $cmids = implode("', '", $this->other['cmids']);
  60              $description = "The user with id '{$this->userid}' {$outcome} activities to MoodleNet with the " .
  61                  "following course module ids, from context with id '{$this->data['contextid']}': '{$cmids}'.";
  62          } else if (!empty($this->other['courseid'])) {
  63              $courseid = implode("', '", $this->other['courseid']);
  64              $description = "The user with id '{$this->userid}' {$outcome} course to MoodleNet with the " .
  65                  "following course id, from context with id '{$this->data['contextid']}': '{$courseid}'.";
  66          }
  67  
  68          return rtrim($description, ", '");
  69      }
  70  
  71      /**
  72       * Returns relevant URL.
  73       * @return \moodle_url
  74       */
  75      public function get_url() {
  76          return new \moodle_url($this->other['resourceurl']);
  77      }
  78  }