core_enrol_renderer Class Reference

This is the core renderer. More...

Inheritance diagram for core_enrol_renderer:

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.
	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 ()
	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.
	user_enrolments_and_actions ($enrolments)
	Generates the HTML for the given enrolments + available actions.
	user_groups_and_actions ($userid, $groups, $allgroups, $canmanagegroups, $pageurl)
	Generates the HTML to view the users groups and available group actions.
	user_roles_and_actions ($userid, $roles, $assignableroles, $canassign, $pageurl)
	Generates HTML to display the users roles and any available actions.

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.
	render_course_enrolment_other_users_table (course_enrolment_other_users_table $table)
	Renders a course enrolment table.
	render_enrol_user_button (enrol_user_button $button)
	Renderers the enrol_user_button.
	render_user_enrolment_action (user_enrolment_action $icon)
	Renders a user enrolment action.

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

This is the core renderer.

Copyright

2010 Sam Hemelryk

License

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

Member Function Documentation

render_course_enrolment_other_users_table()

core_enrol_renderer::render_course_enrolment_other_users_table ( course_enrolment_other_users_table $table )

protected

Renders a course enrolment table.

Parameters

course_enrolment_table

$table

Return values

string

render_enrol_user_button()

core_enrol_renderer::render_enrol_user_button ( enrol_user_button $button )

protected

Renderers the enrol_user_button.

Parameters

enrol_user_button

$button

Return values

string

XHTML

render_user_enrolment_action()

core_enrol_renderer::render_user_enrolment_action ( user_enrolment_action $icon )

protected

Renders a user enrolment action.

Parameters

user_enrolment_action

$icon

Return values

string

user_enrolments_and_actions()

core_enrol_renderer::user_enrolments_and_actions

(

$enrolments

)

Generates the HTML for the given enrolments + available actions.

Parameters

int	$userid
array	$enrolments
moodle_url	$pageurl

Return values

string

user_groups_and_actions()

core_enrol_renderer::user_groups_and_actions	(		$userid,
			$groups,
			$allgroups,
			$canmanagegroups,
			$pageurl )

Generates the HTML to view the users groups and available group actions.

Parameters

int	$userid
array	$groups
array	$allgroups
bool	$canmanagegroups
moodle_url	$pageurl

Return values

string

user_roles_and_actions()

core_enrol_renderer::user_roles_and_actions	(		$userid,
			$roles,
			$assignableroles,
			$canassign,
			$pageurl )

Generates HTML to display the users roles and any available actions.

Parameters

int	$userid
array	$roles
array	$assignableroles
moodle_url	$pageurl

Return values

string

---

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

• enrol/renderer.php