DocImport class - Documentation for SproutCMS

Info Page:

Page options:

class DocImport

Abstract class with additional stuff for the document importer system

The document importer loads docuemnts and returns XML files
These files can then be processed by other parts of the CMS.
The term "xmldoc" is referring to the intermediate XML file produced by the
import libraries

File: /sprout/Helpers/DocImport/DocImport.php
Namespace: Sprout\Helpers\DocImport
This class is abstract

Functions

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.

public getHeadingsTree

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.

public getHtml

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

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

public getResources

array DocImport::getResources ( string $filename );

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

public instance

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

public load

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

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

SproutCMS