Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/files/ -> renderer.php (source)

Class: core_files_renderer  - X-Ref

File browser render

files_tree_viewer(file_info $file_info, array $options = null)   X-Ref
No description

render_files_tree_viewer(files_tree_viewer $tree)   X-Ref
No description

render_form_filemanager($fm)   X-Ref
Prints the file manager and initializes all necessary libraries

<pre>
$fm = new form_filemanager($options);
$output = get_renderer('core', 'files');
echo $output->render($fm);
</pre>

param: form_filemanager $fm File manager to render
return: string HTML fragment

fm_print_generallayout($fm)   X-Ref
Returns html for displaying one file manager

param: form_filemanager $fm
return: string

fm_js_template_iconfilename()   X-Ref
FileManager JS template for displaying one file in 'icon view' mode.

Except for elements described in fp_js_template_iconfilename, this template may also
contain element with class 'fp-contextmenu'. If context menu is available for this
file, the top element will receive the additional class 'fp-hascontextmenu' and
the element with class 'fp-contextmenu' will hold onclick event for displaying
the context menu.

return: string

fm_js_template_listfilename()   X-Ref
FileManager JS template for displaying file name in 'table view' and 'tree view' modes.

Except for elements described in fp_js_template_listfilename, this template may also
contain element with class 'fp-contextmenu'. If context menu is available for this
file, the top element will receive the additional class 'fp-hascontextmenu' and
the element with class 'fp-contextmenu' will hold onclick event for displaying
the context menu.

return: string

fm_js_template_mkdir()   X-Ref
FileManager JS template for displaying 'Make new folder' dialog.

Must be wrapped in an element, CSS for this element must define width and height of the window;

Must have one input element with type="text" (for users to enter the new folder name);

content of element with class 'fp-dlg-curpath' will be replaced with current path where
new folder is about to be created;
elements with classes 'fp-dlg-butcreate' and 'fp-dlg-butcancel' will hold onclick events;

return: string

fm_js_template_message()   X-Ref
FileManager JS template for error/info message displayed as a separate popup window.

return: string

fm_js_template_fileselectlayout()   X-Ref
FileManager JS template for window with file information/actions.


fm_js_template_confirmdialog()   X-Ref
FileManager JS template for popup confirm dialogue window.

return: string

filemanager_js_templates()   X-Ref
Returns all FileManager JavaScript templates as an array.

return: array

fm_print_restrictions($fm)   X-Ref
Displays restrictions for the file manager

param: form_filemanager $fm
return: string

fp_js_template_generallayout()   X-Ref
Template for FilePicker with general layout (not QuickUpload).

return: string

fp_js_template_iconfilename()   X-Ref
FilePicker JS template for displaying one file in 'icon view' mode.

the element with class 'fp-thumbnail' will be resized to the repository thumbnail size
(both width and height, unless min-width and/or min-height is set in CSS) and the content of
an element will be replaced with an appropriate img;

the width of element with class 'fp-filename' will be set to the repository thumbnail width
(unless min-width is set in css) and the content of an element will be replaced with filename
supplied by repository;

top element(s) will have class fp-folder if the element is a folder;

List of files will have parent <div> element with class 'fp-iconview'

return: string

fp_js_template_listfilename()   X-Ref
FilePicker JS template for displaying file name in 'table view' and 'tree view' modes.

content of the element with class 'fp-icon' will be replaced with an appropriate img;

content of element with class 'fp-filename' will be replaced with filename supplied by
repository;

top element(s) will have class fp-folder if the element is a folder;

Note that tree view and table view are the YUI widgets and therefore there are no
other templates. The widgets will be wrapped in <div> with class fp-treeview or
fp-tableview (respectfully).

return: string

fp_js_template_nextpage()   X-Ref
FilePicker JS template for displaying link/loading progress for fetching of the next page

This text is added to .fp-content AFTER .fp-iconview/.fp-treeview/.fp-tableview

Must have one parent element with class 'fp-nextpage'. It will be assigned additional
class 'loading' during loading of the next page (it is recommended that in this case the link
becomes unavailable). Also must contain one element <a> or <button> that will hold
onclick event for displaying of the next page. The event will be triggered automatically
when user scrolls to this link.

return: string

fp_js_template_selectlayout()   X-Ref
FilePicker JS template for window appearing to select a file.

return: string

fp_js_template_uploadform()   X-Ref
FilePicker JS template for 'Upload file' repository

return: string

fp_js_template_loading()   X-Ref
FilePicker JS template to display during loading process (inside element with class 'fp-content').

return: string

fp_js_template_error()   X-Ref
FilePicker JS template for error (inside element with class 'fp-content').

must have element with class 'fp-error', its content will be replaced with error text
and the error code will be assigned as additional class to this element
used errors: invalidjson, nofilesavailable, norepositoriesavailable

return: string

fp_js_template_message()   X-Ref
FilePicker JS template for error/info message displayed as a separate popup window.

Must be wrapped in one element, CSS for this element must define
width and height of the window. It will be assigned with an additional class 'fp-msg-error'
or 'fp-msg-info' depending on message type;

content of element with class 'fp-msg-text' will be replaced with error/info text;

element with class 'fp-msg-butok' will hold onclick event

return: string

fp_js_template_processexistingfile()   X-Ref
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists.

return: string

fp_js_template_processexistingfilemultiple()   X-Ref
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists
(multiple-file version).

return: string

fp_js_template_loginform()   X-Ref
FilePicker JS template for repository login form including templates for each element type

return: string

filepicker_js_templates()   X-Ref
Returns all FilePicker JavaScript templates as an array.

return: array

repository_default_searchform()   X-Ref
Returns HTML for default repository searchform to be passed to Filepicker

This will be used as contents for search form defined in generallayout template
(form with id {TOOLSEARCHID}).
Default contents is one text input field with name="s"

create_license_help_icon_context()   X-Ref
Create the context for rendering help icon with license links displaying all licenses and sources.

return: \stdClass $iconcontext the context for rendering license help info.

Class: files_tree_viewer  - X-Ref

Data structure representing a general moodle file tree viewer

__construct(file_info $file_info, array $options = null)   X-Ref
Constructor of moodle_file_tree_viewer class

param: file_info $file_info
param: array $options