Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
mod_forum\local\exporters\posts Class Reference

Posts exporter class. More...

Inheritance diagram for mod_forum\local\exporters\posts:
core\external\exporter

Public Member Functions

 __construct (array $posts, array $authorsbyid=[], array $authorcontextids=[], array $attachmentsbypostid=[], array $groupsbyauthorid=[], array $tagsbypostid=[], array $ratingbypostid=[], array $related=[])
 Constructor. More...
 
 export (renderer_base $output)
 Function to export the renderer data in a format that is suitable for a mustache template. More...
 

Static Public Member Functions

static format_properties ($properties)
 Recursively formats a given property definition with the default fields required. More...
 
static get_create_structure ()
 Returns the create structure. More...
 
static get_read_structure ()
 Returns the read structure. More...
 
static get_update_structure ()
 Returns the update structure. More...
 
static properties_definition ()
 Get the properties definition of this exporter used for create, and update structures. More...
 
static read_properties_definition ()
 Get the read properties definition of this exporter. More...
 

Protected Member Functions

 get_format_parameters ($property)
 Get the format parameters. More...
 
 get_other_values (renderer_base $output)
 Get the additional values to inject while exporting. More...
 

Static Protected Member Functions

static define_other_properties ()
 Return the list of additional properties. More...
 
static define_properties ()
 Return the list of properties. More...
 
static define_related ()
 Returns a list of objects that are related. More...
 
static get_context_structure ()
 Get the context structure. More...
 
static get_format_field ($definitions, $property)
 Get the format field name. More...
 
static get_format_structure ($property, $definition, $required=VALUE_REQUIRED)
 Get the format structure. More...
 
static get_read_structure_from_properties ($properties, $required=VALUE_REQUIRED, $default=null)
 Returns the read structure from a set of properties (recursive). More...
 

Protected Attributes

stdClass array $data = null
 The data of this exporter.
 
array $related = array()
 $related List of related objects used to avoid DB queries.
 

Detailed Description

Posts exporter class.

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

Constructor & Destructor Documentation

◆ __construct()

mod_forum\local\exporters\posts::__construct ( array  $posts,
array  $authorsbyid = [],
array  $authorcontextids = [],
array  $attachmentsbypostid = [],
array  $groupsbyauthorid = [],
array  $tagsbypostid = [],
array  $ratingbypostid = [],
array  $related = [] 
)

Constructor.

Parameters
post_entity[]$postsList of posts to export
author_entity[]$authorsbyidList of authors for the posts indexed by author id
int[]$authorcontextidsList of authors context ids indexed by author id
array$attachmentsbypostidList of attachments indexed by post id
array$groupsbyauthoridList of author's groups indexed by author id
array$tagsbypostidList of tags indexed by post id
array$ratingbypostidList of ratings indexed by post id
array$relatedThe related objects for exporting

Member Function Documentation

◆ define_other_properties()

static mod_forum\local\exporters\posts::define_other_properties ( )
staticprotected

Return the list of additional properties.

Return values
array

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 core::persistent::define_properties(). 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
array

Reimplemented in tool_dataprivacy\external\name_description_exporter, tool_lp\external\course_competency_statistics_exporter, tool_lp\external\path_node_exporter, tool_lp\external\template_statistics_exporter, tool_policy\policy_exporter, tool_policy\policy_version_exporter, core_badges\external\alignment_exporter, core_badges\external\assertion_exporter, core_badges\external\backpack_exporter, core_badges\external\badgeclass_exporter, core_badges\external\collection_exporter, core_badges\external\endorsement_exporter, core_badges\external\issuer_exporter, core_badges\external\recipient_exporter, core_badges\external\related_info_exporter, core_badges\external\user_badge_exporter, core_badges\external\verification_exporter, block_recentlyaccesseditems\external\recentlyaccesseditems_item_exporter, core_blog\external\post_exporter, core_calendar\external\date_exporter, core_calendar\external\day_exporter, core_calendar\external\day_name_exporter, core_calendar\external\event_action_exporter, core_calendar\external\event_exporter_base, core_calendar\external\event_icon_exporter, core_calendar\external\event_subscription_exporter, core_calendar\external\month_exporter, core_calendar\external\week_day_exporter, core_cohort\external\cohort_summary_exporter, core_comment\external\comment_area_exporter, core_course\external\course_summary_exporter, core_course\local\exporters\course_content_item_exporter, core_course\local\exporters\course_content_items_exporter, core_files\external\stored_file_exporter, core\external\coursecat_summary_exporter, core\external\persistent_exporter, mod_chat\external\chat_message_exporter, mod_data\external\content_exporter, mod_data\external\database_summary_exporter, mod_data\external\field_exporter, mod_data\external\record_exporter, mod_feedback\external\feedback_completed_exporter, mod_feedback\external\feedback_completedtmp_exporter, mod_feedback\external\feedback_item_exporter, mod_feedback\external\feedback_summary_exporter, mod_feedback\external\feedback_value_exporter, mod_feedback\external\feedback_valuetmp_exporter, mod_h5pactivity\external\h5pactivity_summary_exporter, mod_lesson\external\lesson_summary_exporter, mod_workshop\external\assessment_exporter, mod_workshop\external\submission_exporter, mod_workshop\external\workshop_summary_exporter, core_question\external\question_icon_exporter, core_question\external\question_summary_exporter, core_tag\external\tag_area_exporter, core_tag\external\tag_collection_exporter, core_tag\external\tag_item_exporter, and core_user\external\user_summary_exporter.

◆ define_related()

static mod_forum\local\exporters\posts::define_related ( )
staticprotected

Returns a list of objects that are related.

Return values
array

Reimplemented from core\external\exporter.

◆ export()

core\external\exporter::export ( renderer_base  $output)
finalinherited

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$outputUsed to do a final render of any components that need to be rendered for export.
Return values
stdClass

◆ format_properties()

static core\external\exporter::format_properties (   $properties)
staticfinalinherited

Recursively formats a given property definition with the default fields required.

Parameters
array$propertiesList of properties to format
Return values
arrayFormatted array

◆ get_context_structure()

static core\external\exporter::get_context_structure ( )
staticfinalprotectedinherited

Get the context structure.

Return values
external_single_structure

◆ get_create_structure()

static core\external\exporter::get_create_structure ( )
staticfinalinherited

Returns the create structure.

Return values
external_single_structure

◆ get_format_field()

static core\external\exporter::get_format_field (   $definitions,
  $property 
)
staticfinalprotectedinherited

Get the format field name.

Parameters
array$definitionsList of properties definitions.
string$propertyThe name of the property that may have a format field.
Return values
bool|stringFalse, 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$propertyThe property to get the parameters for.
Return values
array

◆ get_format_structure()

static core\external\exporter::get_format_structure (   $property,
  $definition,
  $required = VALUE_REQUIRED 
)
staticfinalprotectedinherited

Get the format structure.

Parameters
string$propertyThe name of the property on which the format applies.
array$definitionThe definition of the format property.
int$requiredConstant VALUE_*.
Return values
external_format_value

◆ get_other_values()

mod_forum\local\exporters\posts::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.

Reimplemented from core\external\exporter.

◆ get_read_structure()

static core\external\exporter::get_read_structure ( )
staticfinalinherited

Returns the read structure.

Return values
external_single_structure

◆ 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$propertiesThe properties.
int$requiredWhether is required.
mixed$defaultThe default value.
Return values
external_single_structure

◆ 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
external_single_structure

◆ 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
arrayKeys 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
arrayKeys are the property names, and value their definition.

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