[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 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  /**
  18   * Page external API
  19   *
  20   * @package    mod_page
  21   * @category   external
  22   * @copyright  2015 Juan Leyva <juan@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   * @since      Moodle 3.0
  25   */
  26  
  27  use core_course\external\helper_for_get_mods_by_courses;
  28  
  29  defined('MOODLE_INTERNAL') || die;
  30  
  31  require_once("$CFG->libdir/externallib.php");
  32  
  33  /**
  34   * Page external functions
  35   *
  36   * @package    mod_page
  37   * @category   external
  38   * @copyright  2015 Juan Leyva <juan@moodle.com>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   * @since      Moodle 3.0
  41   */
  42  class mod_page_external extends external_api {
  43  
  44      /**
  45       * Returns description of method parameters
  46       *
  47       * @return external_function_parameters
  48       * @since Moodle 3.0
  49       */
  50      public static function view_page_parameters() {
  51          return new external_function_parameters(
  52              array(
  53                  'pageid' => new external_value(PARAM_INT, 'page instance id')
  54              )
  55          );
  56      }
  57  
  58      /**
  59       * Simulate the page/view.php web interface page: trigger events, completion, etc...
  60       *
  61       * @param int $pageid the page instance id
  62       * @return array of warnings and status result
  63       * @since Moodle 3.0
  64       * @throws moodle_exception
  65       */
  66      public static function view_page($pageid) {
  67          global $DB, $CFG;
  68          require_once($CFG->dirroot . "/mod/page/lib.php");
  69  
  70          $params = self::validate_parameters(self::view_page_parameters(),
  71                                              array(
  72                                                  'pageid' => $pageid
  73                                              ));
  74          $warnings = array();
  75  
  76          // Request and permission validation.
  77          $page = $DB->get_record('page', array('id' => $params['pageid']), '*', MUST_EXIST);
  78          list($course, $cm) = get_course_and_cm_from_instance($page, 'page');
  79  
  80          $context = context_module::instance($cm->id);
  81          self::validate_context($context);
  82  
  83          require_capability('mod/page:view', $context);
  84  
  85          // Call the page/lib API.
  86          page_view($page, $course, $cm, $context);
  87  
  88          $result = array();
  89          $result['status'] = true;
  90          $result['warnings'] = $warnings;
  91          return $result;
  92      }
  93  
  94      /**
  95       * Returns description of method result value
  96       *
  97       * @return external_description
  98       * @since Moodle 3.0
  99       */
 100      public static function view_page_returns() {
 101          return new external_single_structure(
 102              array(
 103                  'status' => new external_value(PARAM_BOOL, 'status: true if success'),
 104                  'warnings' => new external_warnings()
 105              )
 106          );
 107      }
 108  
 109      /**
 110       * Describes the parameters for get_pages_by_courses.
 111       *
 112       * @return external_function_parameters
 113       * @since Moodle 3.3
 114       */
 115      public static function get_pages_by_courses_parameters() {
 116          return new external_function_parameters (
 117              array(
 118                  'courseids' => new external_multiple_structure(
 119                      new external_value(PARAM_INT, 'Course id'), 'Array of course ids', VALUE_DEFAULT, array()
 120                  ),
 121              )
 122          );
 123      }
 124  
 125      /**
 126       * Returns a list of pages in a provided list of courses.
 127       * If no list is provided all pages that the user can view will be returned.
 128       *
 129       * @param array $courseids course ids
 130       * @return array of warnings and pages
 131       * @since Moodle 3.3
 132       */
 133      public static function get_pages_by_courses($courseids = array()) {
 134  
 135          $warnings = array();
 136          $returnedpages = array();
 137  
 138          $params = array(
 139              'courseids' => $courseids,
 140          );
 141          $params = self::validate_parameters(self::get_pages_by_courses_parameters(), $params);
 142  
 143          $mycourses = array();
 144          if (empty($params['courseids'])) {
 145              $mycourses = enrol_get_my_courses();
 146              $params['courseids'] = array_keys($mycourses);
 147          }
 148  
 149          // Ensure there are courseids to loop through.
 150          if (!empty($params['courseids'])) {
 151  
 152              list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
 153  
 154              // Get the pages in this course, this function checks users visibility permissions.
 155              // We can avoid then additional validate_context calls.
 156              $pages = get_all_instances_in_courses("page", $courses);
 157              foreach ($pages as $page) {
 158                  helper_for_get_mods_by_courses::format_name_and_intro($page, 'mod_page');
 159  
 160                  $context = context_module::instance($page->coursemodule);
 161                  list($page->content, $page->contentformat) = external_format_text(
 162                          $page->content, $page->contentformat,
 163                          $context->id, 'mod_page', 'content', $page->revision, ['noclean' => true]);
 164                  $page->contentfiles = external_util::get_area_files($context->id, 'mod_page', 'content');
 165  
 166                  $returnedpages[] = $page;
 167              }
 168          }
 169  
 170          $result = array(
 171              'pages' => $returnedpages,
 172              'warnings' => $warnings
 173          );
 174          return $result;
 175      }
 176  
 177      /**
 178       * Describes the get_pages_by_courses return value.
 179       *
 180       * @return external_single_structure
 181       * @since Moodle 3.3
 182       */
 183      public static function get_pages_by_courses_returns() {
 184          return new external_single_structure(
 185              array(
 186                  'pages' => new external_multiple_structure(
 187                      new external_single_structure(array_merge(
 188                          helper_for_get_mods_by_courses::standard_coursemodule_elements_returns(),
 189                          [
 190                              'content' => new external_value(PARAM_RAW, 'Page content'),
 191                              'contentformat' => new external_format_value('content', VALUE_REQUIRED, 'Content format'),
 192                              'contentfiles' => new external_files('Files in the content'),
 193                              'legacyfiles' => new external_value(PARAM_INT, 'Legacy files flag'),
 194                              'legacyfileslast' => new external_value(PARAM_INT, 'Legacy files last control flag'),
 195                              'display' => new external_value(PARAM_INT, 'How to display the page'),
 196                              'displayoptions' => new external_value(PARAM_RAW, 'Display options (width, height)'),
 197                              'revision' => new external_value(PARAM_INT, 'Incremented when after each file changes, to avoid cache'),
 198                              'timemodified' => new external_value(PARAM_INT, 'Last time the page was modified'),
 199                          ]
 200                      ))
 201                  ),
 202                  'warnings' => new external_warnings(),
 203              )
 204          );
 205      }
 206  }