Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
/calendar/classes/external/ -> month_exporter.php (source)
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402]
Contains event class for displaying the month view.
| Copyright: | 2017 Andrew Nicols <andrew@nicols.co.uk> |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 471 lines (16 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
month_exporter:: (16 methods):
__construct()
define_properties()
define_other_properties()
get_other_values()
get_course_filter_selector()
get_day_names()
get_weeks()
get_days()
define_related()
get_month_data()
get_previous_month_data()
get_next_month_data()
set_includenavigation()
set_initialeventsloaded()
set_showcoursefilter()
get_default_add_context()
Class: month_exporter - X-Ref
Class for displaying the month view.| __construct(\calendar_information $calendar, \core_calendar\type_base $type, $related) X-Ref |
| Constructor for month_exporter. param: \calendar_information $calendar The calendar being represented param: \core_calendar\type_base $type The calendar type (e.g. Gregorian) param: array $related The related information |
| define_properties() X-Ref |
| No description |
| define_other_properties() X-Ref |
| Return the list of additional properties. return: array |
| get_other_values(renderer_base $output) X-Ref |
| Get the additional values to inject while exporting. param: renderer_base $output The renderer. return: array Keys are the property names, values are their values. |
| get_course_filter_selector(renderer_base $output) X-Ref |
| Get the course filter selector. param: renderer_base $output return: string The html code for the course filter selector. |
| get_day_names(renderer_base $output) X-Ref |
| Get the list of day names for display, re-ordered from the first day of the week. param: renderer_base $output return: day_name_exporter[] |
| get_weeks(renderer_base $output) X-Ref |
| Get the list of week days, ordered into weeks and padded according to the value of the first day of the week. param: renderer_base $output return: array The list of weeks. |
| get_days() X-Ref |
| Get the list of days with the matching date array. return: array |
| define_related() X-Ref |
| Returns a list of objects that are related. return: array |
| get_month_data() X-Ref |
| Get the current month timestamp. return: int The month timestamp. |
| get_previous_month_data() X-Ref |
| Get the previous month timestamp. return: int The previous month timestamp. |
| get_next_month_data() X-Ref |
| Get the next month timestamp. return: int The next month timestamp. |
| set_includenavigation($include) X-Ref |
| Set whether the navigation should be shown. param: bool $include return: $this |
| set_initialeventsloaded(bool $loaded) X-Ref |
| Set whether the initial events have already been loaded and provided to the exporter. param: bool $loaded return: $this |
| set_showcoursefilter(bool $show) X-Ref |
| Set whether the course filter selector should be shown. param: bool $show return: $this |
| get_default_add_context() X-Ref |
| Get the default context for use when adding a new event. return: null|\context |
