. /** * 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 = ''; $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; } if (trim($folder->intro)) { if ($folder->display != FOLDER_DISPLAY_INLINE) { $output .= $this->output->box(format_module_intro('folder', $folder, $cm->id), 'generalbox', 'intro'); } else if ($cm->showdescription) { // for "display inline" do not filter, filters run at display time. $output .= format_module_intro('folder', $folder, $cm->id, false); } } $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->box($this->render($foldertree), 'generalbox foldertree'); // Do not append the edit button on the course page. $downloadable = folder_archive_available($folder, $cm); $buttons = ''; if ($downloadable) { $downloadbutton = $this->output->single_button( new moodle_url('/mod/folder/download_folder.php', array('id' => $cm->id)), get_string('downloadfolder', 'folder') ); $buttons .= $downloadbutton; } // 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. if (has_capability('mod/folder:managefiles', $context) && ($folder->display != FOLDER_DISPLAY_INLINE || !has_capability('moodle/course:manageactivities', $context))) { $editbutton = $this->output->single_button( new moodle_url('/mod/folder/edit.php', array('id' => $cm->id)), get_string('edit') ); $buttons .= $editbutton; } if ($buttons) { $output .= $this->output->box($buttons, 'generalbox folderbuttons'); } return $output; } public function render_folder_tree(folder_tree $tree) { static $treecounter = 0; $content = ''; $id = 'folder_tree'. ($treecounter++); $content .= '
'; $content .= $this->htmllize_tree($tree, array('files' => array(), 'subdirs' => array($tree->dir))); $content .= '
'; $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; } /** * Internal function - creates htmls structure suitable for YUI tree. */ protected function htmllize_tree($tree, $dir) { global $CFG; if (empty($dir['subdirs']) and empty($dir['files'])) { return ''; } $result = ''; return $result; } } class folder_tree implements renderable { public $context; public $folder; public $cm; public $dir; public function __construct($folder, $cm) { $this->folder = $folder; $this->cm = $cm; $this->context = context_module::instance($cm->id); $fs = get_file_storage(); $this->dir = $fs->get_area_tree($this->context->id, 'mod_folder', 'content', 0); } }