Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
File browser render. More...
Public Member Functions | |
__call ($method, $arguments) | |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief. More... | |
add_action_handler (component_action $action, $id=null) | |
Adds a JS action for the element with the provided id. More... | |
filemanager_js_templates () | |
Returns all FileManager JavaScript templates as an array. More... | |
filepicker_js_templates () | |
Returns all FilePicker JavaScript templates as an array. More... | |
files_tree_viewer (file_info $file_info, array $options=null) | |
get_compact_logo_url ($maxwidth=300, $maxheight=300) | |
Return the site's compact logo URL, if any. More... | |
get_logo_url ($maxwidth=null, $maxheight=200) | |
Return the site's logo URL, if any. More... | |
has_started () | |
Returns true is output has already started, and false if not. More... | |
image_url ($imagename, $component='moodle') | |
Return the moodle_url for an image. More... | |
pix_url ($imagename, $component='moodle') | |
Return the direct URL for an image from the pix folder. More... | |
render (renderable $widget) | |
Renders the provided widget and returns the HTML to display it. More... | |
render_files_tree_viewer (files_tree_viewer $tree) | |
render_form_filemanager ($fm) | |
Prints the file manager and initializes all necessary libraries. More... | |
render_from_template ($templatename, $context) | |
Renders a template by name with the given context. More... | |
repository_default_searchform () | |
Returns HTML for default repository searchform to be passed to Filepicker. More... | |
should_display_main_logo ($headinglevel=1) | |
Whether we should display the main logo. More... | |
should_display_navbar_logo () | |
Whether we should display the logo in the navbar. More... | |
Static Public Member Functions | |
static | prepare_classes ($classes) |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value. More... | |
Protected Member Functions | |
create_license_help_icon_context () | |
Create the context for rendering help icon with license links displaying all licenses and sources. More... | |
fm_js_template_confirmdialog () | |
FileManager JS template for popup confirm dialogue window. More... | |
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. More... | |
fm_js_template_listfilename () | |
FileManager JS template for displaying file name in 'table view' and 'tree view' modes. More... | |
fm_js_template_message () | |
FileManager JS template for error/info message displayed as a separate popup window. More... | |
fm_js_template_mkdir () | |
FileManager JS template for displaying 'Make new folder' dialog. More... | |
fm_print_generallayout ($fm) | |
Returns html for displaying one file manager. More... | |
fm_print_restrictions ($fm) | |
Displays restrictions for the file manager. More... | |
fp_js_template_error () | |
FilePicker JS template for error (inside element with class 'fp-content'). More... | |
fp_js_template_generallayout () | |
Template for FilePicker with general layout (not QuickUpload). More... | |
fp_js_template_iconfilename () | |
FilePicker JS template for displaying one file in 'icon view' mode. More... | |
fp_js_template_listfilename () | |
FilePicker JS template for displaying file name in 'table view' and 'tree view' modes. More... | |
fp_js_template_loading () | |
FilePicker JS template to display during loading process (inside element with class 'fp-content'). More... | |
fp_js_template_loginform () | |
FilePicker JS template for repository login form including templates for each element type. More... | |
fp_js_template_message () | |
FilePicker JS template for error/info message displayed as a separate popup window. More... | |
fp_js_template_nextpage () | |
FilePicker JS template for displaying link/loading progress for fetching of the next page. More... | |
fp_js_template_processexistingfile () | |
FilePicker JS template for popup dialogue window asking for action when file with the same name already exists. More... | |
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). More... | |
fp_js_template_selectlayout () | |
FilePicker JS template for window appearing to select a file. More... | |
fp_js_template_uploadform () | |
FilePicker JS template for 'Upload file' repository. More... | |
get_mustache () | |
Return an instance of the mustache class. More... | |
Protected Attributes | |
xhtml_container_stack | $opencontainers |
The xhtml_container_stack to use. | |
renderer_base core_renderer | $output |
A reference to the current renderer. More... | |
moodle_page | $page |
The Moodle page the renderer has been created to assist with. | |
string | $target |
The requested rendering target. | |
File browser render.
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
string | $method | |
array | $arguments |
mixed |
|
inherited |
Adds a JS action for the element with the provided id.
This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()
component_action | $action | |
string | $id |
string | id of element, either original submitted or random new if not supplied |
|
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 |
|
inherited |
Return the site's compact logo URL, if any.
int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
int | $maxheight | The maximum height, or null when the maximum height does not matter. |
moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
int | $maxheight | The maximum height, or null when the maximum height does not matter. |
moodle_url|false |
|
protectedinherited |
Return an instance of the mustache class.
Mustache_Engine |
|
inherited |
Returns true is output has already started, and false if not.
boolean | true if the header has been printed. |
|
inherited |
Return the moodle_url for an image.
The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.
There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')
string | $imagename | the pathname of the image |
string | $component | full plugin name (aka component) or 'theme' |
moodle_url |
|
inherited |
Return the direct URL for an image from the pix folder.
Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
string | $imagename | the name of the icon. |
string | $component | specification of one plugin like in get_string() |
moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
mixed | $classes | Space-separated string or array of classes |
string | HTML class attribute value |
|
inherited |
Renders the provided widget and returns the HTML to display it.
renderable | $widget | instance with renderable interface |
string |
Reimplemented from renderer_base.
Reimplemented in tool_policy\output\renderer.
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 |
|
inherited |
Renders a template by name with the given context.
The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string
array | stdClass | $context | Context containing data for the template. |
string|boolean |
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"
|
inherited |
Whether we should display the main logo.
int | $headinglevel | The heading level we want to check against. |
bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
bool |
|
protectedinherited |
A reference to the current renderer.
The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer