mod_forum\local\exporters\post Class Reference

Post exporter class. More...

Inheritance diagram for mod_forum\local\exporters\post:

Public Member Functions
	__construct (post_entity $post, 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_format_parameters_for_message ()
	This method returns the parameters for the post's message to use with the function external_format_text(). 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

Post exporter class.

Copyright

2019 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Constructor & Destructor Documentation

__construct()

mod_forum\local\exporters\post::__construct	(	post_entity	$post,
		array	$related = []
	)

Constructor.

Parameters

post_entity	$post	The post to export
array	$related	List of related data

Member Function Documentation

define_other_properties()

static mod_forum\local\exporters\post::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 (). 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 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 mod_forum\local\exporters\post::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

$output

Used 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

$properties

List of properties to format

Return values

array

Formatted 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	$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:

• context: The context to use. Defaults to $this->related['context'] if defined, else throws an exception.
• component: The component to use with external_format_text(). Defaults to null.
• filearea: The filearea to use with external_format_text(). Defaults to null.
• itemid: The itemid to use with external_format_text(). Defaults to null.
• options: An array of options accepted by external_format_text() or external_format_string(). Defaults to [].
• striplinks: Whether to strip the links with external_format_string(). Defaults to true.

Parameters

string

$property

The property to get the parameters for.

Return values

array

get_format_parameters_for_message()

mod_forum\local\exporters\post::get_format_parameters_for_message ( )

protected

This method returns the parameters for the post's message to use with the function external_format_text().

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	$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

external_format_value

get_other_values()

mod_forum\local\exporters\post::get_other_values ( renderer_base  $output )

protected

Get the additional values to inject while exporting.

Parameters

renderer_base

$output

The renderer.

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

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	$properties	The properties.
int	$required	Whether is required.
mixed	$default	The 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

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:

• mod/forum/classes/local/exporters/post.php