calendar_information Class Reference

Public Member Functions
	__construct ($day=0, $month=0, $year=0)
	prepare_for_view (stdClass $course, array $coursestoload, $ignorefilters=false)
	checkdate ($defaultonow=true)
	timestamp_today ()
	timestamp_tomorrow ()
	add_sidecalendar_blocks (core_calendar_renderer $renderer, $showfilters=false, $view=null)
Data Fields
	$day
	$month
	$year
	$courseid = null
	$courses = array()
	$groups = array()
	$users = array()

---

Detailed Description

Calendar information class

This class is used simply to organise the information pertaining to a calendar and is used primarily to make information easily available.

Definition at line 2320 of file lib.php.

---

Constructor & Destructor Documentation

__construct	(	$	day = 0,
		$	month = 0,
		$	year = 0
	)

Creates a new instance

Parameters:

int	$day
int	$month
int	$year

Definition at line 2365 of file lib.php.

Here is the call graph for this function:

---

Member Function Documentation

add_sidecalendar_blocks	(	core_calendar_renderer $	renderer,
		$	showfilters = false,
		$	view = null
	)

Adds the pretend blocks for teh calendar

Parameters:

core_calendar_renderer	$renderer
bool	$showfilters
string | null	$view

Definition at line 2443 of file lib.php.

Here is the call graph for this function:

checkdate

(

$

defaultonow = true

)

Ensures the date for the calendar is correct and either sets it to now or throws a moodle_exception if not

Parameters:

bool

$defaultonow

Returns:

bool

Definition at line 2408 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

prepare_for_view	(	stdClass $	course,
		array $	coursestoload,
		$	ignorefilters = false
	)

Parameters:

stdClass	$course
array	$coursestoload	An array of courses [$course->id => $course]
type	$ignorefilters

Definition at line 2392 of file lib.php.

Here is the call graph for this function:

timestamp_today

(

)

Gets todays timestamp for the calendar

Returns:

int

Definition at line 2426 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

timestamp_tomorrow

(

)

Gets tomorrows timestamp for the calendar

Returns:

int

Definition at line 2433 of file lib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$courseid = null

Definition at line 2341 of file lib.php.

$courses = array()

Definition at line 2346 of file lib.php.

$day

Definition at line 2325 of file lib.php.

$groups = array()

Definition at line 2351 of file lib.php.

$month

Definition at line 2330 of file lib.php.

$users = array()

Definition at line 2356 of file lib.php.

$year

Definition at line 2335 of file lib.php.

---

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

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