Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
gradeimport_csv_renderer Class Reference

Renderers for the import of CSV files into the gradebook. More...

Inheritance diagram for gradeimport_csv_renderer:
plugin_renderer_base renderer_base

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.
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id.
 
 errors ($errors)
 A renderer for errors generated trying to import the CSV file.
 
 get_compact_logo_url ($maxwidth=300, $maxheight=300)
 Return the site's compact logo URL, if any.
 
 get_logo_url ($maxwidth=null, $maxheight=200)
 Return the site's logo URL, if any.
 
 get_page ()
 Returns the moodle page object.
 
 has_started ()
 Returns true is output has already started, and false if not.
 
 image_url ($imagename, $component='moodle')
 Return the moodle_url for an image.
 
 import_preview_page ($header, $data)
 A renderer for the CSV file preview.
 
 pix_url ($imagename, $component='moodle')
 Return the direct URL for an image from the pix folder.
 
 render (renderable $widget)
 Renders the provided widget and returns the HTML to display it.
 
 render_from_template ($templatename, $context)
 Renders a template by name with the given context.
 
 should_display_main_logo ($headinglevel=1)
 Whether we should display the main logo.
 
 should_display_navbar_logo ()
 Whether we should display the logo in the navbar.
 
 standard_upload_file_form ($course, $mform)
 A renderer for the standard upload file form.
 

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.
 

Protected Member Functions

 get_mustache ()
 Return an instance of the mustache class.
 

Protected Attributes

xhtml_container_stack $opencontainers
 The xhtml_container_stack to use.
 
renderer_base core_renderer $output
 A reference to the current renderer.
 
moodle_page $page
 The Moodle page the renderer has been created to assist with.
 
string $target
 The requested rendering target.
 
array $templatecache = []
 $templatecache The mustache template cache.
 

Detailed Description

Renderers for the import of CSV files into the gradebook.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ errors()

gradeimport_csv_renderer::errors ( $errors)

A renderer for errors generated trying to import the CSV file.

Parameters
array$errorsDisplay import errors.
Return values
stringerrors as html to be displayed.

◆ import_preview_page()

gradeimport_csv_renderer::import_preview_page ( $header,
$data )

A renderer for the CSV file preview.

Parameters
array$headerColumn headers from the CSV file.
array$dataThe rest of the data from the CSV file.
Return values
stringhtml to be displayed.

◆ standard_upload_file_form()

gradeimport_csv_renderer::standard_upload_file_form ( $course,
$mform )

A renderer for the standard upload file form.

Parameters
object$courseThe course we are doing all of this action in.
object$mformThe mform for uploading CSV files.
Return values
stringhtml to be displayed.

The documentation for this class was generated from the following file: