 |
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
|
Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
|
Pseudo course format used for the site main page. More...
Public Member Functions | |
| ajax_section_move () | |
| Custom action after section has been moved in AJAX mode. More... | |
| allow_stealth_module_visibility ($cm, $section) | |
| Returns whether this course format allows the activity to have "triple visibility state" - visible always, hidden on course page but available, hidden. More... | |
| can_delete_section ($section) | |
| Whether this format allows to delete sections. More... | |
| course_content_footer () | |
| Course-specific information to be output immediately below content on any course page. More... | |
| course_content_header () | |
| Course-specific information to be output immediately above content on any course page. More... | |
| course_footer () | |
| Course-specific information to be output on any course page (usually in the beginning of standard footer) More... | |
| course_format_options ($foreditform=false) | |
| Definitions of the additional options that site uses. More... | |
| course_header () | |
| Course-specific information to be output on any course page (usually above navigation bar) More... | |
| create_edit_form_elements (&$mform, $forsection=false) | |
| Adds format options elements to the course/section edit form. More... | |
| delete_section ($section, $forcedeleteifnotempty=false) | |
| Deletes a section. More... | |
| edit_form_validation ($data, $files, $errors) | |
| Override if you need to perform some extra validation of the format options. More... | |
| editsection_form ($action, $customdata=array()) | |
| Return an instance of moodleform to edit a specified section. More... | |
| extend_course_navigation ($navigation, navigation_node $node) | |
| Loads all of the course sections into the navigation. More... | |
| get_config_for_external () | |
| Return the plugin config settings for external functions, in some cases the configs will need formatting or be returned only if the current user has some capabilities enabled. More... | |
| get_course () | |
| Returns a record from course database table plus additional fields that course format defines. More... | |
| get_courseid () | |
| Returns id of the course (0 if course is not specified) More... | |
| get_default_blocks () | |
| Returns the list of blocks to be automatically added on the site frontpage when moodle is installed. More... | |
| get_default_course_enddate ($mform, $fieldnames=array()) | |
| Returns the default end date value based on the start date. More... | |
| get_default_section_name ($section) | |
| Returns the default section using format_base's implementation of get_section_name. More... | |
| get_format () | |
| Returns the format name used by this course. More... | |
| get_format_name () | |
| Returns the localised name of this course format plugin. More... | |
| get_format_options ($section=null) | |
| Returns the format options stored for this course or course section. More... | |
| get_last_section_number () | |
| Method used in the rendered and during backup instead of legacy 'numsections'. More... | |
| get_max_sections () | |
| Method used to get the maximum number of sections for this course format. More... | |
| get_renderer (moodle_page $page) | |
| Returns instance of page renderer used by this plugin. More... | |
| get_section ($section, $strictness=IGNORE_MISSING) | |
| Returns information about section used in course. More... | |
| get_section_name ($section) | |
| Returns the display name of the given section that the course prefers. More... | |
| get_sections () | |
| Returns a list of sections used in the course. More... | |
| get_view_url ($section, $options=array()) | |
| For this fake course referring to the whole site, the site homepage is always returned regardless of arguments. More... | |
| has_view_page () | |
| Returns true if the course has a front page. More... | |
| inplace_editable_render_section_name ($section, $linkifneeded=true, $editable=null, $edithint=null, $editlabel=null) | |
| Prepares the templateable object to display section name. More... | |
| inplace_editable_update_section_name ($section, $itemtype, $newvalue) | |
| Updates the value in the database and modifies this object respectively. More... | |
| is_section_current ($section) | |
| Returns true if the specified section is current. More... | |
| page_set_cm (moodle_page $page) | |
| Allows course format to execute code on moodle_page::set_cm() More... | |
| page_set_course (moodle_page $page) | |
| Allows course format to execute code on moodle_page::set_course() More... | |
| section_action ($section, $action, $sr) | |
| Callback used in WS core_course_edit_section when teacher performs an AJAX action on a section (show/hide) More... | |
| section_format_options ($foreditform=false) | |
| Definitions of the additional options that this course format uses for section. More... | |
| section_get_available_hook (section_info $section, &$available, &$availableinfo) | |
| Allows to specify for modinfo that section is not available even when it is visible and conditionally available. More... | |
| supports_ajax () | |
| Returns the information about the ajax support in the given source format. More... | |
| supports_news () | |
| Indicates whether the course format supports the creation of the Announcements forum. More... | |
| update_course_format_options ($data, $oldcourse=null) | |
| Updates format options for a course. More... | |
| update_section_format_options ($data) | |
| Updates format options for a section. More... | |
| uses_sections () | |
| Returns true if this course format uses sections. More... | |
| validate_course_format_options (array $data) | |
| Validates format options for the course. More... | |
Static Public Member Functions | |
| static | instance ($courseorid) |
| Returns an instance of the class. More... | |
| static | reset_course_cache ($courseid=0) |
| Resets cache for the course (or all caches) To be called from rebuild_course_cache(). More... | |
Protected Member Functions | |
| get_form_start_date ($mform, $fieldnames) | |
| Get the start date value from the course settings page form. More... | |
| update_format_options ($data, $sectionid=null) | |
| Updates format options for a course or section. More... | |
| validate_format_options (array $rawdata, int $sectionid=null) | |
| Prepares values of course or section format options before storing them in DB. More... | |
Static Protected Member Functions | |
| static | get_class_name ($format) |
| Get class name for the format. More... | |
| static | get_format_or_default ($format) |
| Validates that course format exists and enabled and returns either itself or default format. More... | |
Protected Attributes | |
| stdClass | $course = false |
| data for course object, please use format_base::get_course() | |
| int | $courseid |
| Id of the course in this instance (maybe 0) | |
| string | $format |
| format used for this course. More... | |
| array | $formatoptions = array() |
| caches format options, please use format_base::get_format_options() | |
Pseudo course format used for the site main page.
|
inherited |
Custom action after section has been moved in AJAX mode.
Used in course/rest.php
| array | This will be passed in ajax respose |
Reimplemented in format_legacy, format_topics, and format_weeks.
| format_site::allow_stealth_module_visibility | ( | $cm, | |
| $section | |||
| ) |
Returns whether this course format allows the activity to have "triple visibility state" - visible always, hidden on course page but available, hidden.
| stdClass | cm_info | $cm | course module (may be null if we are displaying a form for adding a module) |
| stdClass | section_info | $section | section where this module is located or will be added to |
| bool |
Reimplemented from format_base.
|
inherited |
Whether this format allows to delete sections.
If format supports deleting sections it is also recommended to define language string 'deletesection' inside the format.
Do not call this function directly, instead use course_can_delete_section()
| int | stdClass | section_info | $section |
| bool |
Reimplemented in format_topics, and format_weeks.
|
inherited |
Course-specific information to be output immediately below content on any course page.
See format_base::course_header() for usage
| null|renderable | null for no output or object with data for plugin renderer |
|
inherited |
Course-specific information to be output immediately above content on any course page.
See format_base::course_header() for usage
| null|renderable | null for no output or object with data for plugin renderer |
|
inherited |
Course-specific information to be output on any course page (usually in the beginning of standard footer)
See format_base::course_header() for usage
| null|renderable | null for no output or object with data for plugin renderer |
| format_site::course_format_options | ( | $foreditform = false | ) |
Definitions of the additional options that site uses.
| bool | $foreditform |
| array | of options |
Reimplemented from format_base.
|
inherited |
Course-specific information to be output on any course page (usually above navigation bar)
Example of usage: define class format_FORMATNAME_XXX implements renderable {}
create format renderer in course/format/FORMATNAME/renderer.php, define rendering function: class format_FORMATNAME_renderer extends plugin_renderer_base { protected function render_format_FORMATNAME_XXX(format_FORMATNAME_XXX $xxx) { return html_writer::tag('div', 'This is my header/footer'); } }
Return instance of format_FORMATNAME_XXX in this function, the appropriate method from plugin renderer will be called
| null|renderable | null for no output or object with data for plugin renderer |
|
inherited |
Adds format options elements to the course/section edit form.
This function is called from course_edit_form::definition_after_data()
| MoodleQuickForm | $mform | form the elements are added to |
| bool | $forsection | 'true' if this is a section edit form, 'false' if this is course edit form |
| array | array of references to the added form elements |
Reimplemented in format_singleactivity, format_topics, and format_weeks.
|
inherited |
Deletes a section.
Do not call this function directly, instead call course_delete_section()
| int | stdClass | section_info | $section | |
| bool | $forcedeleteifnotempty | if set to false section will not be deleted if it has modules in it. |
| bool | whether section was deleted |
|
inherited |
Override if you need to perform some extra validation of the format options.
| array | $data | array of ("fieldname"=>value) of submitted data |
| array | $files | array of uploaded files "element_name"=>tmp_file_path |
| array | $errors | errors already discovered in edit form validation |
| array | of "element_name"=>"error_description" if there are errors, or an empty array if everything is OK. Do not repeat errors from $errors param here |
|
inherited |
Return an instance of moodleform to edit a specified section.
Default implementation returns instance of editsection_form that automatically adds additional fields defined in format_base::section_format_options()
Format plugins may extend editsection_form if they want to have custom edit section form.
| mixed | $action | the action attribute for the form. If empty defaults to auto detect the current url. If a moodle_url object then outputs params as hidden variables. |
| array | $customdata | the array with custom data to be passed to the form /course/editsection.php passes section_info object in 'cs' field for filling availability fields |
| moodleform |
|
inherited |
Loads all of the course sections into the navigation.
This method is called from global_navigation::load_course_sections()
By default the method global_navigation::load_generic_course_sections() is called
When overwriting please note that navigationlib relies on using the correct values for arguments $type and $key in navigation_node::add()
Example of code creating a section node: $sectionnode = $node->add($sectionname, $url, navigation_node::TYPE_SECTION, null, $section->id); $sectionnode->nodetype = navigation_node::NODETYPE_BRANCH;
Example of code creating an activity node: $activitynode = $sectionnode->add($activityname, $action, navigation_node::TYPE_ACTIVITY, null, $activity->id, $icon); if (global_navigation::module_extends_navigation($activity->modname)) { $activitynode->nodetype = navigation_node::NODETYPE_BRANCH; } else { $activitynode->nodetype = navigation_node::NODETYPE_LEAF; }
Also note that if $navigation->includesectionnum is not null, the section with this relative number needs is expected to be loaded
| global_navigation | $navigation | |
| navigation_node | $node | The course node within the navigation |
Reimplemented in format_legacy, format_singleactivity, format_social, format_topics, and format_weeks.
|
staticfinalprotectedinherited |
Get class name for the format.
If course format xxx does not declare class format_xxx, format_legacy will be returned. This function also includes lib.php file from corresponding format plugin
| string | $format |
| string |
|
inherited |
Return the plugin config settings for external functions, in some cases the configs will need formatting or be returned only if the current user has some capabilities enabled.
| array | the list of configs |
Reimplemented in format_singleactivity, format_social, format_topics, and format_weeks.
|
inherited |
Returns a record from course database table plus additional fields that course format defines.
| stdClass |
|
finalinherited |
Returns id of the course (0 if course is not specified)
| int |
| format_site::get_default_blocks | ( | ) |
Returns the list of blocks to be automatically added on the site frontpage when moodle is installed.
| array | of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT each of values is an array of block names (for left and right side columns) |
Reimplemented from format_base.
|
inherited |
Returns the default end date value based on the start date.
This is the default implementation for course formats, it is based on moodlecourse/courseduration setting. Course formats like format_weeks for example can overwrite this method and return a value based on their internal options.
| moodleform | $mform | |
| array | $fieldnames | The form - field names mapping. |
| int |
Reimplemented in format_weeks.
|
inherited |
Returns the default section using format_base's implementation of get_section_name.
| int | stdClass | $section | Section object from database or just field course_sections section |
| string | The default value for the section name based on the given course format. |
Reimplemented in format_topics, and format_weeks.
|
protectedinherited |
Get the start date value from the course settings page form.
| moodleform | $mform | |
| array | $fieldnames | The form - field names mapping. |
| int |
|
finalinherited |
Returns the format name used by this course.
| string |
|
finalinherited |
Returns the localised name of this course format plugin.
| lang_string |
|
inherited |
Returns the format options stored for this course or course section.
When overriding please note that this function is called from rebuild_course_cache() and section_info object, therefore using of get_fast_modinfo() and/or any function that accesses it may lead to recursion.
| null | int | stdClass | section_info | $section | if null the course format options will be returned otherwise options for specified section will be returned. This can be either section object or relative section number (field course_sections.section) |
| array |
|
staticfinalprotectedinherited |
Validates that course format exists and enabled and returns either itself or default format.
| string | $format |
| string |
|
inherited |
Method used in the rendered and during backup instead of legacy 'numsections'.
Default renderer will treat sections with sectionnumber greater that the value returned by this method as "orphaned" and not display them on the course page unless in editing mode. Backup will store this value as 'numsections'.
This method ensures that 3rd party course format plugins that still use 'numsections' continue to work but at the same time we no longer expect formats to have 'numsections' property.
| int |
|
inherited |
Method used to get the maximum number of sections for this course format.
| int |
|
inherited |
Returns instance of page renderer used by this plugin.
| moodle_page | $page |
| renderer_base |
|
finalinherited |
Returns information about section used in course.
| int | stdClass | $section | either section number (field course_section.section) or row from course_section table |
| int | $strictness |
| section_info |
| format_site::get_section_name | ( | $section | ) |
Returns the display name of the given section that the course prefers.
| int | stdClass | $section | Section object from database or just field section.section |
| Display | name that the course format prefers, e.g. "Topic 2" |
Reimplemented from format_base.
|
finalinherited |
Returns a list of sections used in the course.
This is a shortcut to get_fast_modinfo()->get_section_info_all()
| array | of section_info objects |
| format_site::get_view_url | ( | $section, | |
$options = array() |
|||
| ) |
For this fake course referring to the whole site, the site homepage is always returned regardless of arguments.
| int | stdClass | $section | |
| array | $options |
| null|moodle_url |
Reimplemented from format_base.
|
inherited |
Returns true if the course has a front page.
This function is called to determine if the course has a view page, whether or not it contains a listing of activities. It can be useful to set this to false when the course format has only one activity and ignores the course page. Or if there are multiple activities but no page to see the centralised information.
Initially this was created to know if forms should add a button to return to the course page. So if 'Return to course' does not make sense in your format your should probably return false.
| boolean |
Reimplemented in format_singleactivity.
|
inherited |
Prepares the templateable object to display section name.
| section_info | stdClass | $section | |
| bool | $linkifneeded | |
| bool | $editable | |
| null | lang_string | string | $edithint | |
| null | lang_string | string | $editlabel |
| core::output::inplace_editable |
Reimplemented in format_topics, and format_weeks.
|
inherited |
Updates the value in the database and modifies this object respectively.
ALWAYS check user permissions before performing an update! Throw exceptions if permissions are not sufficient or value is not legit.
| stdClass | $section | |
| string | $itemtype | |
| mixed | $newvalue |
| core::output::inplace_editable |
|
staticfinalinherited |
Returns an instance of the class.
| int | stdClass | $courseorid | either course id or an object that has the property 'format' and may contain property 'id' |
| format_base |
|
inherited |
Returns true if the specified section is current.
By default we analyze $course->marker
| int | stdClass | section_info | $section |
| bool |
Reimplemented in format_weeks.
|
inherited |
Allows course format to execute code on moodle_page::set_cm()
Current module can be accessed as $page->cm (returns instance of cm_info)
| moodle_page | $page | instance of page calling set_cm |
Reimplemented in format_singleactivity.
|
inherited |
Allows course format to execute code on moodle_page::set_course()
| moodle_page | $page | instance of page calling set_course |
Reimplemented in format_singleactivity.
|
staticfinalinherited |
Resets cache for the course (or all caches) To be called from rebuild_course_cache().
| int | $courseid |
|
inherited |
Callback used in WS core_course_edit_section when teacher performs an AJAX action on a section (show/hide)
Access to the course is already validated in the WS but the callback has to make sure that particular action is allowed by checking capabilities
Course formats should register
| stdClass | section_info | $section | |
| string | $action | |
| int | $sr |
| null|array|stdClass | any data for the Javascript post-processor (must be json-encodeable) |
Reimplemented in format_topics, and format_weeks.
|
inherited |
Definitions of the additional options that this course format uses for section.
See format_base::course_format_options() for return array definition.
Additionally section format options may have property 'cache' set to true if this option needs to be cached in get_fast_modinfo(). The 'cache' property is recommended to be set only for fields used in format_base::get_section_name(), format_base::extend_course_navigation() and format_base::get_view_url()
For better performance cached options are recommended to have 'cachedefault' property Unlike 'default', 'cachedefault' should be static and not access get_config().
Regardless of value of 'cache' all options are accessed in the code as $sectioninfo->OPTIONNAME where $sectioninfo is instance of section_info, returned by get_fast_modinfo($course)->get_section_info($sectionnum) or get_fast_modinfo($course)->get_section_info_all()
All format options for particular section are returned by calling: $this->get_format_options($section);
| bool | $foreditform |
| array |
|
inherited |
Allows to specify for modinfo that section is not available even when it is visible and conditionally available.
Note: affected user can be retrieved as: $section->modinfo->userid
Course format plugins can override the method to change the properties $available and $availableinfo that were calculated by conditional availability. To make section unavailable set: $available = false; To make unavailable section completely hidden set: $availableinfo = ''; To make unavailable section visible with availability message set: $availableinfo = get_string('sectionhidden', 'format_xxx');
| section_info | $section | |
| bool | $available | the 'available' propery of the section_info as it was evaluated by conditional availability. Can be changed by the method but 'false' can not be overridden by 'true'. |
| string | $availableinfo | the 'availableinfo' propery of the section_info as it was evaluated by conditional availability. Can be changed by the method |
|
inherited |
Returns the information about the ajax support in the given source format.
The returned object's property (boolean)capable indicates that the course format supports Moodle course ajax features.
| stdClass |
Reimplemented in format_legacy, format_topics, and format_weeks.
|
inherited |
Indicates whether the course format supports the creation of the Announcements forum.
For course format plugin developers, please override this to return true if you want the Announcements forum to be created upon course creation.
| bool |
Reimplemented in format_topics, and format_weeks.
|
inherited |
Updates format options for a course.
If $data does not contain property with the option name, the option will not be updated
| stdClass | array | $data | return value from moodleform::get_data() or array with data |
| stdClass | $oldcourse | if this function is called from update_course() this object contains information about the course before update |
| bool | whether there were any changes to the options values |
Reimplemented in format_legacy, format_topics, and format_weeks.
|
protectedinherited |
Updates format options for a course or section.
If $data does not contain property with the option name, the option will not be updated
| stdClass | array | $data | return value from moodleform::get_data() or array with data |
| null|int | null if these are options for course or section id (course_sections.id) if these are options for section |
| bool | whether there were any changes to the options values |
|
inherited |
Updates format options for a section.
Section id is expected in $data->id (or $data['id']) If $data does not contain property with the option name, the option will not be updated
| stdClass | array | $data | return value from moodleform::get_data() or array with data |
| bool | whether there were any changes to the options values |
|
inherited |
Returns true if this course format uses sections.
This function may be called without specifying the course id i.e. in course_format_uses_sections()
Developers, note that if course format does use sections there should be defined a language string with the name 'sectionname' defining what the section relates to in the format, i.e. $string['sectionname'] = 'Topic'; or $string['sectionname'] = 'Week';
| bool |
Reimplemented in format_legacy, format_topics, and format_weeks.
|
inherited |
Validates format options for the course.
| array | $data | data to insert/update |
| array | array of options that have valid values |
|
protectedinherited |
Prepares values of course or section format options before storing them in DB.
If an option has invalid value it is not returned
| array | $rawdata | associative array of the proposed course/section format options |
| int | null | $sectionid | null if it is course format option |
| array | array of options that have valid values |
|
protectedinherited |
format used for this course.
Please note that it can be different from course.format field if course referes to non-existing of disabled format
1.9.3