Directories
directory	local

Namespaces
namespace	core\output


namespace	core\output\local\dropdown

Classes
class	action_link
	Data structure describing html link with special action attached. More...

class	action_menu
	An action menu. More...

class	action_menu_filler
	An action menu filler. More...

class	action_menu_link
	An action menu action. More...

class	action_menu_link_primary
	A primary action menu action. More...

class	action_menu_link_secondary
	A secondary action menu action. More...

class	block_contents
	This class represents how a block appears on a page. More...

class	block_move_target
	This class represents a target for where a block can go when it is being moved. More...

class	component_action
	Helper class used by other components that involve an action on the page (URL or JS). More...

class	confirm_action
	Confirm action. More...

class	context_header
	Renderable for the main page header. More...

class	core\output\activity_header
	Data structure representing standard components displayed on the activity header. More...

class	core\output\icon_system
	Class allowing different systems for mapping and rendering icons. More...

class	core\output\icon_system_font
	Class allowing different systems for mapping and rendering icons. More...

class	core\output\icon_system_fontawesome
	Class allowing different systems for mapping and rendering icons. More...

class	core\output\icon_system_standard
	Standard icon rendering. More...

class	core\output\inplace_editable
	Class allowing to quick edit a title inline. More...

class	core\output\language_menu
	Class for creating the language menu. More...

class	core\output\local\dropdown\dialog
	Class to render a dropdown dialog element. More...

class	core\output\local\dropdown\status
	Class to render a dropdown dialog element. More...

class	core\output\mustache_clean_string_helper
	This class will load language strings in a template. More...

class	core\output\mustache_filesystem_loader
	Perform some custom name mapping for template file names. More...

class	core\output\mustache_pix_helper
	This class will call pix_icon with the section content. More...

class	core\output\mustache_quote_helper
	Wrap content in quotes, and escape all special JSON characters used. More...

class	core\output\mustache_shorten_text_helper
	This class will call shorten_text with the section content. More...

class	core\output\mustache_string_helper
	This class will load language strings in a template. More...

class	core\output\mustache_template_finder
	Get information about valid locations for mustache templates. More...

class	core\output\mustache_template_source_loader
	Load template source strings. More...

class	core\output\mustache_uniqid_helper
	Lazy create a uniqid per instance of the class. More...

class	core\output\mustache_user_date_helper
	Mustache helper that will convert a timestamp to a date string. More...

class	core\output\notification
	Data structure representing a notification. More...

class	core\output\select_menu
	A single-select combobox widget that is functionally similar to an HTML select element. More...

class	core\output\sticky_footer
	Class to render a sticky footer element. More...

class	core_renderer
	The standard implementation of the core_renderer interface. More...

class	core_renderer_ajax
	A renderer that generates output for ajax scripts. More...

class	core_renderer_cli
	A renderer that generates output for command-line scripts. More...

class	core_renderer_maintenance
	The maintenance renderer. More...

class	custom_menu
	Custom menu class. More...

class	custom_menu_item
	Custom menu item. More...

class	file_picker
	Data structure representing a file picker. More...

class	fragment_requirements_manager
	This requirements manager captures the appropriate html for creating a fragment to be inserted elsewhere. More...

class	help_icon
	Data structure representing a help icon. More...

class	html_table
	Holds all the information required to render a. More...

class	html_table_cell
	Component representing a table cell. More...

class	html_table_row
	Component representing a table row. More...

class	html_writer
	Simple html output class. More...

class	image_icon
	Data structure representing an activity icon. More...

class	initials_bar
	Component representing initials bar. More...

class	js_writer
	Simple javascript output class. More...

class	page_requirements_manager
	This class tracks all the things that are needed by the current page. More...

class	paging_bar
	Component representing a paging bar. More...

class	pix_emoticon
	Data structure representing an emoticon image. More...

class	pix_icon
	Data structure representing an icon. More...

class	pix_icon_font
	Data structure representing an icon font. More...

class	pix_icon_fontawesome
	Data structure representing an icon subtype. More...

class	plugin_renderer_base
	Basis for all plugin renderers. More...

class	popup_action
	Component action for a popup window. More...

class	preferences_group
	Represents a group of preferences page link. More...

class	preferences_groups
	Represents a set of preferences groups. More...

class	progress_bar
	Progress bar class. More...

interface	renderable
	Interface marking other classes as suitable for renderer_base\render() More...

class	renderer_base
	Simple base class for Moodle renderers. More...

interface	renderer_factory
	A renderer factory is just responsible for creating an appropriate renderer for any given part of Moodle. More...

class	renderer_factory_base
	This is a base class to help you implement the renderer_factory interface. More...

class	single_button
	Data structure representing a simple form with only one button. More...

class	single_select
	Simple form with just one select field that gets submitted automatically. More...

class	standard_renderer_factory
	This is the default renderer factory for Moodle. More...

class	tabobject
	Stores one tab. More...

class	tabtree
	Stores tabs list. More...

interface	templatable
	Interface marking other classes having the ability to export their data for use by templates. More...

class	theme_config
	This class represents the configuration variables of a Moodle theme. More...

class	theme_overridden_renderer_factory
	This is renderer factory allows themes to override the standard renderers using php code. More...

class	url_select
	Simple URL selection widget description. More...

class	user_picture
	Data structure representing a user picture. More...

class	xhtml_container_stack
	This class keeps track of which HTML tags are currently open. More...

