Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
format_weeks Class Reference

Main class for the Weeks course format. More...

Inheritance diagram for format_weeks:
format_base

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 this course format uses for course. 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 configs for external functions. 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 for the newly created course. More...
 
 get_default_course_enddate ($mform, $fieldnames=array())
 Returns the default end date for weeks course format. More...
 
 get_default_section_name ($section)
 Returns the default section name for the weekly course format. 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_dates ($section, $startdate=false)
 Return the start and end date of the passed section. 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())
 The URL to use for the specified course (with section) 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 week 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 a news 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...
 
static update_end_date ($courseid)
 Updates the end date for a course in weeks format if option automaticenddate is set. 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()
 

Detailed Description

Main class for the Weeks course format.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ ajax_section_move()

format_weeks::ajax_section_move ( )

Custom action after section has been moved in AJAX mode.

Used in course/rest.php

Return values
arrayThis will be passed in ajax respose

Reimplemented from format_base.

◆ allow_stealth_module_visibility()

format_weeks::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.

Parameters
stdClass | cm_info$cmcourse module (may be null if we are displaying a form for adding a module)
stdClass | section_info$sectionsection where this module is located or will be added to
Return values
bool

Reimplemented from format_base.

◆ can_delete_section()

format_weeks::can_delete_section (   $section)

Whether this format allows to delete sections.

Do not call this function directly, instead use course_can_delete_section()

Parameters
int | stdClass | section_info$section
Return values
bool

Reimplemented from format_base.

◆ course_content_footer()

format_base::course_content_footer ( )
inherited

Course-specific information to be output immediately below content on any course page.

See format_base::course_header() for usage

Return values
null|renderablenull for no output or object with data for plugin renderer

◆ course_content_header()

format_base::course_content_header ( )
inherited

Course-specific information to be output immediately above content on any course page.

See format_base::course_header() for usage

Return values
null|renderablenull for no output or object with data for plugin renderer

◆ course_footer()

format_base::course_footer ( )
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

Return values
null|renderablenull for no output or object with data for plugin renderer

◆ course_format_options()

format_weeks::course_format_options (   $foreditform = false)

Definitions of the additional options that this course format uses for course.

Weeks format uses the following options:

  • coursedisplay
  • hiddensections
  • automaticenddate
Parameters
bool$foreditform
Return values
arrayof options

Reimplemented from format_base.

◆ course_header()

format_base::course_header ( )
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

Return values
null|renderablenull for no output or object with data for plugin renderer

◆ create_edit_form_elements()

format_weeks::create_edit_form_elements ( $mform,
  $forsection = false 
)

Adds format options elements to the course/section edit form.

This function is called from course_edit_form::definition_after_data().

Parameters
MoodleQuickForm$mformform the elements are added to.
bool$forsection'true' if this is a section edit form, 'false' if this is course edit form.
Return values
arrayarray of references to the added form elements.

Reimplemented from format_base.

◆ delete_section()

format_base::delete_section (   $section,
  $forcedeleteifnotempty = false 
)
inherited

Deletes a section.

Do not call this function directly, instead call course_delete_section()

Parameters
int | stdClass | section_info$section
bool$forcedeleteifnotemptyif set to false section will not be deleted if it has modules in it.
Return values
boolwhether section was deleted

◆ edit_form_validation()

format_base::edit_form_validation (   $data,
  $files,
  $errors 
)
inherited

Override if you need to perform some extra validation of the format options.

Parameters
array$dataarray of ("fieldname"=>value) of submitted data
array$filesarray of uploaded files "element_name"=>tmp_file_path
array$errorserrors already discovered in edit form validation
Return values
arrayof "element_name"=>"error_description" if there are errors, or an empty array if everything is OK. Do not repeat errors from $errors param here

◆ editsection_form()

format_base::editsection_form (   $action,
  $customdata = array() 
)
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.

Parameters
mixed$actionthe 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$customdatathe array with custom data to be passed to the form /course/editsection.php passes section_info object in 'cs' field for filling availability fields
Return values
moodleform

◆ extend_course_navigation()

format_weeks::extend_course_navigation (   $navigation,
navigation_node  $node 
)

Loads all of the course sections into the navigation.

Parameters
global_navigation$navigation
navigation_node$nodeThe course node within the navigation

Reimplemented from format_base.

◆ get_class_name()

static format_base::get_class_name (   $format)
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

Parameters
string$format
Return values
string

◆ get_config_for_external()

format_weeks::get_config_for_external ( )

Return the plugin configs for external functions.

Return values
arraythe list of configuration settings
Since
Moodle 3.5

Reimplemented from format_base.

