Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
/availability/classes/output/ -> availability_info.php (source)

[Source view]

Differences Between: [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]

Renderable for the availability info.

Copyright: 2021 Bas Brands <bas@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 122 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

availability_info:: (5 methods):
  __construct()
  export_for_template()
  get_item_base_template()
  get_item_template()
  get_item_header()


Class: availability_info  - X-Ref

Base class to render availability info.

__construct(core_availability_multiple_messages $renderable)   X-Ref
Constructor.

param: core_availability_multiple_messages $renderable the availability messages

export_for_template(\renderer_base $output)   X-Ref
Export this data so it can be used as the context for a mustache template.

param: \renderer_base $output typically, the renderer that's calling this function
return: stdClass data context for a mustache template

get_item_base_template()   X-Ref
Get the item base template.

return: stdClass the template base

get_item_template(core_availability_multiple_messages $availability)   X-Ref
Get the item template.

param: core_availability_multiple_messages $availability the availability messages
return: stdClass the template

get_item_header(core_availability_multiple_messages $availability)   X-Ref
Get the item header.
Depending on availability configuration this will return a string from a combined string identifier.
For example: list_root_and_hidden, list_and, list_root_or_hidden, list_root_or, etc.

param: core_availability_multiple_messages $availability the availability messages
return: string the item header