Class for displaying the month view.
More...
|
calendar_information | $calendar |
| $calendar The calendar to be rendered.
|
|
int | $calendarinstanceid = 0 |
| This calendar instance's ID.
|
|
int | $firstdayofweek |
| $firstdayofweek The first day of the week.
|
|
bool | $includenavigation = true |
| $includenavigation Whether navigation should be included on the output.
|
|
bool | $initialeventsloaded = true |
| $initialeventsloaded Whether the events have been loaded for this month.
|
|
bool | $showcoursefilter = false |
| $showcoursefilter Whether to render the course filter selector as well.
|
|
moodle_url | $url |
| $url The URL for the events page.
|
|
|
static int | $calendarinstances = 0 |
| Number of calendar instances displayed.
|
|
Class for displaying the month view.
- Copyright
- 2017 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ __construct()
Constructor for month_exporter.
- Parameters
-
◆ define_other_properties()
static core_calendar\external\month_exporter::define_other_properties |
( |
| ) |
|
|
staticprotected |
Return the list of additional properties.
- Return values
-
◆ define_related()
static core_calendar\external\month_exporter::define_related |
( |
| ) |
|
|
staticprotected |
Returns a list of objects that are related.
- Return values
-
◆ get_course_filter_selector()
core_calendar\external\month_exporter::get_course_filter_selector |
( |
renderer_base | $output | ) |
|
|
protected |
Get the course filter selector.
- Parameters
-
- Return values
-
string | The html code for the course filter selector. |
◆ get_day_names()
core_calendar\external\month_exporter::get_day_names |
( |
renderer_base | $output | ) |
|
|
protected |
Get the list of day names for display, re-ordered from the first day of the week.
- Parameters
-
- Return values
-
◆ get_days()
core_calendar\external\month_exporter::get_days |
( |
| ) |
|
|
protected |
Get the list of days with the matching date array.
- Return values
-
◆ get_default_add_context()
core_calendar\external\month_exporter::get_default_add_context |
( |
| ) |
|
|
protected |
Get the default context for use when adding a new event.
- Return values
-
◆ get_month_data()
core_calendar\external\month_exporter::get_month_data |
( |
| ) |
|
|
protected |
Get the current month timestamp.
- Return values
-
◆ get_next_month_data()
core_calendar\external\month_exporter::get_next_month_data |
( |
| ) |
|
|
protected |
Get the next month timestamp.
- Return values
-
int | The next month timestamp. |
◆ get_other_values()
core_calendar\external\month_exporter::get_other_values |
( |
renderer_base | $output | ) |
|
|
protected |
Get the additional values to inject while exporting.
- Parameters
-
- Return values
-
array | Keys are the property names, values are their values. |
◆ get_previous_month_data()
core_calendar\external\month_exporter::get_previous_month_data |
( |
| ) |
|
|
protected |
Get the previous month timestamp.
- Return values
-
int | The previous month timestamp. |
◆ get_weeks()
core_calendar\external\month_exporter::get_weeks |
( |
renderer_base | $output | ) |
|
|
protected |
Get the list of week days, ordered into weeks and padded according to the value of the first day of the week.
- Parameters
-
- Return values
-
◆ set_includenavigation()
core_calendar\external\month_exporter::set_includenavigation |
( |
| $include | ) |
|
Set whether the navigation should be shown.
- Parameters
-
- Return values
-
◆ set_initialeventsloaded()
core_calendar\external\month_exporter::set_initialeventsloaded |
( |
bool | $loaded | ) |
|
Set whether the initial events have already been loaded and provided to the exporter.
- Parameters
-
- Return values
-
◆ set_showcoursefilter()
core_calendar\external\month_exporter::set_showcoursefilter |
( |
bool | $show | ) |
|
Set whether the course filter selector should be shown.
- Parameters
-
- Return values
-
The documentation for this class was generated from the following file:
- calendar/classes/external/month_exporter.php