◆ get_course()

format_base::get_course ( )
inherited

Returns a record from course database table plus additional fields that course format defines.

Return values
stdClass

◆ get_courseid()

format_base::get_courseid ( )
finalinherited

Returns id of the course (0 if course is not specified)

Return values
int

◆ get_default_blocks()

format_weeks::get_default_blocks ( )

Returns the list of blocks to be automatically added for the newly created course.

Return values
arrayof 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.

◆ get_default_course_enddate()

format_weeks::get_default_course_enddate (   $mform,
  $fieldnames = array() 
)

Returns the default end date for weeks course format.

Parameters
moodleform$mform
array$fieldnamesThe form - field names mapping.
Return values
int

Reimplemented from format_base.

◆ get_default_section_name()

format_weeks::get_default_section_name (   $section)

Returns the default section name for the weekly course format.

If the section number is 0, it will use the string with key = section0name from the course format's lang file. Otherwise, the default format of "[start date] - [end date]" will be returned.

Parameters
stdClass$sectionSection object from database or just field course_sections section
Return values
stringThe default value for the section name.

Reimplemented from format_base.

◆ get_form_start_date()

format_base::get_form_start_date (   $mform,
  $fieldnames 
)
protectedinherited

Get the start date value from the course settings page form.

Parameters
moodleform$mform
array$fieldnamesThe form - field names mapping.
Return values
int

◆ get_format()

format_base::get_format ( )
finalinherited

Returns the format name used by this course.

Return values
string

◆ get_format_name()

format_base::get_format_name ( )
finalinherited

Returns the localised name of this course format plugin.

Return values
lang_string

◆ get_format_options()

format_base::get_format_options (   $section = null)
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.

Parameters
null | int | stdClass | section_info$sectionif 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)
Return values
array

◆ get_format_or_default()

static format_base::get_format_or_default (   $format)
staticfinalprotectedinherited

Validates that course format exists and enabled and returns either itself or default format.

Parameters
string$format
Return values
string

◆ get_last_section_number()

format_base::get_last_section_number ( )
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.

Return values
int

◆ get_max_sections()

format_base::get_max_sections ( )
inherited

Method used to get the maximum number of sections for this course format.

Return values
int

◆ get_renderer()

format_base::get_renderer ( moodle_page  $page)
inherited

Returns instance of page renderer used by this plugin.

Parameters
moodle_page$page
Return values
renderer_base

◆ get_section()

format_base::get_section (   $section,
  $strictness = IGNORE_MISSING 
)
finalinherited

Returns information about section used in course.

Parameters
int | stdClass$sectioneither section number (field course_section.section) or row from course_section table
int$strictness
Return values
section_info

◆ get_section_dates()

format_weeks::get_section_dates (   $section,
  $startdate = false 
)

Return the start and end date of the passed section.

Parameters
int | stdClass | section_info$sectionsection to get the dates for
int$startdateForce course start date, useful when the course is not yet created
Return values
stdClassproperty start for startdate, property end for enddate

◆ get_section_name()

format_weeks::get_section_name (   $section)

Returns the display name of the given section that the course prefers.

Parameters
int | stdClass$sectionSection object from database or just field section.section
Return values
stringDisplay name that the course format prefers, e.g. "Topic 2"

Reimplemented from format_base.

◆ get_sections()

format_base::get_sections ( )
finalinherited

Returns a list of sections used in the course.

This is a shortcut to get_fast_modinfo()->get_section_info_all()

See also
get_fast_modinfo()
course_modinfo::get_section_info_all()
Return values
arrayof section_info objects

◆ get_view_url()

format_weeks::get_view_url (   $section,
  $options = array() 
)

The URL to use for the specified course (with section)

Parameters
int | stdClass$sectionSection object from database or just field course_sections.section if omitted the course view page is returned
array$optionsoptions for view URL. At the moment core uses: 'navigation' (bool) if true and section has no separate page, the function returns null 'sr' (int) used by multipage formats to specify to which section to return
Return values
null|moodle_url

Reimplemented from format_base.

◆ has_view_page()

format_base::has_view_page ( )
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.

Return values
boolean
Since
Moodle 2.6

Reimplemented in format_singleactivity.

◆ inplace_editable_render_section_name()

format_weeks::inplace_editable_render_section_name (   $section,
  $linkifneeded = true,
  $editable = null,
  $edithint = null,
  $editlabel = null 
)

Prepares the templateable object to display section name.

Parameters
section_info | stdClass$section
bool$linkifneeded
bool$editable
null | lang_string | string$edithint
null | lang_string | string$editlabel
Return values
core::output::inplace_editable

