 |
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
|
Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
The primary renderer for the calendar. More...
Public Member Functions | |
| __call ($method, $arguments) | |
| Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief. | |
| add_action_handler (component_action $action, $id=null) | |
| Adds a JS action for the element with the provided id. | |
| add_event_button ($courseid, $unused1=null, $unused2=null, $unused3=null, $unused4=null) | |
| Creates a button to add a new event. | |
| add_pretend_calendar_block (block_contents $bc, $pos=BLOCK_POS_RIGHT) | |
| Adds a pretent calendar block. | |
| complete_layout () | |
| Creates the remainder of the layout. | |
| course_filter_selector (moodle_url $returnurl, $label=null, $courseid=null, int $calendarinstanceid=null) | |
| Displays a course filter selector. | |
| event (calendar_event $event, $showactions=true) | |
| Displays an event. | |
| event_filter () | |
| Render the event filter region. | |
| fake_block_threemonths (calendar_information $calendar) | |
| Produces the content for the three months block (pretend block) | |
| get_compact_logo_url ($maxwidth=300, $maxheight=300) | |
| Return the site's compact logo URL, if any. | |
| get_logo_url ($maxwidth=null, $maxheight=200) | |
| Return the site's logo URL, if any. | |
| has_started () | |
| Returns true is output has already started, and false if not. | |
| image_url ($imagename, $component='moodle') | |
| Return the moodle_url for an image. | |
| pix_url ($imagename, $component='moodle') | |
| Return the direct URL for an image from the pix folder. | |
| render (renderable $widget) | |
| Renders the provided widget and returns the HTML to display it. | |
| render_from_template ($templatename, $context) | |
| Renders a template by name with the given context. | |
| render_import_result (array $result) | |
| Render the calendar import result. | |
| render_no_calendar_subscriptions () | |
| Render the subscriptions blank state appearance. | |
| render_subscriptions_header () | |
| Render the subscriptions header. | |
| should_display_main_logo ($headinglevel=1) | |
| Whether we should display the main logo. | |
| should_display_navbar_logo () | |
| Whether we should display the logo in the navbar. | |
| start_layout () | |
| Starts the standard layout for the page. | |
| subscription_details ($unused, $subscriptions, $unused2='') | |
| Renders a table containing information about calendar subscriptions. | |
Static Public Member Functions | |
| static | prepare_classes ($classes) |
| Given an array or space-separated list of classes, prepares and returns the HTML class attribute value. | |
Protected Member Functions | |
| get_mustache () | |
| Return an instance of the mustache class. | |
| render_subscription_update_interval (stdClass $subscription) | |
| Render subscription update interval form. | |
| subscription_action_links () | |
| Creates a form to perform actions on a given subscription. | |
Protected Attributes | |
| xhtml_container_stack | $opencontainers |
| The xhtml_container_stack to use. | |
| renderer_base core_renderer | $output |
| A reference to the current renderer. | |
| moodle_page | $page |
| The Moodle page the renderer has been created to assist with. | |
| string | $target |
| The requested rendering target. | |
| array | $templatecache = [] |
| $templatecache The mustache template cache. | |
The primary renderer for the calendar.
|
inherited |
Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.
| string | $method | |
| array | $arguments |
| mixed |
|
inherited |
Adds a JS action for the element with the provided id.
This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()
| component_action | $action | |
| string | $id |
| string | id of element, either original submitted or random new if not supplied |
| core_calendar_renderer::add_event_button | ( | $courseid, | |
| $unused1 = null, | |||
| $unused2 = null, | |||
| $unused3 = null, | |||
| $unused4 = null ) |
Creates a button to add a new event.
| int | $courseid | |
| int | $unused1 | |
| int | $unused2 | |
| int | $unused3 | |
| int | $unused4 |
| string |
| core_calendar_renderer::add_pretend_calendar_block | ( | block_contents | $bc, |
| $pos = BLOCK_POS_RIGHT ) |
Adds a pretent calendar block.
| block_contents | $bc | |
| mixed | $pos | BLOCK_POS_RIGHT | BLOCK_POS_LEFT |
| core_calendar_renderer::complete_layout | ( | ) |
Creates the remainder of the layout.
| string |
| core_calendar_renderer::course_filter_selector | ( | moodle_url | $returnurl, |
| $label = null, | |||
| $courseid = null, | |||
| int | $calendarinstanceid = null ) |
Displays a course filter selector.
| moodle_url | $returnurl | The URL that the user should be taken too upon selecting a course. |
| string | $label | The label to use for the course select. |
| int | $courseid | The id of the course to be selected. |
| int | null | $calendarinstanceid | The instance ID of the calendar we're generating this course filter for. |
| string |
| core_calendar_renderer::event | ( | calendar_event | $event, |
| $showactions = true ) |
Displays an event.
| calendar_event | $event | |
| bool | $showactions |
| string |
| core_calendar_renderer::event_filter | ( | ) |
Render the event filter region.
| string |
| core_calendar_renderer::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
| calendar_information | $calendar |
| string |
|
inherited |
Return the site's compact logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
inherited |
Return the site's logo URL, if any.
| int | $maxwidth | The maximum width, or null when the maximum width does not matter. |
| int | $maxheight | The maximum height, or null when the maximum height does not matter. |
| moodle_url|false |
|
protectedinherited |
|
inherited |
Returns true is output has already started, and false if not.
| boolean | true if the header has been printed. |
|
inherited |
Return the moodle_url for an image.
The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.
There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')
| string | $imagename | the pathname of the image |
| string | $component | full plugin name (aka component) or 'theme' |
| moodle_url |
|
inherited |
Return the direct URL for an image from the pix folder.
Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.
| string | $imagename | the name of the icon. |
| string | $component | specification of one plugin like in get_string() |
| moodle_url |
|
staticinherited |
Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.
| mixed | $classes | Space-separated string or array of classes |
| string | HTML class attribute value |
|
inherited |
Renders the provided widget and returns the HTML to display it.
| renderable | $widget | instance with renderable interface |
| string |
Reimplemented from renderer_base.
Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.
|
inherited |
Renders a template by name with the given context.
The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string
| array | stdClass | $context | Context containing data for the template. |
| string|boolean |
| core_calendar_renderer::render_import_result | ( | array | $result | ) |
Render the calendar import result.
| array | $result | Import result |
| string|null |
| core_calendar_renderer::render_no_calendar_subscriptions | ( | ) |
Render the subscriptions blank state appearance.
| string |
|
protected |
Render subscription update interval form.
| stdClass | $subscription |
| string |
| core_calendar_renderer::render_subscriptions_header | ( | ) |
Render the subscriptions header.
| string |
|
inherited |
Whether we should display the main logo.
| int | $headinglevel | The heading level we want to check against. |
| bool |
|
inherited |
Whether we should display the logo in the navbar.
We will when there are no main logos, and we have compact logo.
| bool |
| core_calendar_renderer::start_layout | ( | ) |
Starts the standard layout for the page.
| string |
|
protected |
Creates a form to perform actions on a given subscription.
| string |
| core_calendar_renderer::subscription_details | ( | $unused, | |
| $subscriptions, | |||
| $unused2 = '' ) |
Renders a table containing information about calendar subscriptions.
| int | $unused | |
| array | $subscriptions | |
| string | $unused2 |
| string |
|
protectedinherited |
A reference to the current renderer.
The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer
1.11.0