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

Represents multiple availability messages. More...

Inheritance diagram for core_availability_multiple_messages:
renderable

Public Member Functions

 __construct ($root, $andoperator, $treehidden, array $items)
 Constructor. More...
 

Public Attributes

bool $andoperator
 True if items use the AND operator (false = OR)
 
array $items
 Array of child items (may be string or this type)
 
bool $root
 True if this object represents the root of the tree.
 
bool $treehidden
 True if this part of the tree is marked 'hide entirely' for non-matching users.
 

Detailed Description

Represents multiple availability messages.

These are messages like 'Not available until <date>'. This class includes multiple messages so that they can be rendered into a combined display, e.g. using bulleted lists.

The tree structure of this object matches that of the availability restrictions.

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

Constructor & Destructor Documentation

◆ __construct()

core_availability_multiple_messages::__construct (   $root,
  $andoperator,
  $treehidden,
array  $items 
)

Constructor.

Parameters
bool$rootTrue if this object represents the root of the tree
bool$andoperatorTrue if items use the AND operator (false = OR)
bool$treehiddenTrue if this part of the tree is marked 'hide entirely' for non-matching users
array$itemsArray of items (may be string or this type)

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