Reimplemented from format_base.

◆ inplace_editable_update_section_name()

format_base::inplace_editable_update_section_name (   $section,
  $itemtype,
  $newvalue 
)
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.

Parameters
stdClass$section
string$itemtype
mixed$newvalue
Return values
core::output::inplace_editable

◆ instance()

static format_base::instance (   $courseorid)
staticfinalinherited

Returns an instance of the class.

Todo:
MDL-35727 use MUC for caching of instances, limit the number of cached instances
Parameters
int | stdClass$courseorideither course id or an object that has the property 'format' and may contain property 'id'
Return values
format_base

◆ is_section_current()

format_weeks::is_section_current (   $section)

Returns true if the specified week is current.

Parameters
int | stdClass | section_info$section
Return values
bool

Reimplemented from format_base.

◆ page_set_cm()

format_base::page_set_cm ( moodle_page  $page)
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)

Parameters
moodle_page$pageinstance of page calling set_cm

Reimplemented in format_singleactivity.

◆ page_set_course()

format_base::page_set_course ( moodle_page  $page)
inherited

Allows course format to execute code on moodle_page::set_course()

Parameters
moodle_page$pageinstance of page calling set_course

Reimplemented in format_singleactivity.

◆ reset_course_cache()

static format_base::reset_course_cache (   $courseid = 0)
staticfinalinherited

Resets cache for the course (or all caches) To be called from rebuild_course_cache().

Parameters
int$courseid

◆ section_action()

format_weeks::section_action (   $section,
  $action,
  $sr 
)

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

Parameters
stdClass | section_info$section
string$action
int$sr
Return values
null|array|stdClassany data for the Javascript post-processor (must be json-encodeable)

Reimplemented from format_base.

◆ section_format_options()

format_base::section_format_options (   $foreditform = false)
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);

Parameters
bool$foreditform
Return values
array

◆ section_get_available_hook()

format_base::section_get_available_hook ( section_info  $section,
$available,
$availableinfo 
)
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');

Parameters
section_info$section
bool$availablethe '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$availableinfothe 'availableinfo' propery of the section_info as it was evaluated by conditional availability. Can be changed by the method

◆ supports_ajax()

format_weeks::supports_ajax ( )

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.

Return values
stdClass

Reimplemented from format_base.

◆ supports_news()

format_weeks::supports_news ( )

Indicates whether the course format supports the creation of a news forum.

Return values
bool

Reimplemented from format_base.

◆ update_course_format_options()

format_weeks::update_course_format_options (   $data,
  $oldcourse = null 
)

Updates format options for a course.

In case if course format was changed to 'weeks', we try to copy options 'coursedisplay', 'numsections' and 'hiddensections' from the previous format. If previous course format did not have 'numsections' option, we populate it with the current number of sections

Parameters
stdClass | array$datareturn value from moodleform::get_data() or array with data
stdClass$oldcourseif this function is called from update_course() this object contains information about the course before update
Return values
boolwhether there were any changes to the options values

Reimplemented from format_base.

◆ update_end_date()

static format_weeks::update_end_date (   $courseid)
static

Updates the end date for a course in weeks format if option automaticenddate is set.

This method is called from event observers and it can not use any modinfo or format caches because events are triggered before the caches are reset.

Parameters
int$courseid

◆ update_format_options()

format_base::update_format_options (   $data,
  $sectionid = null 
)
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

Parameters
stdClass | array$datareturn value from moodleform::get_data() or array with data
null|intnull if these are options for course or section id (course_sections.id) if these are options for section
Return values
boolwhether there were any changes to the options values

◆ update_section_format_options()

format_base::update_section_format_options (   $data)
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

Parameters
stdClass | array$datareturn value from moodleform::get_data() or array with data
Return values
boolwhether there were any changes to the options values

◆ uses_sections()

format_weeks::uses_sections ( )

Returns true if this course format uses sections.

Return values
bool

Reimplemented from format_base.

◆ validate_course_format_options()

format_base::validate_course_format_options ( array  $data)
inherited

Validates format options for the course.

Parameters
array$datadata to insert/update
Return values
arrayarray of options that have valid values

◆ validate_format_options()

format_base::validate_format_options ( array  $rawdata,
int  $sectionid = null 
)
protectedinherited

Prepares values of course or section format options before storing them in DB.

If an option has invalid value it is not returned

Parameters
array$rawdataassociative array of the proposed course/section format options
int | null$sectionidnull if it is course format option
Return values
arrayarray of options that have valid values

Member Data Documentation

◆ $format

string format_base::$format
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


The documentation for this class was generated from the following file: