Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250620) (7d9030acd6e)
|
Public Member Functions | |
filemanager_js_templates () | |
Returns all FileManager JavaScript templates as an array. | |
filepicker_js_templates () | |
Returns all FilePicker JavaScript templates as an array. | |
files_tree_viewer (file_info $file_info, ?array $options=null) | |
render_files_tree_viewer (files_tree_viewer $tree) | |
render_form_filemanager ($fm) | |
Prints the file manager and initializes all necessary libraries. | |
repository_default_searchform () | |
Returns HTML for default repository searchform to be passed to Filepicker. | |
Protected Member Functions | |
create_license_help_icon_context () | |
Create the context for rendering help icon with license links displaying all licenses and sources. | |
fm_js_template_confirmdialog () | |
FileManager JS template for popup confirm dialogue window. | |
fm_js_template_fileselectlayout () | |
FileManager JS template for window with file information/actions. | |
fm_js_template_iconfilename () | |
FileManager JS template for displaying one file in 'icon view' mode. | |
fm_js_template_listfilename () | |
FileManager JS template for displaying file name in 'table view' and 'tree view' modes. | |
fm_js_template_message () | |
FileManager JS template for error/info message displayed as a separate popup window. | |
fm_js_template_mkdir () | |
FileManager JS template for displaying 'Make new folder' dialog. | |
fm_print_generallayout ($fm) | |
Returns html for displaying one file manager. | |
fm_print_restrictions ($fm) | |
Displays restrictions for the file manager. | |
fp_js_template_error () | |
FilePicker JS template for error (inside element with class 'fp-content'). | |
fp_js_template_generallayout () | |
Template for FilePicker with general layout (not QuickUpload). | |
fp_js_template_iconfilename () | |
FilePicker JS template for displaying one file in 'icon view' mode. | |
fp_js_template_listfilename () | |
FilePicker JS template for displaying file name in 'table view' and 'tree view' modes. | |
fp_js_template_loading () | |
FilePicker JS template to display during loading process (inside element with class 'fp-content'). | |
fp_js_template_loginform () | |
FilePicker JS template for repository login form including templates for each element type. | |
fp_js_template_message () | |
FilePicker JS template for error/info message displayed as a separate popup window. | |
fp_js_template_nextpage () | |
FilePicker JS template for displaying link/loading progress for fetching of the next page. | |
fp_js_template_processexistingfile () | |
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists. | |
fp_js_template_processexistingfilemultiple () | |
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists (multiple-file version). | |
fp_js_template_selectlayout () | |
FilePicker JS template for window appearing to select a file. | |
fp_js_template_uploadform () | |
FilePicker JS template for 'Upload file' repository. | |
File browser render.
|
protected |
Create the context for rendering help icon with license links displaying all licenses and sources.
stdClass#$iconcontext | the context for rendering license help info. |
core_files_renderer::filemanager_js_templates | ( | ) |
Returns all FileManager JavaScript templates as an array.
array |
core_files_renderer::filepicker_js_templates | ( | ) |
Returns all FilePicker JavaScript templates as an array.
array |
|
protected |
FileManager JS template for popup confirm dialogue window.
string |
|
protected |
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.
string |
|
protected |
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.
string |
|
protected |
FileManager JS template for error/info message displayed as a separate popup window.
string |
|
protected |
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;
string |
|
protected |
|
protected |
|
protected |
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
string |
|
protected |
Template for FilePicker with general layout (not QuickUpload).
string |
|
protected |
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
string |
|
protected |
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
string |
|
protected |
FilePicker JS template to display during loading process (inside element with class 'fp-content').
string |
|
protected |
FilePicker JS template for repository login form including templates for each element type.
string |
|
protected |
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
string |
|
protected |
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 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.
string |
|
protected |
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists.
string |
|
protected |
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists (multiple-file version).
string |
|
protected |
FilePicker JS template for window appearing to select a file.
string |
|
protected |
FilePicker JS template for 'Upload file' repository.
string |
core_files_renderer::render_form_filemanager | ( | $fm | ) |
Prints the file manager and initializes all necessary libraries.
$fm = new form_filemanager($options); $output = get_renderer('core', 'files'); echo $output->render($fm);
form_filemanager | $fm | File manager to render |
string | HTML fragment |
core_files_renderer::repository_default_searchform | ( | ) |
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"