Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
tool_policy\policy_version_exporter Class Reference

Exporter of a single policy document version. More...

Inheritance diagram for tool_policy\policy_version_exporter:

Protected Member Functions

 get_format_parameters_for_content ()
 Get the formatting parameters for the content field.
 
 get_format_parameters_for_summary ()
 Get the formatting parameters for the summary field.
 
 get_other_values (renderer_base $output)
 Get the additional values to inject while exporting.
 

Static Protected Member Functions

static define_other_properties ()
 Return the list of additional (calculated and readonly) properties.
 
static define_properties ()
 Return the list of properties.
 
static define_related ()
 Returns a list of objects that are related.
 

Detailed Description

Exporter of a single policy document version.

Note we cannot use the persistent_exporter as our super class because we want to add some properties not present in the persistent (e.g. acceptancescount).

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

Member Function Documentation

◆ define_other_properties()

static tool_policy\policy_version_exporter::define_other_properties ( )
staticprotected

Return the list of additional (calculated and readonly) properties.

Return values
array

◆ define_properties()

static tool_policy\policy_version_exporter::define_properties ( )
staticprotected

Return the list of properties.

Return values
array

◆ define_related()

static tool_policy\policy_version_exporter::define_related ( )
staticprotected

Returns a list of objects that are related.

Return values
array

◆ get_format_parameters_for_content()

tool_policy\policy_version_exporter::get_format_parameters_for_content ( )
protected

Get the formatting parameters for the content field.

Return values
array

◆ get_format_parameters_for_summary()

tool_policy\policy_version_exporter::get_format_parameters_for_summary ( )
protected

Get the formatting parameters for the summary field.

Return values
array

◆ get_other_values()

tool_policy\policy_version_exporter::get_other_values ( renderer_base $output)
protected

Get the additional values to inject while exporting.

Parameters
renderer_base$outputThe renderer.
Return values
arrayKeys are the property names, values are their values.

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