[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   * Contains the import_strategy interface.
  18   *
  19   * @package tool_moodlenet
  20   * @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com>
  21   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  namespace tool_moodlenet\local;
  24  
  25  /**
  26   * The import_strategy interface.
  27   *
  28   * This provides a contract allowing different import strategies to be implemented.
  29   *
  30   * An import_strategy encapsulates the logic used to prepare a remote_resource for import into Moodle in some way and is used by the
  31   * import_processor (to perform aforementioned preparations) before it hands control of the import over to a course module plugin.
  32   *
  33   * We may wish to have many strategies because the preparation steps may vary depending on how the resource is to be treated.
  34   * E.g. We may wish to import as a file in which case download steps will be required, or we may simply wish to import the remote
  35   * resource as a link, in which cases setup steps will not require any file download.
  36   *
  37   * @copyright 2020 Jake Dallimore <jrhdallimore@gmail.com>
  38   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  interface import_strategy {
  41  
  42      /**
  43       * Get an array of import_handler_info objects supported by this import strategy, based on the registrydata and resource.
  44       *
  45       * Implementations should check the registry data for any entries which align with their import strategy and should create
  46       * import_handler_info objects to represent each relevant entry. If an entry represents a module, or handling type which does
  47       * not align with the strategy, that item should simply be skipped.
  48       *
  49       * E.g. If one strategy aims to import all remote resources as files (e.g. import_strategy_file), it would only generate a list
  50       * of import_handler_info objects created from those registry entries of type 'file', as those entries represent the modules
  51       * which have said they can handle resources as files.
  52       *
  53       * @param array $registrydata The fully populated handler registry.
  54       * @param remote_resource $resource the remote resource.
  55       * @return import_handler_info[] the array of import_handler_info objects, or an empty array if none were matched.
  56       */
  57      public function get_handlers(array $registrydata, remote_resource $resource): array;
  58  
  59      /**
  60       * Called during import to perform required import setup steps.
  61       *
  62       * @param remote_resource $resource the resource to import.
  63       * @param \stdClass $user the user to import on behalf of.
  64       * @param \stdClass $course the course into which the remote resource is being imported.
  65       * @param int $section the section into which the remote resource is being imported.
  66       * @return \stdClass the module data which will be passed on to the course module plugin.
  67       */
  68      public function import(remote_resource $resource, \stdClass $user, \stdClass $course, int $section): \stdClass;
  69  }