DocImportPlaintext class - Documentation for SproutCMS

Info Page:

Page options:

class DocImportPlaintext

Name	Visibility	Description
getHeadingsTree	public (static)	For a given XML document, return a tree of headings
getHtml	public (static)	For a given XML doc file, return the HTML version.
getResources	public (static)	For a given XML doc file, return an array of resources, in name => data format.
instance	public (static)	Return a `DocImport` object instance for converting a file with a given original name
load	public	The main load function for a document.

Treenode DocImport::getHeadingsTree ( string $filename , int $max_depth [, bool $include_body ] );

For a given XML document, return a tree of headings

Any heading level past the max_depth option is treated like body text.

string DocImport::getHtml ( string $filename , array $images , array $headings );

For a given XML doc file, return the HTML version.

array DocImport::getResources ( string $filename );

For a given XML doc file, return an array of resources, in name => data format.

unknown DocImport::instance ( mixed $orig_filename );

Return a `DocImport` object instance for converting a file with a given original name
Throws an exception on error

string|DOMDocument $DocImportPlaintext->load ( string $filename );

The main load function for a document.
Throw an exception on error.