core_calendar_renderer Class Reference

Inheritance diagram for core_calendar_renderer:

Collaboration diagram for core_calendar_renderer:

Public Member Functions
	basic_export_form ($allowthisweek, $allownextweek, $allownextmonth, $userid, $authtoken)
	start_layout ()
	complete_layout ()
	fake_block_filters ($courseid, $day, $month, $year, $view, $courses)
	fake_block_threemonths (calendar_information $calendar)
	add_pretend_calendar_block (block_contents $bc, $pos=BLOCK_POS_RIGHT)
	show_day (calendar_information $calendar, moodle_url $returnurl=null)
	event (calendar_event $event, $showactions=true)
	show_month_detailed (calendar_information $calendar, moodle_url $returnurl=null)
	show_upcoming_events (calendar_information $calendar, $futuredays, $maxevents, moodle_url $returnurl=null)
Protected Member Functions
	add_event_button ($courseid, $day=null, $month=null, $year=null)
	filter_selection_table (calendar_information $calendar, moodle_url $returnurl=null)
	course_filter_selector (moodle_url $returnurl, $label=null)

---

Detailed Description

The primary renderer for the calendar.

Definition at line 29 of file renderer.php.

---

Member Function Documentation

add_event_button	(	$	courseid,
		$	day = null,
		$	month = null,
		$	year = null
	)		[protected]

Creates a button to add a new event

Parameters:

int	$courseid
int	$day
int	$month
int	$year

Returns:

string

Definition at line 188 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

add_pretend_calendar_block	(	block_contents $	bc,
		$	pos = BLOCK_POS_RIGHT
	)

Adds a pretent calendar block

Parameters:

block_contents	$bc
mixed	$pos	BLOCK_POS_RIGHT | BLOCK_POS_LEFT

Definition at line 175 of file renderer.php.

Here is the caller graph for this function:

basic_export_form	(	$	allowthisweek,
		$	allownextweek,
		$	allownextmonth,
		$	userid,
		$	authtoken
	)

Creates a basic export form

Parameters:

bool	$allowthisweek
bool	$allownextweek
bool	$allownextmonth
int	$userid
string	$authtoken

Returns:

string

Definition at line 41 of file renderer.php.

Here is the call graph for this function:

complete_layout

(

)

Creates the remainder of the layout

Returns:

string

Definition at line 122 of file renderer.php.

Here is the call graph for this function:

course_filter_selector	(	moodle_url $	returnurl,
		$	label = null
	)		[protected]

Displays a course filter selector

Parameters:

array

$getvars

Returns:

string

Definition at line 675 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

event	(	calendar_event $	event,
		$	showactions = true
	)

Displays an event

Parameters:

calendar_event	$event
bool	$showactions

Returns:

string

Definition at line 275 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

fake_block_filters	(	$	courseid,
		$	day,
		$	month,
		$	year,
		$	view,
		$	courses
	)

Produces the content for the filters block (pretend block)

Parameters:

int	$courseid
int	$day
int	$month
int	$year
int	$view
int	$courses

Returns:

string

Definition at line 137 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns:

string

Definition at line 149 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

filter_selection_table	(	calendar_information $	calendar,
		moodle_url $	returnurl = null
	)		[protected]

Displays a filter selection table

Parameters:

calendar_information

$calendar

Returns:

string

Definition at line 569 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

show_day	(	calendar_information $	calendar,
		moodle_url $	returnurl = null
	)

Displays the calendar for a single day

Parameters:

calendar_information

$calendar

Returns:

string

Definition at line 216 of file renderer.php.

Here is the call graph for this function:

show_month_detailed	(	calendar_information $	calendar,
		moodle_url $	returnurl = null
	)

Displays a month in detail

Parameters:

calendar_information

$calendar

Returns:

string

Definition at line 353 of file renderer.php.

Here is the call graph for this function:

show_upcoming_events	(	calendar_information $	calendar,
		$	futuredays,
		$	maxevents,
		moodle_url $	returnurl = null
	)

Displays upcoming events

Parameters:

calendar_information	$calendar
int	$futuredays
int	$maxevents

Returns:

string

Definition at line 636 of file renderer.php.

Here is the call graph for this function:

start_layout

(

)

Starts the standard layout for the page

Returns:

string

Definition at line 113 of file renderer.php.

Here is the call graph for this function:

---

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

• C:/xampp/htdocs/moodle/calendar/renderer.php