PaperHTMLGalley Class Reference
[Paper]

An HTML galley may include an optional stylesheet and set of images. More...

Inheritance diagram for PaperHTMLGalley:

List of all members.

Public Member Functions
	_handleOcsUrl ($matchArray)
	getHTMLContents ()
&	getImageFiles ()
&	getStyleFile ()
	getStyleFileId ()
	isDependentFile ($fileId)
	isHTMLGalley ()
	PaperHTMLGalley ()
	setImageFiles (&$images)
	setStyleFile (&$styleFile)
	setStyleFileId ($styleFileId)

---

Detailed Description

An HTML galley may include an optional stylesheet and set of images.

Definition at line 19 of file PaperHTMLGalley.inc.php.

---

Member Function Documentation

PaperHTMLGalley.getHTMLContents

(

)

Return string containing the contents of the HTML file. This function performs any necessary filtering, like image URL replacement.

Parameters:

$baseImageUrl

string base URL for image references

Returns:

string

Definition at line 42 of file PaperHTMLGalley.inc.php.

References PaperFile.getFileId(), PaperGalley.getGalleyId(), getImageFiles(), PaperFile.getOriginalFileName(), PaperFile.getPaperId(), and Request.url().

& PaperHTMLGalley.getImageFiles

(

)

Return array of image files for this HTML galley.

Returns:

array

Definition at line 235 of file PaperHTMLGalley.inc.php.

Referenced by getHTMLContents().

& PaperHTMLGalley.getStyleFile

(

)

Return the stylesheet file associated with this HTML galley, if applicable.

Returns:

PaperFile

Definition at line 218 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.getStyleFileId

(

)

Get ID of associated stylesheet file, if applicable.

Returns:

int

Definition at line 202 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.isDependentFile

(

$

fileId

)

Check if the specified file is a dependent file.

Parameters:

$fileId

int

Returns:

boolean

Reimplemented from PaperGalley.

Definition at line 186 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.isHTMLGalley

(

)

Check if galley is an HTML galley.

Returns:

boolean

Reimplemented from PaperGalley.

Definition at line 32 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.PaperHTMLGalley

(

)

Constructor.

Definition at line 24 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.setImageFiles

(

&$

images

)

Set array of image files for this HTML galley.

Parameters:

$images

array

Returns:

array

Definition at line 245 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.setStyleFile

(

&$

styleFile

)

Set the stylesheet file for this HTML galley.

Parameters:

PaperFile

$styleFile

Definition at line 227 of file PaperHTMLGalley.inc.php.

PaperHTMLGalley.setStyleFileId

(

$

styleFileId

)

Set ID of associated stylesheet file.

Parameters:

$styleFileId

int

Definition at line 210 of file PaperHTMLGalley.inc.php.

---

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

• classes/paper/PaperHTMLGalley.inc.php

---