ArticleHTMLGalley Class Reference
[Article]

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

Inheritance diagram for ArticleHTMLGalley:

List of all members.

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

---

Detailed Description

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

Definition at line 20 of file ArticleHTMLGalley.inc.php.

---

Member Function Documentation

ArticleHTMLGalley.ArticleHTMLGalley

(

)

Constructor.

Definition at line 25 of file ArticleHTMLGalley.inc.php.

ArticleHTMLGalley.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

Reimplemented in ArticleXMLGalley.

Definition at line 43 of file ArticleHTMLGalley.inc.php.

References ArticleFile.getArticleId(), ArticleGalley.getBestGalleyId(), DAORegistry.getDAO(), ArticleFile.getFileId(), getImageFiles(), Request.getJournal(), ArticleFile.getOriginalFileName(), Request.getRequestUrl(), Request.getSite(), String.regexp_replace_callback(), Locale.translate(), and Request.url().

& ArticleHTMLGalley.getImageFiles

(

)

Return array of image files for this HTML galley.

Returns:

array

Definition at line 243 of file ArticleHTMLGalley.inc.php.

References DataObject.getData().

Referenced by ArticleXMLGalley.getHTMLContents(), getHTMLContents(), isDependentFile(), and ArticleXMLGalley.viewFileContents().

& ArticleHTMLGalley.getStyleFile

(

)

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

Returns:

ArticleFile

Definition at line 226 of file ArticleHTMLGalley.inc.php.

References DataObject.getData().

ArticleHTMLGalley.getStyleFileId

(

)

Get ID of associated stylesheet file, if applicable.

Returns:

int

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

References DataObject.getData().

Referenced by isDependentFile().

ArticleHTMLGalley.isDependentFile

(

$

fileId

)

Check if the specified file is a dependent file.

Parameters:

$fileId

int

Returns:

boolean

Reimplemented from ArticleGalley.

Definition at line 194 of file ArticleHTMLGalley.inc.php.

References ArticleFile.getFileId(), getImageFiles(), and getStyleFileId().

ArticleHTMLGalley.isHTMLGalley

(

)

Check if galley is an HTML galley.

Returns:

boolean

Reimplemented from ArticleGalley.

Reimplemented in ArticleXMLGalley.

Definition at line 33 of file ArticleHTMLGalley.inc.php.

ArticleHTMLGalley.setImageFiles

(

&$

images

)

Set array of image files for this HTML galley.

Parameters:

$images

array

Returns:

array

Definition at line 253 of file ArticleHTMLGalley.inc.php.

References DataObject.setData().

ArticleHTMLGalley.setStyleFile

(

&$

styleFile

)

Set the stylesheet file for this HTML galley.

Parameters:

ArticleFile

$styleFile

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

References DataObject.setData().

ArticleHTMLGalley.setStyleFileId

(

$

styleFileId

)

Set ID of associated stylesheet file.

Parameters:

$styleFileId

int

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

References DataObject.setData().

---

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

• classes/article/ArticleHTMLGalley.inc.php