Class for exporting competency_path data.
More...
|
|
stdClass array | $data = null |
| | The data of this exporter.
|
| |
|
array | $related = array() |
| | $related List of related objects used to avoid DB queries.
|
| |
◆ __construct()
| tool_lp\external\competency_path_exporter::__construct |
( |
|
$related | ) |
|
Constructor.
- Parameters
-
| array | $related | - related objects. |
◆ define_other_properties()
| static tool_lp\external\competency_path_exporter::define_other_properties |
( |
| ) |
|
|
staticprotected |
Return the list of additional properties used only for display.
- Return values
-
| array | - Keys with their types. |
Reimplemented from core\external\exporter.
◆ define_properties()
| static core\external\exporter::define_properties |
( |
| ) |
|
|
staticprotectedinherited |
Return the list of properties.
The format of the array returned by this method has to match the structure defined in (). Howewer you can add a new attribute "description" to describe the parameter for documenting the API.
Note that the type PARAM_TEXT should ONLY be used for strings which need to go through filters (multilang, etc...) and do not have a FORMAT_* associated to them. Typically strings passed through to format_string().
Other filtered strings which use a FORMAT_* constant (hear used with format_text) must be defined as PARAM_RAW.
- Return values
-
Reimplemented in core_competency\external\user_summary_exporter, core_tag\external\tag_item_exporter, core_tag\external\tag_collection_exporter, core_tag\external\tag_area_exporter, core_question\external\question_summary_exporter, core_question\external\question_icon_exporter, mod_workshop\external\workshop_summary_exporter, mod_workshop\external\submission_exporter, mod_workshop\external\assessment_exporter, mod_lesson\external\lesson_summary_exporter, mod_feedback\external\feedback_valuetmp_exporter, mod_feedback\external\feedback_value_exporter, mod_feedback\external\feedback_summary_exporter, mod_feedback\external\feedback_item_exporter, mod_feedback\external\feedback_completedtmp_exporter, mod_feedback\external\feedback_completed_exporter, mod_data\external\record_exporter, mod_data\external\field_exporter, mod_data\external\database_summary_exporter, mod_data\external\content_exporter, mod_chat\external\chat_message_exporter, core\external\persistent_exporter, core\external\coursecat_summary_exporter, core_files\external\stored_file_exporter, core_course\external\course_summary_exporter, core_comment\external\comment_area_exporter, core_cohort\external\cohort_summary_exporter, core_calendar\external\week_day_exporter, core_calendar\external\month_exporter, core_calendar\external\event_subscription_exporter, core_calendar\external\event_icon_exporter, core_calendar\external\event_exporter_base, core_calendar\external\event_action_exporter, core_calendar\external\day_name_exporter, core_calendar\external\day_exporter, core_calendar\external\date_exporter, core_blog\external\post_exporter, core_competency\external\recentlyaccesseditems_item_exporter, core_badges\external\verification_exporter, core_badges\external\user_badge_exporter, core_badges\external\related_info_exporter, core_badges\external\recipient_exporter, core_badges\external\issuer_exporter, core_badges\external\endorsement_exporter, core_badges\external\collection_exporter, core_badges\external\badgeclass_exporter, core_badges\external\backpack_exporter, core_badges\external\assertion_exporter, core_badges\external\alignment_exporter, tool_policy\policy_version_exporter, tool_policy\policy_exporter, tool_lp\external\template_statistics_exporter, tool_lp\external\path_node_exporter, tool_lp\external\course_competency_statistics_exporter, and tool_dataprivacy\external\name_description_exporter.
◆ define_related()
| static tool_lp\external\competency_path_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_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_lp\external\competency_path_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