core\content\export\exportable_item Class Reference

An object used to represent content which can be served. More...

Inheritance diagram for core\content\export\exportable_item:

Public Member Functions
	__construct (context $context, string $component, string $uservisiblename)
	Create a new exportable_item instance.
	add_to_archive (zipwriter $archive)
	Add the content to the archive.
	get_component ()
	Get the component that this exportable item relates to.
	get_context ()
	Get the context that this exportable item is for.
	get_user_visible_name ()
	Get the user visible name for the exportable item.

Protected Attributes
string	$component = null
	The component being exported.
context	$context = null
	The context associated with this exportable item.
string	$uservisiblename = null
	The name displayed to the user.

Detailed Description

An object used to represent content which can be served.

Copyright

2020 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Constructor & Destructor Documentation

__construct()

core\content\export\exportable_item::__construct	(	context	$context,
		string	$component,
		string	$uservisiblename )

Create a new exportable_item instance.

Parameters

context	$context	The context that this content belongs to
string	$component	The component that this content relates to
string	$uservisiblename	The name displayed in the export

Member Function Documentation

add_to_archive()

core\content\export\exportable_item::add_to_archive ( zipwriter $archive )

abstract

Add the content to the archive.

Parameters

zipwriter

$archive

Reimplemented in core\content\export\exportable_items\exportable_filearea, core\content\export\exportable_items\exportable_stored_file, and core\content\export\exportable_items\exportable_textarea.

get_component()

core\content\export\exportable_item::get_component

(

)

Get the component that this exportable item relates to.

Return values

string

get_context()

core\content\export\exportable_item::get_context

(

)

Get the context that this exportable item is for.

Return values

context

get_user_visible_name()

core\content\export\exportable_item::get_user_visible_name

(

)

Get the user visible name for the exportable item.

Return values

string

---

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

• lib/classes/content/export/exportable_item.php