ArticleXMLGalley Class Reference
[Plugins_generic_xmlGalley]

Article XML galley model object. More...

Inheritance diagram for ArticleXMLGalley:

List of all members.

Public Member Functions
&	_getXSLTCache ($key)
	_xsltCacheMiss (&$cache)
	ArticleXMLGalley ()
	getHTMLContents ()
	isHTMLGalley ()
	transformXSLT ($xmlFile, $xslFile, $xsltType="", $arguments=null)
	viewFileContents ()

---

Detailed Description

Article XML galley model object.

Definition at line 21 of file ArticleXMLGalley.inc.php.

---

Member Function Documentation

& ArticleXMLGalley._getXSLTCache

(

$

key

)

Get results of XSLT transform from file cache

Returns:

cache object

Definition at line 50 of file ArticleXMLGalley.inc.php.

References ArticleFile.getFilePath().

Referenced by getHTMLContents(), and viewFileContents().

ArticleXMLGalley._xsltCacheMiss

(

&$

cache

)

Re-run the XSLT transformation on a stale (or missing) cache

Returns:

boolean

Definition at line 79 of file ArticleXMLGalley.inc.php.

References ArticleFile.getFilePath(), Request.getJournal(), PluginRegistry.getPlugin(), ArticleGalley.isPdfGalley(), and transformXSLT().

ArticleXMLGalley.ArticleXMLGalley

(

)

Constructor.

Definition at line 26 of file ArticleXMLGalley.inc.php.

ArticleXMLGalley.getHTMLContents

(

)

Return string containing an XHTML fragment generated from the XML/XSL source This function performs any necessary filtering, like image URL replacement.

Parameters:

$baseImageUrl

string base URL for image references

Returns:

string

Reimplemented from ArticleHTMLGalley.

Definition at line 124 of file ArticleXMLGalley.inc.php.

References _getXSLTCache(), ArticleFile.getArticleId(), ArticleGalley.getBestGalleyId(), DAORegistry.getDAO(), ArticleFile.getFileId(), ArticleFile.getFileName(), ArticleGalley.getGalleyId(), ArticleHTMLGalley.getImageFiles(), Request.getJournal(), ArticleFile.getOriginalFileName(), PluginRegistry.getPlugin(), String.regexp_replace_callback(), Request.url(), and String.utf2html().

ArticleXMLGalley.isHTMLGalley

(

)

Check if galley is an HTML galley.

Returns:

boolean

Reimplemented from ArticleHTMLGalley.

Definition at line 34 of file ArticleXMLGalley.inc.php.

References ArticleFile.getFileType().

ArticleXMLGalley.transformXSLT	(	$	xmlFile,
		$	xslFile,
		$	xsltType = "",
		$	arguments = null
	)

Return string containing the transformed XML output. This function applies an XSLT transform to a given XML source.

Parameters:

	$xmlFile	pathname to the XML source file (absolute)
	$xslFile	pathname to the XSL stylesheet (absolute)
	(optional)	$xsltType type of XSLT renderer to use (PHP4, PHP5, or XSLT shell command)
	(optional)	$arguments array of param-value pairs to pass to the XSLT

Returns:

string

Definition at line 284 of file ArticleXMLGalley.inc.php.

References FileManager.fileExists().

Referenced by _xsltCacheMiss().

ArticleXMLGalley.viewFileContents

(

)

Output PDF generated from the XML/XSL/FO source to browser This function performs any necessary filtering, like image URL replacement.

Returns:

string

Definition at line 191 of file ArticleXMLGalley.inc.php.

References _getXSLTCache(), FileManager.deleteFile(), FileManager.fileExists(), ArticleFile.getArticleId(), DAORegistry.getDAO(), ArticleFile.getFileName(), ArticleFile.getFilePath(), ArticleFile.getFileType(), ArticleGalley.getGalleyId(), ArticleHTMLGalley.getImageFiles(), Request.getJournal(), ArticleFile.getOriginalFileName(), PluginRegistry.getPlugin(), FileManager.parseFileExtension(), Request.url(), and FileManager.viewFile().

---

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

• plugins/generic/xmlGalley/ArticleXMLGalley.inc.php