Your IP : 192.168.165.1
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* Page external API
*
* @package mod_page
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/externallib.php");
/**
* Page external functions
*
* @package mod_page
* @category external
* @copyright 2015 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.0
*/
class mod_page_external extends external_api {
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function view_page_parameters() {
return new external_function_parameters(
array(
'pageid' => new external_value(PARAM_INT, 'page instance id')
)
);
}
/**
* Simulate the page/view.php web interface page: trigger events, completion, etc...
*
* @param int $pageid the page instance id
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function view_page($pageid) {
global $DB, $CFG;
require_once($CFG->dirroot . "/mod/page/lib.php");
$params = self::validate_parameters(self::view_page_parameters(),
array(
'pageid' => $pageid
));
$warnings = array();
// Request and permission validation.
$page = $DB->get_record('page', array('id' => $params['pageid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($page, 'page');
$context = context_module::instance($cm->id);
self::validate_context($context);
require_capability('mod/page:view', $context);
// Call the page/lib API.
page_view($page, $course, $cm, $context);
$result = array();
$result['status'] = true;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function view_page_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if success'),
'warnings' => new external_warnings()
)
);
}
/**
* Describes the parameters for get_pages_by_courses.
*
* @return external_function_parameters
* @since Moodle 3.3
*/
public static function get_pages_by_courses_parameters() {
return new external_function_parameters (
array(
'courseids' => new external_multiple_structure(
new external_value(PARAM_INT, 'Course id'), 'Array of course ids', VALUE_DEFAULT, array()
),
)
);
}
/**
* Returns a list of pages in a provided list of courses.
* If no list is provided all pages that the user can view will be returned.
*
* @param array $courseids course ids
* @return array of warnings and pages
* @since Moodle 3.3
*/
public static function get_pages_by_courses($courseids = array()) {
$warnings = array();
$returnedpages = array();
$params = array(
'courseids' => $courseids,
);
$params = self::validate_parameters(self::get_pages_by_courses_parameters(), $params);
$mycourses = array();
if (empty($params['courseids'])) {
$mycourses = enrol_get_my_courses();
$params['courseids'] = array_keys($mycourses);
}
// Ensure there are courseids to loop through.
if (!empty($params['courseids'])) {
list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses);
// Get the pages in this course, this function checks users visibility permissions.
// We can avoid then additional validate_context calls.
$pages = get_all_instances_in_courses("page", $courses);
foreach ($pages as $page) {
$context = context_module::instance($page->coursemodule);
// Entry to return.
$page->name = external_format_string($page->name, $context->id);
$options = array('noclean' => true);
list($page->intro, $page->introformat) =
external_format_text($page->intro, $page->introformat, $context->id, 'mod_page', 'intro', null, $options);
$page->introfiles = external_util::get_area_files($context->id, 'mod_page', 'intro', false, false);
$options = array('noclean' => true);
list($page->content, $page->contentformat) = external_format_text($page->content, $page->contentformat,
$context->id, 'mod_page', 'content', $page->revision, $options);
$page->contentfiles = external_util::get_area_files($context->id, 'mod_page', 'content');
$returnedpages[] = $page;
}
}
$result = array(
'pages' => $returnedpages,
'warnings' => $warnings
);
return $result;
}
/**
* Describes the get_pages_by_courses return value.
*
* @return external_single_structure
* @since Moodle 3.3
*/
public static function get_pages_by_courses_returns() {
return new external_single_structure(
array(
'pages' => new external_multiple_structure(
new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'Module id'),
'coursemodule' => new external_value(PARAM_INT, 'Course module id'),
'course' => new external_value(PARAM_INT, 'Course id'),
'name' => new external_value(PARAM_RAW, 'Page name'),
'intro' => new external_value(PARAM_RAW, 'Summary'),
'introformat' => new external_format_value('intro', 'Summary format'),
'introfiles' => new external_files('Files in the introduction text'),
'content' => new external_value(PARAM_RAW, 'Page content'),
'contentformat' => new external_format_value('content', 'Content format'),
'contentfiles' => new external_files('Files in the content'),
'legacyfiles' => new external_value(PARAM_INT, 'Legacy files flag'),
'legacyfileslast' => new external_value(PARAM_INT, 'Legacy files last control flag'),
'display' => new external_value(PARAM_INT, 'How to display the page'),
'displayoptions' => new external_value(PARAM_RAW, 'Display options (width, height)'),
'revision' => new external_value(PARAM_INT, 'Incremented when after each file changes, to avoid cache'),
'timemodified' => new external_value(PARAM_INT, 'Last time the page was modified'),
'section' => new external_value(PARAM_INT, 'Course section id'),
'visible' => new external_value(PARAM_INT, 'Module visibility'),
'groupmode' => new external_value(PARAM_INT, 'Group mode'),
'groupingid' => new external_value(PARAM_INT, 'Grouping id'),
)
)
),
'warnings' => new external_warnings(),
)
);
}
}