Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.
/calendar/ -> renderer.php (source)

[Source view]

Differences Between: [Versions 310 and 311] [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]

This file contains the renderers for the calendar within Moodle

Copyright: 2010 Sam Hemelryk
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 423 lines (17 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

core_calendar_renderer:: (10 methods):
  start_layout()
  complete_layout()
  fake_block_threemonths()
  add_pretend_calendar_block()
  add_event_button()
  event()
  course_filter_selector()
  subscription_details()
  subscription_action_form()
  event_filter()


Class: core_calendar_renderer  - X-Ref

The primary renderer for the calendar.

start_layout()   X-Ref
Starts the standard layout for the page

return: string

complete_layout()   X-Ref
Creates the remainder of the layout

return: string

fake_block_threemonths(calendar_information $calendar)   X-Ref
Produces the content for the three months block (pretend block)

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

param: calendar_information $calendar
return: string

add_pretend_calendar_block(block_contents $bc, $pos=BLOCK_POS_RIGHT)   X-Ref
Adds a pretent calendar block

param: block_contents $bc
param: mixed $pos BLOCK_POS_RIGHT | BLOCK_POS_LEFT

add_event_button($courseid, $unused1 = null, $unused2 = null, $unused3 = null, $unused4 = null)   X-Ref
Creates a button to add a new event.

param: int $courseid
param: int $unused1
param: int $unused2
param: int $unused3
param: int $unused4
return: string

event(calendar_event $event, $showactions=true)   X-Ref
Displays an event

param: calendar_event $event
param: bool $showactions
return: string

course_filter_selector(moodle_url $returnurl, $label = null, $courseid = null)   X-Ref
Displays a course filter selector

param: moodle_url $returnurl The URL that the user should be taken too upon selecting a course.
param: string $label The label to use for the course select.
param: int $courseid The id of the course to be selected.
return: string

subscription_details($unused, $subscriptions, $importresults = '')   X-Ref
Renders a table containing information about calendar subscriptions.

param: int $unused
param: array $subscriptions
param: string $importresults
return: string

subscription_action_form($subscription)   X-Ref
Creates a form to perform actions on a given subscription.

param: stdClass $subscription
return: string

event_filter()   X-Ref
Render the event filter region.

return: string