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/>.

/**
 * Folder module renderer
 *
 * @package   mod_folder
 * @copyright 2009 Petr Skoda  {@link http://skodak.org}
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
defined('MOODLE_INTERNAL') || die();

class mod_folder_renderer extends plugin_renderer_base {

    /**
     * Returns html to display the content of mod_folder
     * (Description, folder files and optionally Edit button)
     *
     * @param stdClass $folder record from 'folder' table (please note
     *     it may not contain fields 'revision' and 'timemodified')
     * @return string
     */
    public function display_folder(stdClass $folder) {
< $output = '';
> static $treecounter = 0; >
$folderinstances = get_fast_modinfo($folder->course)->get_instances_of('folder'); if (!isset($folderinstances[$folder->id]) || !($cm = $folderinstances[$folder->id]) || !($context = context_module::instance($cm->id))) { // Some error in parameters. // Don't throw any errors in renderer, just return empty string. // Capability to view module must be checked before calling renderer.
< return $output;
> return '';
}
> $data = [];
if (trim($folder->intro)) { if ($folder->display == FOLDER_DISPLAY_INLINE && $cm->showdescription) { // for "display inline" do not filter, filters run at display time.
< $output .= format_module_intro('folder', $folder, $cm->id, false);
> $data['intro'] = format_module_intro('folder', $folder, $cm->id, false);
} }
< $buttons = '';
> $buttons = [];
// Display the "Edit" button if current user can edit folder contents. // Do not display it on the course page for the teachers because there
< // is an "Edit settings" button right next to it with the same functionality.
> // is an "Edit settings" option in the action menu with the same functionality.
$canmanagefolderfiles = has_capability('mod/folder:managefiles', $context); $canmanagecourseactivities = has_capability('moodle/course:manageactivities', $context); if ($canmanagefolderfiles && ($folder->display != FOLDER_DISPLAY_INLINE || !$canmanagecourseactivities)) { $editbutton = new single_button(new moodle_url('/mod/folder/edit.php', ['id' => $cm->id]),
< get_string('edit'), 'post', true);
> get_string('edit'), 'post', single_button::BUTTON_PRIMARY);
$editbutton->class = 'navitem';
< $buttons .= $this->render($editbutton);
> $data['edit_button'] = $editbutton->export_for_template($this->output); > $data['hasbuttons'] = true;
}
< // Do not append the edit button on the course page.
$downloadable = folder_archive_available($folder, $cm); if ($downloadable) { $downloadbutton = new single_button(new moodle_url('/mod/folder/download_folder.php', ['id' => $cm->id]), get_string('downloadfolder', 'folder'), 'get'); $downloadbutton->class = 'navitem ml-auto';
< $buttons .= $this->render($downloadbutton); < } < < if ($buttons) { < $output .= $this->output->container_start("container-fluid tertiary-navigation"); < $output .= $this->output->container_start("row"); < $output .= $buttons; < $output .= $this->output->container_end(); < $output .= $this->output->container_end();
> $data['download_button'] = $downloadbutton->export_for_template($this->output); > $data['hasbuttons'] = true;
} $foldertree = new folder_tree($folder, $cm); if ($folder->display == FOLDER_DISPLAY_INLINE) { // Display module name as the name of the root directory. $foldertree->dir['dirname'] = $cm->get_formatted_name(array('escape' => false)); }
< $output .= $this->output->container_start("box generalbox pt-0 pb-3 foldertree"); < $output .= $this->render($foldertree); < $output .= $this->output->container_end();
< return $output; < } < < public function render_folder_tree(folder_tree $tree) { < static $treecounter = 0;
> $data['id'] = 'folder_tree'. ($treecounter++); > $data['showexpanded'] = !empty($foldertree->folder->showexpanded); > $data['dir'] = $this->renderable_tree_elements($foldertree, ['files' => [], 'subdirs' => [$foldertree->dir]]);
< $content = ''; < $id = 'folder_tree'. ($treecounter++); < $content .= '<div id="'.$id.'" class="filemanager">'; < $content .= $this->htmllize_tree($tree, array('files' => array(), 'subdirs' => array($tree->dir))); < $content .= '</div>'; < $showexpanded = true; < if (empty($tree->folder->showexpanded)) { < $showexpanded = false; < } < $this->page->requires->js_init_call('M.mod_folder.init_tree', array($id, $showexpanded)); < return $content;
> return $this->render_from_template('mod_folder/folder', $data);
} /** * Internal function - creates htmls structure suitable for YUI tree.
> * */ > * @deprecated since Moodle 4.3
protected function htmllize_tree($tree, $dir) { global $CFG;
> debugging( if (empty($dir['subdirs']) and empty($dir['files'])) { > 'Method htmllize_tree() is deprecated. Please use renderable_tree_elements instead', return ''; > DEBUG_DEVELOPER } > ); $result = '<ul>'; >
foreach ($dir['subdirs'] as $subdir) {
< $image = $this->output->pix_icon(file_folder_icon(24), $subdir['dirname'], 'moodle');
> $image = $this->output->pix_icon(file_folder_icon(), $subdir['dirname'], 'moodle');
$filename = html_writer::tag('span', $image, array('class' => 'fp-icon')). html_writer::tag('span', s($subdir['dirname']), array('class' => 'fp-filename')); $filename = html_writer::tag('div', $filename, array('class' => 'fp-filename-icon')); $result .= html_writer::tag('li', $filename. $this->htmllize_tree($tree, $subdir)); } foreach ($dir['files'] as $file) { $filename = $file->get_filename(); $url = moodle_url::make_pluginfile_url($file->get_contextid(), $file->get_component(), $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $filename, false); $filenamedisplay = clean_filename($filename); if (file_extension_in_typegroup($filename, 'web_image')) { $image = $url->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified())); $image = html_writer::empty_tag('img', array('src' => $image)); } else {
< $image = $this->output->pix_icon(file_file_icon($file, 24), $filenamedisplay, 'moodle');
> $image = $this->output->pix_icon(file_file_icon($file), $filenamedisplay, 'moodle');
} $filename = html_writer::tag('span', $image, array('class' => 'fp-icon')). html_writer::tag('span', $filenamedisplay, array('class' => 'fp-filename')); $urlparams = null; if ($tree->folder->forcedownload) { $urlparams = ['forcedownload' => 1]; } $filename = html_writer::tag('span', html_writer::link($url->out(false, $urlparams), $filename), ['class' => 'fp-filename-icon'] ); $result .= html_writer::tag('li', $filename); } $result .= '</ul>'; return $result;
> } } > } > /** > * Internal function - Creates elements structure suitable for mod_folder/folder template. class folder_tree implements renderable { > * public $context; > * @param folder_tree $tree The folder tree to work with. public $folder; > * @param array $dir The subdir and files structure to convert into a tree. public $cm; > * @return array The structure to be rendered by mod_folder/folder template. public $dir; > */ > protected function renderable_tree_elements(folder_tree $tree, array $dir): array { public function __construct($folder, $cm) { > if (empty($dir['subdirs']) && empty($dir['files'])) { $this->folder = $folder; > return []; $this->cm = $cm; > } > $elements = []; $this->context = context_module::instance($cm->id); > foreach ($dir['subdirs'] as $subdir) { $fs = get_file_storage(); > $htmllize = $this->renderable_tree_elements($tree, $subdir); $this->dir = $fs->get_area_tree($this->context->id, 'mod_folder', 'content', 0); > $image = $this->output->pix_icon(file_folder_icon(), $subdir['dirname'], 'moodle'); } > $elements[] = [ } > 'name' => $subdir['dirname'], > 'icon' => $image, > 'subdirs' => $htmllize, > 'hassubdirs' => !empty($htmllize), > ]; > } > foreach ($dir['files'] as $file) { > $filename = $file->get_filename(); > $filenamedisplay = clean_filename($filename); > > $url = moodle_url::make_pluginfile_url($file->get_contextid(), $file->get_component(), > $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $filename, false); > if (file_extension_in_typegroup($filename, 'web_image')) { > $image = $url->out(false, ['preview' => 'tinyicon', 'oid' => $file->get_timemodified()]); > $image = html_writer::empty_tag('img', ['src' => $image]); > } else { > $image = $this->output->pix_icon(file_file_icon($file), $filenamedisplay, 'moodle'); > } > > if ($tree->folder->forcedownload) { > $url->param('forcedownload', 1); > } > > $elements[] = [ > 'name' => $filenamedisplay, > 'icon' => $image, > 'url' => $url, > 'subdirs' => null, > 'hassubdirs' => false, > ]; > } > > return $elements;