mod/folder/renderer.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * Folder module renderer
  20  *
  21  * @package   mod_folder
  22  * @copyright 2009 Petr Skoda  {@link http://skodak.org}
  23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25 defined('MOODLE_INTERNAL') || die();
  26
  27 class mod_folder_renderer extends plugin_renderer_base {
  28
  29     /**
  30      * Returns html to display the content of mod_folder
  31      * (Description, folder files and optionally Edit button)
  32      *
  33      * @param stdClass $folder record from 'folder' table (please note
  34      *     it may not contain fields 'revision' and 'timemodified')
  35      * @return string
  36      */
  37     public function display_folder(stdClass $folder) {
  38         $output = '';
  39         $folderinstances = get_fast_modinfo($folder->course)->get_instances_of('folder');
  40         if (!isset($folderinstances[$folder->id]) ||
  41                 !($cm = $folderinstances[$folder->id]) ||
  42                 !($context = context_module::instance($cm->id))) {
  43             // Some error in parameters.
  44             // Don't throw any errors in renderer, just return empty string.
  45             // Capability to view module must be checked before calling renderer.
  46             return $output;
  47         }
  48
  49         if (trim($folder->intro)) {
  50             if ($folder->display != FOLDER_DISPLAY_INLINE) {
  51                 $output .= $this->output->box(format_module_intro('folder', $folder, $cm->id),
  52                         'generalbox', 'intro');
  53             } else if ($cm->showdescription) {
  54                 // for "display inline" do not filter, filters run at display time.
  55                 $output .= format_module_intro('folder', $folder, $cm->id, false);
  56             }
  57         }
  58
  59         $foldertree = new folder_tree($folder, $cm);
  60         if ($folder->display == FOLDER_DISPLAY_INLINE) {
  61             // Display module name as the name of the root directory.
  62             $foldertree->dir['dirname'] = $cm->get_formatted_name(array('escape' => false));
  63         }
  64         $output .= $this->output->container_start("box generalbox pt-0 pb-3 foldertree");
  65         $output .= $this->render($foldertree);
  66         $output .= $this->output->container_end();
  67
  68         // Do not append the edit button on the course page.
  69         $downloadable = folder_archive_available($folder, $cm);
  70
  71         $buttons = '';
  72         if ($downloadable) {
  73             $downloadbutton = $this->output->single_button(
  74                 new moodle_url('/mod/folder/download_folder.php', array('id' => $cm->id)),
  75                 get_string('downloadfolder', 'folder')
  76             );
  77
  78             $buttons .= $downloadbutton;
  79         }
  80
  81         // Display the "Edit" button if current user can edit folder contents.
  82         // Do not display it on the course page for the teachers because there
  83         // is an "Edit settings" button right next to it with the same functionality.
  84         if (has_capability('mod/folder:managefiles', $context) &&
  85             ($folder->display != FOLDER_DISPLAY_INLINE || !has_capability('moodle/course:manageactivities', $context))) {
  86             $editbutton = $this->output->single_button(
  87                 new moodle_url('/mod/folder/edit.php', array('id' => $cm->id)),
  88                 get_string('edit')
  89             );
  90
  91             $buttons .= $editbutton;
  92         }
  93
  94         if ($buttons) {
  95             $output .= $this->output->container_start("box generalbox pt-0 pb-3 folderbuttons");
  96             $output .= $buttons;
  97             $output .= $this->output->container_end();
  98         }
  99
 100         return $output;
 101     }
 102
 103     public function render_folder_tree(folder_tree $tree) {
 104         static $treecounter = 0;
 105
 106         $content = '';
 107         $id = 'folder_tree'. ($treecounter++);
 108         $content .= '<div id="'.$id.'" class="filemanager">';
 109         $content .= $this->htmllize_tree($tree, array('files' => array(), 'subdirs' => array($tree->dir)));
 110         $content .= '</div>';
 111         $showexpanded = true;
 112         if (empty($tree->folder->showexpanded)) {
 113             $showexpanded = false;
 114         }
 115         $this->page->requires->js_init_call('M.mod_folder.init_tree', array($id, $showexpanded));
 116         return $content;
 117     }
 118
 119     /**
 120      * Internal function - creates htmls structure suitable for YUI tree.
 121      */
 122     protected function htmllize_tree($tree, $dir) {
 123         global $CFG;
 124
 125         if (empty($dir['subdirs']) and empty($dir['files'])) {
 126             return '';
 127         }
 128         $result = '<ul>';
 129         foreach ($dir['subdirs'] as $subdir) {
 130             $image = $this->output->pix_icon(file_folder_icon(24), $subdir['dirname'], 'moodle');
 131             $filename = html_writer::tag('span', $image, array('class' => 'fp-icon')).
 132                     html_writer::tag('span', s($subdir['dirname']), array('class' => 'fp-filename'));
 133             $filename = html_writer::tag('div', $filename, array('class' => 'fp-filename-icon'));
 134             $result .= html_writer::tag('li', $filename. $this->htmllize_tree($tree, $subdir));
 135         }
 136         foreach ($dir['files'] as $file) {
 137             $filename = $file->get_filename();
 138             $url = moodle_url::make_pluginfile_url($file->get_contextid(), $file->get_component(),
 139                     $file->get_filearea(), $file->get_itemid(), $file->get_filepath(), $filename, false);
 140             $filenamedisplay = clean_filename($filename);
 141             if (file_extension_in_typegroup($filename, 'web_image')) {
 142                 $image = $url->out(false, array('preview' => 'tinyicon', 'oid' => $file->get_timemodified()));
 143                 $image = html_writer::empty_tag('img', array('src' => $image));
 144             } else {
 145                 $image = $this->output->pix_icon(file_file_icon($file, 24), $filenamedisplay, 'moodle');
 146             }
 147             $filename = html_writer::tag('span', $image, array('class' => 'fp-icon')).
 148                     html_writer::tag('span', $filenamedisplay, array('class' => 'fp-filename'));
 149             $filename = html_writer::tag('span',
 150                     html_writer::link($url->out(false, array('forcedownload' => 1)), $filename),
 151                     array('class' => 'fp-filename-icon'));
 152             $result .= html_writer::tag('li', $filename);
 153         }
 154         $result .= '</ul>';
 155
 156         return $result;
 157     }
 158 }
 159
 160 class folder_tree implements renderable {
 161     public $context;
 162     public $folder;
 163     public $cm;
 164     public $dir;
 165
 166     public function __construct($folder, $cm) {
 167         $this->folder = $folder;
 168         $this->cm     = $cm;
 169
 170         $this->context = context_module::instance($cm->id);
 171         $fs = get_file_storage();
 172         $this->dir = $fs->get_area_tree($this->context->id, 'mod_folder', 'content', 0);
 173     }
 174 }