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

Provides user rendering functionality such as printing private files tree and displaying a search utility. More...

Inheritance diagram for core_user_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.
 
 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.
 
 partial_user_search (String $url, String $firstinitial, String $lastinitial, Bool $minirender=false)
 Construct a partial user search that'll require form handling implemented by the caller.
 
 participants_filter (context $context, string $tableregionid)
 Render the data required for the participants filter on the course participants page.
 
 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.
 
 unified_filter ()
 Renders the unified filter element for the course participants page.
 
 user_list ($userlist, $exclusivemode)
 Displays the list of tagged users.
 
 user_search ($url, $firstinitial, $lastinitial, $usercount, $totalcount, $heading=null)
 Prints user search utility that can search user by first initial of firstname and/or first initial of lastname Prints a header with a title and the number of users found within that subset.
 

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

 format_filter_option ($filtertype, $criteria, $value, $label)
 Returns a formatted filter option.
 
 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

Provides user rendering functionality such as printing private files tree and displaying a search utility.

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

Member Function Documentation

◆ format_filter_option()

core_user_renderer::format_filter_option ( $filtertype,
$criteria,
$value,
$label )
protected

Returns a formatted filter option.

Parameters
int$filtertypeThe filter type (e.g. status, role, group, enrolment, last access).
string$criteriaThe string label of the filter type.
int$valueThe value for the filter option.
string$labelThe string representation of the filter option's value.
Return values
arrayThe formatted option with the ['filtertype:value' => 'criteria: label'] format.

◆ partial_user_search()

core_user_renderer::partial_user_search ( String $url,
String $firstinitial,
String $lastinitial,
Bool $minirender = false )

Construct a partial user search that'll require form handling implemented by the caller.

This allows the developer to have an initials bar setup that does not automatically redirect.

Parameters
string$urlthe url to return to, complete with any parameters needed for the return
string$firstinitialthe first initial of the firstname
string$lastinitialthe first initial of the lastname
bool$minirenderReturn a trimmed down view of the initials bar.
Return values
stringhtml output
Exceptions
coding_exception

◆ participants_filter()

core_user_renderer::participants_filter ( context $context,
string $tableregionid )

Render the data required for the participants filter on the course participants page.

Parameters
context$contextThe context of the course being displayed
string$tableregionidContainer of the table to be updated by this filter, is used to retrieve the table
Return values
string

◆ unified_filter()

core_user_renderer::unified_filter ( )

Renders the unified filter element for the course participants page.

Deprecated
since 3.9
Exceptions
coding_exception

◆ user_list()

core_user_renderer::user_list ( $userlist,
$exclusivemode )

Displays the list of tagged users.

Parameters
array$userlist
bool$exclusivemodeif set to true it means that no other entities tagged with this tag are displayed on the page and the per-page limit may be bigger
Return values
string

◆ user_search()

core_user_renderer::user_search ( $url,
$firstinitial,
$lastinitial,
$usercount,
$totalcount,
$heading = null )

Prints user search utility that can search user by first initial of firstname and/or first initial of lastname Prints a header with a title and the number of users found within that subset.

Parameters
string$urlthe url to return to, complete with any parameters needed for the return
string$firstinitialthe first initial of the firstname
string$lastinitialthe first initial of the lastname
int$usercountthe amount of users meeting the search criteria
int$totalcountthe amount of users of the set/subset being searched
string$headingheading of the subset being searched, default is All Participants
Return values
stringhtml output

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