[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  /**
  18   * Content export definition.
  19   *
  20   * @package     mod_folder
  21   * @copyright   2020 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_folder\content;
  25  
  26  use core\content\export\exportable_items\exportable_filearea;
  27  use core\content\export\exporters\abstract_mod_exporter;
  28  
  29  /**
  30   * A class which assists a component to export content.
  31   *
  32   * @copyright   2020 Andrew Nicols <andrew@nicols.co.uk>
  33   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class exporter extends abstract_mod_exporter {
  36  
  37      /**
  38       * Get the exportable items for mod_folder.
  39       *
  40       * @param   bool $includeuserdata Whether to include user data, in addition to shared content.
  41       * @return  \core\content\export\exportable_item[]
  42       */
  43      public function get_exportables(bool $includeuserdata = false): array {
  44          $contentitems = [];
  45  
  46          $contentitems[]  = new exportable_filearea(
  47              $this->get_context(),
  48              $this->get_component(),
  49              get_string('foldercontent', 'mod_folder'),
  50  
  51              // The files held in mod_folder are stored in the 'content' filearea, under itemid 0.
  52              'content',
  53              0,
  54  
  55              // The itemid is used in the URL when accessing.
  56              0
  57          );
  58  
  59          return $contentitems;
  60      }
  61  }