Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
block_timeline\output\main Class Reference

Class containing data for timeline block. More...

Inheritance diagram for block_timeline\output\main:
renderable templatable

Public Member Functions

 __construct ($order, $filter, $limit)
 main constructor.
 
 export_for_template (renderer_base $output)
 Export this data so it can be used as the context for a mustache template.
 

Public Attributes

string $filter
 The current filter preference.
 
string $limit
 The current limit preference.
 
string $order
 The current sort/order preference.
 
const COURSES_PER_PAGE = 2
 Number of courses to load per page.
 

Protected Member Functions

 get_filters_as_booleans ()
 Test the available filters with the current user preference and return an array with bool flags corresponding to which is active.
 

Protected Attributes

int $timelineinstanceid = 0
 This timeline instance's ID.
 

Static Protected Attributes

static int $timelineinstances = 0
 Number of timeline instances displayed.
 

Detailed Description

Class containing data for timeline block.

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

Constructor & Destructor Documentation

◆ __construct()

block_timeline\output\main::__construct ( $order,
$filter,
$limit )

main constructor.

Parameters
string$orderConstant sort value from ../timeline/lib.php
string$filterConstant filter value from ../timeline/lib.php
string$limitConstant limit value from ../timeline/lib.php

Member Function Documentation

◆ export_for_template()

block_timeline\output\main::export_for_template ( renderer_base $output)

Export this data so it can be used as the context for a mustache template.

Parameters
renderer_base$output
Return values
array

Implements templatable.

◆ get_filters_as_booleans()

block_timeline\output\main::get_filters_as_booleans ( )
protected

Test the available filters with the current user preference and return an array with bool flags corresponding to which is active.

Return values
array

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