zms._exportable.Exportable

class documentation

class Exportable(_filtermanager.FilterItem): (source)

Mixin that provides XML, HTML, and archive export helpers.

Method	`exportExternalResources`	Download configured remote resources and relink them locally.
Method	`exportRessources`	Export auxiliary resources required by an archive export.
Method	`getObjChildrenToXml`	Render all filtered child nodes as XML fragments.
Method	`getObjToXml`	Render the current object as its custom XML fragment.
Method	`manage_export`	Export the current object in one of the configured formats.
Method	`recurse_downloadHtmlPages`	Recursively render and store HTML pages for a content subtree.
Method	`toXhtml`	Render the current object as localized standalone HTML.
Method	`toXml`	Render the current object tree as an XML export document.
Method	`toZippedHtml`	Build a ZIP archive containing localized HTML export pages.
Method	`toZippedXml`	Build a ZIP archive containing the XML export and resources.
Class Variable	`security`	Undocumented

def exportExternalResources(self, obj, html, path, REQUEST): (source) ¶

Download configured remote resources and relink them locally.

Parameters
obj:`OFS.SimpleItem.Item`	Content object whose HTML is being exported.
html:`str`	Rendered markup.
path:`str`	Directory receiving downloaded resources.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
Returns
`str`	Markup with localized external resource links.

def exportRessources(self, tempfolder, REQUEST, from_content=True, from_zms=False, from_home=False): (source) ¶

Export auxiliary resources required by an archive export.

Parameters
tempfolder:`str`	Temporary export directory.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
from_content:`bool`	Export resources referenced by content.
from_zms:`bool`	Export shared ZMS product resources.
from_home:`bool`	Export resources from the site root.
Returns
`list`	Paths of exported resources.

def getObjChildrenToXml(self): (source) ¶

Render all filtered child nodes as XML fragments.

Returns
`str`	Serialized XML for child nodes.

Render the current object as its custom XML fragment.

Returns
`str`	Serialized XML fragment.

def manage_export(self, export_format, lang, REQUEST, RESPONSE): (source) ¶

Export the current object in one of the configured formats.

Parameters
export_format:`int` or `str`	Requested export format id.
lang:`str`	Active language.
REQUEST:`ZPublisher.HTTPRequest`	Current request.
RESPONSE:`ZPublisher.HTTPResponse`	Current response.
Returns
`str` or `bytes`	Export payload when downloading directly.

def recurse_downloadHtmlPages(self, obj, path, lang, REQUEST): (source) ¶

Recursively render and store HTML pages for a content subtree.

Parameters
obj:`OFS.SimpleItem.Item`	Root object of the subtree.
path:`str`	Destination directory.
lang:`str`	Active export language.
REQUEST:`ZPublisher.HTTPRequest`	Current request.

def toXhtml(self, REQUEST, deep=True): (source) ¶

Render the current object as localized standalone HTML.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Current request.
deep:`bool`	Include child content recursively.
Returns
`str` or `bytes`	Exportable HTML or XHTML markup.

def toXml(self, REQUEST=None, deep=True, data2hex=False, multilang=True): (source) ¶

Render the current object tree as an XML export document.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Request used to resolve export context.
deep:`bool`	Include child nodes recursively.
data2hex:`bool`	Hex-encode binary data values.
multilang:`bool`	Include all language variants.
Returns
`str`	Serialized XML export.

def toZippedHtml(self, REQUEST, get_data=True): (source) ¶

Build a ZIP archive containing localized HTML export pages.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Current request.
get_data:`bool`	Return archive bytes instead of a file path.
Returns
`str` or `bytes`	ZIP archive payload or path.

def toZippedXml(self, REQUEST, get_data=True): (source) ¶

Build a ZIP archive containing the XML export and resources.

Parameters
REQUEST:`ZPublisher.HTTPRequest`	Current request.
get_data:`bool`	Return archive bytes instead of a file path.
Returns
`str` or `bytes`	ZIP archive payload or path.

Undocumented