Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
core_calendar_renderer Class Reference

The primary renderer for the calendar. More...

Inheritance diagram for core_calendar_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. More...
 
 add_action_handler (component_action $action, $id=null)
 Adds a JS action for the element with the provided id. More...
 
 add_event_button ($courseid, $unused1=null, $unused2=null, $unused3=null, $unused4=null)
 Creates a button to add a new event. More...
 
 add_pretend_calendar_block (block_contents $bc, $pos=BLOCK_POS_RIGHT)
 Adds a pretent calendar block. More...
 
 complete_layout ()
 Creates the remainder of the layout. More...
 
 course_filter_selector (moodle_url $returnurl, $label=null, $courseid=null)
 Displays a course filter selector. More...
 
 event (calendar_event $event, $showactions=true)
 Displays an event. More...
 
 event_filter ()
 Render the event filter region. More...
 
 fake_block_threemonths (calendar_information $calendar)
 Produces the content for the three months block (pretend block) More...
 
 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_from_template ($templatename, $context)
 Renders a template by name with the given context. 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...
 
 start_layout ()
 Starts the standard layout for the page. More...
 
 subscription_details ($unused=null, $subscriptions, $importresults='')
 Renders a table containing information about calendar subscriptions. 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

 get_mustache ()
 Return an instance of the mustache class. More...
 
 subscription_action_form ($subscription)
 Creates a form to perform actions on a given subscription. 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.
 

Detailed Description

The primary renderer for the calendar.

Member Function Documentation

◆ __call()

plugin_renderer_base::__call (   $method,
  $arguments 
)
inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters
string$method
array$arguments
Return values
mixed

◆ add_action_handler()

renderer_base::add_action_handler ( component_action  $action,
  $id = null 
)
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()

Parameters
component_action$action
string$id
Return values
stringid of element, either original submitted or random new if not supplied

◆ add_event_button()

core_calendar_renderer::add_event_button (   $courseid,
  $unused1 = null,
  $unused2 = null,
  $unused3 = null,
  $unused4 = null 
)

Creates a button to add a new event.

Parameters
int$courseid
int$unused1
int$unused2
int$unused3
int$unused4
Return values
string

◆ add_pretend_calendar_block()

core_calendar_renderer::add_pretend_calendar_block ( block_contents  $bc,
  $pos = BLOCK_POS_RIGHT 
)

Adds a pretent calendar block.

Parameters
block_contents$bc
mixed$posBLOCK_POS_RIGHT | BLOCK_POS_LEFT

◆ complete_layout()

core_calendar_renderer::complete_layout ( )

Creates the remainder of the layout.

Return values
string

◆ course_filter_selector()

core_calendar_renderer::course_filter_selector ( moodle_url  $returnurl,
  $label = null,
  $courseid = null 
)

Displays a course filter selector.

Parameters
moodle_url$returnurlThe URL that the user should be taken too upon selecting a course.
string$labelThe label to use for the course select.
int$courseidThe id of the course to be selected.
Return values
string

◆ event()

core_calendar_renderer::event ( calendar_event  $event,
  $showactions = true 
)

Displays an event.

Deprecated:
since 3.9
Parameters
calendar_event$event
bool$showactions
Return values
string

◆ event_filter()

core_calendar_renderer::event_filter ( )

Render the event filter region.

Return values
string

◆ fake_block_threemonths()

core_calendar_renderer::fake_block_threemonths ( calendar_information  $calendar)

Produces the content for the three months block (pretend block)

This includes the previous month, the current month, and the next month

Parameters
calendar_information$calendar
Return values
string

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url (   $maxwidth = 300,
  $maxheight = 300 
)
inherited

Return the site's compact logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url (   $maxwidth = null,
  $maxheight = 200 
)
inherited

Return the site's logo URL, if any.

Parameters
int$maxwidthThe maximum width, or null when the maximum width does not matter.
int$maxheightThe maximum height, or null when the maximum height does not matter.
Return values
moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )
protectedinherited

Return an instance of the mustache class.

Since
2.9
Return values
Mustache_Engine

◆ has_started()

renderer_base::has_started ( )
inherited

Returns true is output has already started, and false if not.

Return values
booleantrue if the header has been printed.

◆ image_url()

renderer_base::image_url (   $imagename,
  $component = 'moodle' 
)
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')

Parameters
string$imagenamethe pathname of the image
string$componentfull plugin name (aka component) or 'theme'
Return values
moodle_url

◆ pix_url()

renderer_base::pix_url (   $imagename,
  $component = 'moodle' 
)
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.

Deprecated:
since Moodle 3.3
Parameters
string$imagenamethe name of the icon.
string$componentspecification of one plugin like in get_string()
Return values
moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes (   $classes)
staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters
mixed$classesSpace-separated string or array of classes
Return values
stringHTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable  $widget)
inherited

Renders the provided widget and returns the HTML to display it.

Parameters
renderable$widgetinstance with renderable interface
Return values
string

Reimplemented from renderer_base.

Reimplemented in tool_policy\output\renderer.

◆ render_from_template()

renderer_base::render_from_template (   $templatename,
  $context 
)
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

Since
2.9
Parameters
array | stdClass$contextContext containing data for the template.
Return values
string|boolean

◆ should_display_main_logo()

renderer_base::should_display_main_logo (   $headinglevel = 1)
inherited

Whether we should display the main logo.

Parameters
int$headinglevelThe heading level we want to check against.
Return values
bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )
inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values
bool

◆ start_layout()

core_calendar_renderer::start_layout ( )

Starts the standard layout for the page.

Return values
string

◆ subscription_action_form()

core_calendar_renderer::subscription_action_form (   $subscription)
protected

Creates a form to perform actions on a given subscription.

Parameters
stdClass$subscription
Return values
string

◆ subscription_details()

core_calendar_renderer::subscription_details (   $unused = null,
  $subscriptions,
  $importresults = '' 
)

Renders a table containing information about calendar subscriptions.

Parameters
int$unused
array$subscriptions
string$importresults
Return values
string

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output
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


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