Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * Contains renderers for the bulk activity completion stuff.
 *
 * @package core_course
 * @copyright 2017 Adrian Greeve
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die;

require_once($CFG->dirroot.'/course/renderer.php');

/**
 * Main renderer for the bulk activity completion stuff.
 *
 * @package core_course
 * @copyright 2017 Adrian Greeve
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class core_course_bulk_activity_completion_renderer extends plugin_renderer_base {

    /**
     * Render the navigation tabs for the completion page.
     *
     * @deprecated since Moodle 4.0
     * @param int|stdClass $courseorid the course object or id.
     * @param String $page the tab to focus.
     * @return string html
     */
    public function navigation($courseorid, $page) {
        debugging('navigation() has been deprecated as the tabs navigation structure in the completion page ' .
            'has been replaced with tertiary navigation. Please use render_course_completion_action_bar() instead.',
            DEBUG_DEVELOPER);

        $tabs = core_completion\manager::get_available_completion_tabs($courseorid);
        if (count($tabs) > 1) {
            return $this->tabtree($tabs, $page);
        } else {
            return '';
        }
    }

    /**
     * Render the bulk completion tab.
     *
     * @param Array|stdClass $data the context data to pass to the template.
     * @return bool|string
     */
    public function bulkcompletion($data) {
        return parent::render_from_template('core_course/bulkactivitycompletion', $data);
    }

    /**
     * Render the default completion tab.
     *
< * @param Array|stdClass $data the context data to pass to the template.
> * @param array|stdClass $data the context data to pass to the template. > * @param array $modules The modules that have been sent through the form. > * @param moodleform $form The current form that has been sent.
* @return bool|string */
< public function defaultcompletion($data) {
> public function defaultcompletion($data, $modules, $form) { > $course = get_course($data->courseid); > foreach ($data->modules as $module) { > // If the user can manage this module, then the activity completion form needs to be returned too, without the > // cancel button (so only "Save changes" button is displayed). > if ($module->canmanage) { > // Only create the form if it's different from the one that has been sent. > $modform = $form; > if (empty($form) || !in_array($module->id, array_keys($modules))) { > $modform = new \core_completion_defaultedit_form( > null, > [ > 'course' => $course, > 'modules' => [ > $module->id => $module, > ], > 'displaycancel' => false, > 'forceuniqueid' => true, > ], > ); > $module->modulecollapsed = true; > } > $module->formhtml = $modform->render(); > } > } > $data->issite = $course->id == SITEID; >
return parent::render_from_template('core_course/defaultactivitycompletion', $data); } /** * Renders the form for bulk editing activities completion * * @param moodleform $form * @param array $activities * @return string */ public function edit_bulk_completion($form, $activities) { ob_start(); $form->display(); $formhtml = ob_get_contents(); ob_end_clean(); $data = (object)[ 'form' => $formhtml, 'activities' => array_values($activities), 'activitiescount' => count($activities), ]; return parent::render_from_template('core_course/editbulkactivitycompletion', $data); } /** * Renders the form for editing default completion * * @param moodleform $form * @param array $modules * @return string
> * @deprecated since Moodle 4.3 MDL-78528 */ > * @todo MDL-78711 This will be deleted in Moodle 4.7
public function edit_default_completion($form, $modules) {
> debugging('edit_default_completion() is deprecated and will be removed.', DEBUG_DEVELOPER); ob_start(); >
$form->display(); $formhtml = ob_get_contents(); ob_end_clean(); $data = (object)[ 'form' => $formhtml, 'modules' => array_values($modules), 'modulescount' => count($modules), ]; return parent::render_from_template('core_course/editdefaultcompletion', $data); } /** * Renders the course completion action bar. * * @param \core_course\output\completion_action_bar $actionbar * @return string The HTML output */ public function render_course_completion_action_bar(\core_course\output\completion_action_bar $actionbar): string { $data = $actionbar->export_for_template($this->output); return $this->output->render_from_template('core_course/completion_action_bar', $data); } }