Calendar information class.
More...
|
| __construct ($day=0, $month=0, $year=0, $time=0) |
| Creates a new instance.
|
|
| add_sidecalendar_blocks (core_calendar_renderer $renderer, $showfilters=false, $view=null) |
| Adds the pretend blocks for the calendar.
|
|
| checkdate ($defaultonow=true) |
| Ensures the date for the calendar is correct and either sets it to now or throws a moodle_exception if not.
|
|
| get_viewmode () |
| Getter method for the calendar's view mode.
|
|
| prepare_for_view (stdClass $course, array $coursestoload, $ignorefilters=false) |
| Initialize calendar information.
|
|
| set_sources (stdClass $course, array $courses, stdClass $category=null) |
| Set the sources for events within the calendar.
|
|
| set_time ($time=null) |
| Set the time period of this instance.
|
|
| set_viewmode (string $viewmode) |
| Setter method for the calendar's view mode.
|
|
| timestamp_today () |
| Gets todays timestamp for the calendar.
|
|
| timestamp_tomorrow () |
| Gets tomorrows timestamp for the calendar.
|
|
|
static | create ($time, int $courseid, int $categoryid=null) |
| Creates and set up a instance.
|
|
|
array | $categories = array() |
| An array of categories.
|
|
int | $categoryid = null |
| The current category.
|
|
context | $context = null |
| The anticipated context that the calendar is viewed in.
|
|
stdClass | $course |
| course data.
|
|
int | $courseid = null |
| A course id.
|
|
array | $courses = array() |
| An array of courses.
|
|
array | $groups = array() |
| An array of groups.
|
|
int | $time |
| The timestamp.
|
|
array | $users = array() |
| An array of users.
|
|
|
int | $day |
| day.
|
|
int | $month |
| month.
|
|
string | $viewmode |
| The calendar's view mode.
|
|
int | $year |
| year.
|
|
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.
- Copyright
- 2010 Sam Hemelryk
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
calendar_information::__construct |
( |
| $day = 0, |
|
|
| $month = 0, |
|
|
| $year = 0, |
|
|
| $time = 0 ) |
Creates a new instance.
- Parameters
-
int | $day | the number of the day |
int | $month | the number of the month |
int | $year | the number of the year |
int | $time | the unixtimestamp representing the date we want to view, this is used instead of $calmonth and $calyear to support multiple calendars |
◆ add_sidecalendar_blocks()
calendar_information::add_sidecalendar_blocks |
( |
core_calendar_renderer | $renderer, |
|
|
| $showfilters = false, |
|
|
| $view = null ) |
Adds the pretend blocks for the calendar.
- Parameters
-
core_calendar_renderer | $renderer | |
bool | $showfilters | display filters, false is set as default |
string | null | $view | preference view options (eg: day, month, upcoming) |
◆ checkdate()
calendar_information::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 | use current time |
- Exceptions
-
- Return values
-
bool | validation of checkdate |
◆ create()
static calendar_information::create |
( |
| $time, |
|
|
int | $courseid, |
|
|
int | $categoryid = null ) |
|
static |
Creates and set up a instance.
- Parameters
-
int | $time | the unixtimestamp representing the date we want to view. |
int | $courseid | The ID of the course the user wishes to view. |
int | $categoryid | The ID of the category the user wishes to view If a courseid is specified, this value is ignored. |
- Return values
-
◆ get_viewmode()
calendar_information::get_viewmode |
( |
| ) |
|
Getter method for the calendar's view mode.
- Return values
-
◆ prepare_for_view()
calendar_information::prepare_for_view |
( |
stdClass | $course, |
|
|
array | $coursestoload, |
|
|
| $ignorefilters = false ) |
Initialize calendar information.
- Deprecated
- 3.4
- Parameters
-
stdClass | $course | object |
array | $coursestoload | An array of courses [$course->id => $course] |
bool | $ignorefilters | options to use filter |
◆ set_sources()
calendar_information::set_sources |
( |
stdClass | $course, |
|
|
array | $courses, |
|
|
stdClass | $category = null ) |
Set the sources for events within the calendar.
If no category is provided, then the category path for the current course will be used.
- Parameters
-
stdClass | $course | The current course being viewed. |
stdClass[] | $courses | The list of all courses currently accessible. |
stdClass | $category | The current category to show. |
◆ set_time()
calendar_information::set_time |
( |
| $time = null | ) |
|
Set the time period of this instance.
- Parameters
-
int | $time | the unixtimestamp representing the date we want to view. |
- Return values
-
◆ set_viewmode()
calendar_information::set_viewmode |
( |
string | $viewmode | ) |
|
Setter method for the calendar's view mode.
- Parameters
-
◆ timestamp_today()
calendar_information::timestamp_today |
( |
| ) |
|
Gets todays timestamp for the calendar.
- Return values
-
◆ timestamp_tomorrow()
calendar_information::timestamp_tomorrow |
( |
| ) |
|
Gets tomorrows timestamp for the calendar.
- Return values
-
◆ $time
int calendar_information::$time |
The timestamp.
Rather than setting the day, month and year we will set a timestamp which will be able to be used by multiple calendars.
The documentation for this class was generated from the following file: