core_privacy\local\request\content_writer Interface Reference

The interface for a Moodle content writer. More...

Inheritance diagram for core_privacy\local\request\content_writer:

Public Member Functions
	__construct (writer $writer)
	Constructor for the content writer.
	export_area_files (array $subcontext, $component, $filearea, $itemid)
	Export all files within the specified component, filearea, itemid combination.
	export_custom_file (array $subcontext, $filename, $filecontent)
	Export a piece of data in a custom format.
	export_data (array $subcontext, stdClass $data)
	Export the supplied data within the current context, at the supplied subcontext.
	export_file (array $subcontext, stored_file $file)
	Export the specified file in the target location.
	export_metadata (array $subcontext, string $name, $value, string $description)
	Export metadata about the supplied subcontext.
	export_related_data (array $subcontext, $name, $data)
	Export a piece of related data.
	export_user_preference (string $component, string $key, string $value, string $description)
	Export the specified user preference.
	finalise_content ()
	Perform any required finalisation steps and return the location of the finalised export.
	rewrite_pluginfile_urls (array $subcontext, $component, $filearea, $itemid, $text)
	Prepare a text area by processing pluginfile URLs within it.
	set_context (\context $context)
	Set the context for the current item being processed.

Detailed Description

The interface for a Moodle content writer.

Copyright

2018 Jake Dallimore jrhda.nosp@m.llim.nosp@m.ore@g.nosp@m.mail.nosp@m..com

Constructor & Destructor Documentation

__construct()

core_privacy\local\request\content_writer::__construct

(

writer

$writer

)

Constructor for the content writer.

Note: The writer_factory must be passed.

Parameters

writer

$writer

The factory.

Implemented in core_privacy\local\request\moodle_content_writer.

Member Function Documentation

export_area_files()

core_privacy\local\request\content_writer::export_area_files	(	array	$subcontext,
			$component,
			$filearea,
			$itemid )

Export all files within the specified component, filearea, itemid combination.

Parameters

array	$subcontext	The location within the current context that this data belongs.
string	$component	The name of the component that the files belong to.
string	$filearea	The filearea within that component.
string	$itemid	Which item those files belong to.

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_custom_file()

core_privacy\local\request\content_writer::export_custom_file	(	array	$subcontext,
			$filename,
			$filecontent )

Export a piece of data in a custom format.

Parameters

array	$subcontext	The location within the current context that this data belongs.
string	$filename	The name of the file to be exported.
string	$filecontent	The content to be exported.

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_data()

core_privacy\local\request\content_writer::export_data	(	array	$subcontext,
		stdClass	$data )

Export the supplied data within the current context, at the supplied subcontext.

Parameters

array	$subcontext	The location within the current context that this data belongs.
stdClass	$data	The data to be exported

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_file()

core_privacy\local\request\content_writer::export_file	(	array	$subcontext,
		stored_file	$file )

Export the specified file in the target location.

Parameters

array	$subcontext	The location within the current context that this data belongs.
stored_file	$file	The file to be exported.

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_metadata()

core_privacy\local\request\content_writer::export_metadata	(	array	$subcontext,
		string	$name,
			$value,
		string	$description )

Export metadata about the supplied subcontext.

Metadata consists of a key/value pair and a description of the value.

Parameters

array	$subcontext	The location within the current context that this data belongs.
string	$name	The metadata name.
string	$value	The metadata value.
string	$description	The description of the value.

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_related_data()

core_privacy\local\request\content_writer::export_related_data	(	array	$subcontext,
			$name,
			$data )

Export a piece of related data.

Parameters

array	$subcontext	The location within the current context that this data belongs.
string	$name	The name of the file to be exported.
stdClass	$data	The related data to export.

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

export_user_preference()

core_privacy\local\request\content_writer::export_user_preference	(	string	$component,
		string	$key,
		string	$value,
		string	$description )

Export the specified user preference.

Parameters

string	$component	The name of the component.
string	$key	The name of th key to be exported.
string	$value	The value of the preference
string	$description	A description of the value

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

finalise_content()

core_privacy\local\request\content_writer::finalise_content

(

)

Perform any required finalisation steps and return the location of the finalised export.

Return values

string

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

rewrite_pluginfile_urls()

core_privacy\local\request\content_writer::rewrite_pluginfile_urls	(	array	$subcontext,
			$component,
			$filearea,
			$itemid,
			$text )

Prepare a text area by processing pluginfile URLs within it.

Parameters

array	$subcontext	The location within the current context that this data belongs.
string	$component	The name of the component that the files belong to.
string	$filearea	The filearea within that component.
string	$itemid	Which item those files belong to.
string	$text	The text to be processed

Return values

string

The processed string

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

set_context()

core_privacy\local\request\content_writer::set_context

(

\context

$context

)

Set the context for the current item being processed.

Parameters

context

$context

The context to use

Return values

content_writer

Implemented in core_privacy\local\request\moodle_content_writer, and core_privacy\tests\request\content_writer.

---

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

• privacy/classes/local/request/content_writer.php