Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
tool_policy\output\page_managedocs_list Class Reference

Represents a management page with the list of policy documents. More...

Inheritance diagram for tool_policy\output\page_managedocs_list:
renderable templatable

Public Member Functions

 __construct ($policyid=null)
 page_managedocs_list constructor. More...
 
 export_for_template (renderer_base $output)
 Export the page data for the mustache template. More...
 

Protected Member Functions

 export_version_for_template ($output, $policy, $version, $isindented, $moveup, $movedown)
 Exports one version for the list of policies. More...
 

Protected Attributes

int $policyid = null
 
moodle_url $returnurl = null
 

Detailed Description

Represents a management page with the list of policy documents.

The page displays all policy documents in their sort order, together with draft future versions.

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

Constructor & Destructor Documentation

◆ __construct()

tool_policy\output\page_managedocs_list::__construct (   $policyid = null)

page_managedocs_list constructor.

Parameters
int$policyidwhen specified only archived versions of this policy will be displayed.

Member Function Documentation

◆ export_for_template()

tool_policy\output\page_managedocs_list::export_for_template ( renderer_base  $output)

Export the page data for the mustache template.

Parameters
renderer_base$outputrenderer to be used to render the page elements.
Return values
stdClass

Implements templatable.

◆ export_version_for_template()

tool_policy\output\page_managedocs_list::export_version_for_template (   $output,
  $policy,
  $version,
  $isindented,
  $moveup,
  $movedown 
)
protected

Exports one version for the list of policies.

Parameters
renderer_base$output
stdClass$policy
stdClass$version
bool$isindenteddisplay indented (normally drafts of the current version)
bool$moveupcan move up
bool$movedowncan move down
Return values
stdClass

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