class	YUI_config
	This class represents the YUI configuration. More...

Functions
	js_reset_all_caches ()
	Invalidate all server and client side JS caches.

	template_reset_all_caches ()
	Invalidate all server and client side template caches.

	theme_build_css_for_themes ($themeconfigs=[], $directions=['rtl', 'ltr'], $cache=true, $mtraceprogress=false)
	Generates and saves the CSS files for the given theme configs.

	theme_get_config_file_path ($themename)
	Get the path to a theme config.php file.

	theme_get_css_filename ($themename, $globalrevision, $themerevision, $direction)
	Get the path to the local cached CSS file.

	theme_get_next_revision ()
	Calculates and returns the next theme revision number.

	theme_get_next_sub_revision_for_theme ($themename)
	Calculates and returns the next theme revision number.

	theme_get_revision ()
	Returns current theme revision number.

	theme_get_sub_revision_for_theme ($themename)
	Returns current theme sub revision number.

	theme_reset_all_caches ()
	Invalidate all server and client side caches.

	theme_reset_static_caches ()
	Reset static caches.

	theme_set_designer_mod ($state)
	Enable or disable theme designer mode.

	theme_set_revision ($revision)
	Sets the current theme revision number.

	theme_set_sub_revision_for_theme ($themename, $revision)
	Sets the current theme revision number for a specific theme.

Variables
const	RENDERER_TARGET_AJAX 'ajax'
	Plain text rendering for Ajax scripts.

const	RENDERER_TARGET_CLI 'cli'
	Plain text rendering for CLI scripts and cron.

const	RENDERER_TARGET_GENERAL 'general'
	General rendering target, usually normal browser page.

const	RENDERER_TARGET_HTMLEMAIL 'htmlemail'
	Rich text html rendering intended for sending via email.

const	RENDERER_TARGET_MAINTENANCE 'maintenance'
	General rendering target, usually normal browser page, but with limited capacity to avoid API use.

const	RENDERER_TARGET_TEXTEMAIL 'textemail'
	Plain text rendering intended for sending via email.

Detailed Description

Function Documentation

◆ theme_build_css_for_themes()

theme_build_css_for_themes	(	$themeconfigs = [],
		$directions = ['rtl', 'ltr'],
		$cache = true,
		$mtraceprogress = false )

Generates and saves the CSS files for the given theme configs.

Parameters

theme_config[]	$themeconfigs	An array of theme_config instances.
array	$directions	Must be a subset of ['rtl', 'ltr'].
bool	$cache	Should the generated files be stored in local cache.

Return values

array The built theme content in a multi-dimensional array of name => direction => content

◆ theme_get_config_file_path()

theme_get_config_file_path ( $themename )

Get the path to a theme config.php file.

Parameters

string $themename The non-frankenstyle name of the theme to check

◆ theme_get_css_filename()

theme_get_css_filename	(	$themename,
		$globalrevision,
		$themerevision,
		$direction )

Get the path to the local cached CSS file.

Parameters

string	$themename	The non-frankenstyle theme name.
int	$globalrevision	The global theme revision.
int	$themerevision	The theme specific revision.
string	$direction	Either 'ltr' or 'rtl' (case sensitive).

◆ theme_get_next_revision()

theme_get_next_revision ( )

Calculates and returns the next theme revision number.

Return values

int

◆ theme_get_next_sub_revision_for_theme()

theme_get_next_sub_revision_for_theme ( $themename )

Calculates and returns the next theme revision number.

Parameters

string $themename The non-frankenstyle name of the theme

Return values

int

◆ theme_get_revision()

theme_get_revision ( )

Returns current theme revision number.

Return values

int

◆ theme_get_sub_revision_for_theme()

theme_get_sub_revision_for_theme ( $themename )

Returns current theme sub revision number.

This is the revision for this theme exclusively, not the global theme revision.

Parameters

string $themename The non-frankenstyle name of the theme

Return values

int

◆ theme_reset_all_caches()

theme_reset_all_caches ( )

Invalidate all server and client side caches.

This method deletes the physical directory that is used to cache the theme files used for serving. Because it deletes the main theme cache directory all themes are reset by this function.

◆ theme_reset_static_caches()

theme_reset_static_caches ( )

Reset static caches.

This method indicates that all running cron processes should exit at the next opportunity.

◆ theme_set_designer_mod()

theme_set_designer_mod ( $state )

Enable or disable theme designer mode.

Parameters

bool $state

◆ theme_set_revision()

theme_set_revision ( $revision )

Sets the current theme revision number.

Parameters

int $revision The new theme revision number

◆ theme_set_sub_revision_for_theme()

theme_set_sub_revision_for_theme	(		$themename,
			$revision )

Sets the current theme revision number for a specific theme.

This does not affect the global themerev value.

Parameters

string	$themename	The non-frankenstyle name of the theme
int	$revision	The new theme revision number

Directories

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ theme_build_css_for_themes()

◆ theme_get_config_file_path()

◆ theme_get_css_filename()

◆ theme_get_next_revision()

◆ theme_get_next_sub_revision_for_theme()

◆ theme_get_revision()

◆ theme_get_sub_revision_for_theme()

◆ theme_reset_all_caches()

◆ theme_reset_static_caches()

◆ theme_set_designer_mod()

◆ theme_set_revision()

◆ theme_set_sub_revision_for_theme()