Exporter of a single policy document version.
More...
|
|
stdClass array | $data = null |
| | The data of this exporter.
|
| |
|
array | $related = array() |
| | $related List of related objects used to avoid DB queries.
|
| |
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).
- Copyright
- 2018 David Mudrak david.nosp@m.@moo.nosp@m.dle.c.nosp@m.om
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ define_other_properties()
| static tool_policy\policy_version_exporter::define_other_properties |
( |
| ) |
|
|
staticprotected |
Return the list of additional (calculated and readonly) properties.
- Return values
-
Reimplemented from core\external\exporter.
◆ define_properties()
| static tool_policy\policy_version_exporter::define_properties |
( |
| ) |
|
|
staticprotected |
◆ define_related()
| static tool_policy\policy_version_exporter::define_related |
( |
| ) |
|
|
staticprotected |
◆ export()
Function to export the renderer data in a format that is suitable for a mustache template.
This means raw records are generated as in to_record, but all strings are correctly passed through external_format_text (or external_format_string).
- Parameters
-
| renderer_base | $output | Used to do a final render of any components that need to be rendered for export. |
- Return values
-
◆ format_properties()
| static core\external\exporter::format_properties |
( |
|
$properties | ) |
|
|
staticfinalinherited |
Recursively formats a given property definition with the default fields required.
- Parameters
-
| array | $properties | List of properties to format |
- Return values
-
◆ get_context_structure()
| static core\external\exporter::get_context_structure |
( |
| ) |
|
|
staticfinalprotectedinherited |
Get the context structure.
- Return values
-
◆ get_create_structure()
| static core\external\exporter::get_create_structure |
( |
| ) |
|
|
staticfinalinherited |
Returns the create structure.
- Return values
-
◆ get_format_field()
| static core\external\exporter::get_format_field |
( |
|
$definitions, |
|
|
|
$property |
|
) |
| |
|
staticfinalprotectedinherited |
Get the format field name.
- Parameters
-
| array | $definitions | List of properties definitions. |
| string | $property | The name of the property that may have a format field. |
- Return values
-
| bool|string | False, or the name of the format property. |
◆ get_format_parameters()
| core\external\exporter::get_format_parameters |
( |
|
$property | ) |
|
|
finalprotectedinherited |
Get the format parameters.
This method returns the parameters to use with the functions external_format_text(), and external_format_string(). To override the default parameters, you can define a protected method called 'get_format_parameters_for_<propertyName>'. For example, 'get_format_parameters_for_description', if your property is 'description'.
Your method must return an array containing any of the following keys:
- Parameters
-
| string | $property | The property to get the parameters for. |
- Return values
-
◆ 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
-
◆ 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
-
◆ get_format_structure()
| static core\external\exporter::get_format_structure |
( |
|
$property, |
|
|
|
$definition, |
|
|
|
$required = VALUE_REQUIRED |
|
) |
| |
|
staticfinalprotectedinherited |
Get the format structure.
- Parameters
-
| string | $property | The name of the property on which the format applies. |
| array | $definition | The definition of the format property. |
| int | $required | Constant VALUE_*. |
- Return values
-
◆ get_other_values()
| tool_policy\policy_version_exporter::get_other_values |
( |
renderer_base |
$output | ) |
|
|
protected |
Get the additional values to inject while exporting.
- Parameters
-
- Return values
-
| array | Keys are the property names, values are their values. |
Reimplemented from core\external\exporter.
◆ get_read_structure()
| static core\external\exporter::get_read_structure |
( |
| ) |
|
|
staticfinalinherited |
Returns the read structure.
- Return values
-
◆ get_read_structure_from_properties()
| static core\external\exporter::get_read_structure_from_properties |
( |
|
$properties, |
|
|
|
$required = VALUE_REQUIRED, |
|
|
|
$default = null |
|
) |
| |
|
staticfinalprotectedinherited |
Returns the read structure from a set of properties (recursive).
- Parameters
-
| array | $properties | The properties. |
| int | $required | Whether is required. |
| mixed | $default | The default value. |
- Return values
-
◆ get_update_structure()
| static core\external\exporter::get_update_structure |
( |
| ) |
|
|
staticfinalinherited |
Returns the update structure.
This structure can never be included at the top level for an external function signature because it contains optional parameters.
- Return values
-
◆ properties_definition()
| static core\external\exporter::properties_definition |
( |
| ) |
|
|
staticfinalinherited |
Get the properties definition of this exporter used for create, and update structures.
The read structures are returned by: self::read_properties_definition().
- Return values
-
| array | Keys are the property names, and value their definition. |
◆ read_properties_definition()
| static core\external\exporter::read_properties_definition |
( |
| ) |
|
|
staticfinalinherited |
Get the read properties definition of this exporter.
Read properties combines the default properties from the model (persistent or stdClass) with the properties defined by self::define_other_properties().
- Return values
-
| array | Keys are the property names, and value their definition. |
The documentation for this class was generated from the following file:
1.8.20