Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.

This file contains the form add/update context instance data.

Copyright: 2018 David Monllao
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 226 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: context_instance  - X-Ref

Context instance data form.

definition()   X-Ref
Define the form - called by parent constructor


add_purpose_category($contextlevel = false)   X-Ref
Adds purpose and category selectors.

return: null
param: int $contextlevel Apply this context level defaults. False for no defaults.

get_add_element_content($label)   X-Ref
Returns the 'add' label.

It depends on the theme in use.

return: \renderable|string
param: string $label

get_context_instance_customdata(\context $context)   X-Ref
Returns the customdata array for the provided context instance.

return: array
param: \context $context

get_retention_display_text(purpose $effectivepurpose, $retentioncontextlevel, \context $context)   X-Ref
Returns the purpose display text.

return: string
param: purpose $effectivepurpose
param: int $retentioncontextlevel
param: \context $context The context, just for displaying (filters) purposes.