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.
   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_communication\task;
  18  
  19  use core\task\adhoc_task;
  20  use core_communication\processor;
  21  
  22  /**
  23   * Class add_members_to_room_task to add the task to add members to the room and execute the task to action the addition.
  24   *
  25   * @package    core_communication
  26   * @copyright  2023 David Woloszyn <david.woloszyn@moodle.com>
  27   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28   */
  29  class add_members_to_room_task extends adhoc_task {
  30      public function execute() {
  31          // Initialize the custom data operation to be used for the action.
  32          $data = $this->get_custom_data();
  33  
  34          // Call the communication api to action the operation.
  35          $communication = processor::load_by_id($data->id);
  36  
  37          if ($communication === null) {
  38              mtrace("Skipping room creation because the instance does not exist");
  39              return;
  40          }
  41  
  42          $communication->get_room_user_provider()->add_members_to_room($communication->get_instance_userids());
  43      }
  44  
  45      /**
  46       * Queue the task for the next run.
  47       *
  48       * @param processor $communication The communication processor to perform the action on
  49       */
  50      public static function queue(
  51          processor $communication
  52      ): void {
  53  
  54          // Add ad-hoc task to update the provider room.
  55          $task = new self();
  56          $task->set_custom_data([
  57              'id' => $communication->get_id(),
  58          ]);
  59  
  60          // Queue the task for the next run.
  61          \core\task\manager::queue_adhoc_task($task);
  62      }
  63  }