[ Index ]

PHP Cross Reference of Unnamed Project

title

Body

[close]

/calendar/ -> renderer.php (summary)

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: 692 lines (31 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

core_calendar_renderer:: (13 methods):
  start_layout()
  complete_layout()
  fake_block_filters()
  fake_block_threemonths()
  add_pretend_calendar_block()
  add_event_button()
  show_day()
  event()
  show_month_detailed()
  show_upcoming_events()
  course_filter_selector()
  subscription_details()
  subscription_action_form()


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_filters($courseid, $day, $month, $year, $view, $courses)   X-Ref
Produces the content for the filters block (pretend block)

param: int $courseid
param: int $day
param: int $month
param: int $year
param: int $view
param: int $courses
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, $day = null, $month = null, $year = null, $time = null)   X-Ref
Creates a button to add a new event

param: int $courseid
param: int $day
param: int $month
param: int $year
param: int $time the unixtime, used for multiple calendar support. The values $day,
return: string

show_day(calendar_information $calendar, moodle_url $returnurl = null)   X-Ref
Displays the calendar for a single day

param: calendar_information $calendar
return: string

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

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

show_month_detailed(calendar_information $calendar, moodle_url $returnurl = null)   X-Ref
Displays a month in detail

param: calendar_information $calendar
param: moodle_url $returnurl the url to return to
return: string

show_upcoming_events(calendar_information $calendar, $futuredays, $maxevents, moodle_url $returnurl = null)   X-Ref
Displays upcoming events

param: calendar_information $calendar
param: int $futuredays
param: int $maxevents
return: string

course_filter_selector(moodle_url $returnurl, $label=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.
return: string

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

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

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

param: stdClass $subscription
param: int $courseid
return: string



Generated: Thu Aug 11 10:00:09 2016 Cross-referenced by PHPXref 0.7.1