communication/lib.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  * Callback and library methods for core communication.
  19  *
  20  * @package    core_communication
  21  * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 /**
  26  * Serve the files from the core_communication file areas.
  27  *
  28  * @param stdClass $course the course object
  29  * @param stdClass $cm the course module object
  30  * @param context $context the context
  31  * @param string $filearea the name of the file area
  32  * @param array $args extra arguments (itemid, path)
  33  * @param bool $forcedownload whether force download
  34  * @param array $options additional options affecting the file serving
  35  */
  36 function core_communication_pluginfile(
  37     $course,
  38     $cm,
  39     $context,
  40     $filearea,
  41     $args,
  42     $forcedownload,
  43     array $options = []
  44 ): void {
  45
  46     if ($filearea !== 'avatar') {
  47         return;
  48     }
  49
  50     $itemid = array_shift($args);
  51     $filename = array_pop($args);
  52
  53     // Retrieve the file from the Files API.
  54     $fs = get_file_storage();
  55     $file = $fs->get_file($context->id, 'core_communication', $filearea, $itemid, '/', $filename);
  56     if (!$file) {
  57         return;
  58     }
  59
  60     send_file($file, $filename);
  61 }