Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ArticleHTMLGalley Class Reference
Inheritance diagram for ArticleHTMLGalley:
ArticleGalley ArticleFile SubmissionFile PKPFile DataObject ArticleXMLGalley

Public Member Functions

 ArticleHTMLGalley ()
 
 getHTMLContents ()
 
getImageFiles ()
 
getStyleFile ()
 
 getStyleFileId ()
 
 isDependentFile ($fileId)
 
 isHTMLGalley ()
 
 setImageFiles (&$images)
 
 setStyleFile (&$styleFile)
 
 setStyleFileId ($styleFileId)
 
- Public Member Functions inherited from ArticleGalley
 ArticleGalley ()
 
 getBestGalleyId (&$journal=null)
 
 getGalleyId ()
 
 getGalleyLabel ()
 
 getLabel ()
 
 getLocale ()
 
 getRemoteURL ()
 
 getSequence ()
 
 getViews ()
 
 isDependentFile ($fileId)
 
 isHTMLGalley ()
 
 isPdfGalley ()
 
 setGalleyId ($galleyId)
 
 setLabel ($label)
 
 setLocale ($locale)
 
 setRemoteURL ($remoteURL)
 
 setSequence ($sequence)
 
- Public Member Functions inherited from ArticleFile
 ArticleFile ()
 
 getArticleId ()
 
 getFilePath ()
 
 getStoredPubId ($pubIdType)
 
 isInlineable ()
 
 setArticleId ($articleId)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from SubmissionFile
 getAssocId ()
 
 getDateModified ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileStage ()
 
 getRevision ()
 
 getRound ()
 
 getSourceFileId ()
 
 getSourceRevision ()
 
 getSubmissionId ()
 
 getType ()
 
 getViewable ()
 
 isInlineable ()
 
 setAssocId ($assocId)
 
 setDateModified ($dateModified)
 
 setFileId ($fileId)
 
 setFileStage ($fileStage)
 
 setRevision ($revision)
 
 setRound ($round)
 
 setSourceFileId ($sourceFileId)
 
 setSourceRevision ($sourceRevision)
 
 setSubmissionId ($submissionId)
 
 setType ($type)
 
 setViewable ($viewable)
 
 SubmissionFile ()
 
- Public Member Functions inherited from PKPFile
 getDateUploaded ()
 
 getFileId ()
 
 getFileName ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 PKPFile ()
 
 setDateUploaded ($dateUploaded)
 
 setFileId ($fileId)
 
 setFileName ($fileName)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

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

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

Member Function Documentation

ArticleHTMLGalley::ArticleHTMLGalley ( )

Constructor.

Definition at line 23 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
$baseImageUrlstring base URL for image references
Returns
string

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

References ArticleFile\getArticleId(), ArticleGalley\getBestGalleyId(), DAORegistry\getDAO(), SubmissionFile\getFileId(), getImageFiles(), Request\getJournal(), PKPRequest\getRequestUrl(), PKPRequest\getSite(), and Request\url().

& ArticleHTMLGalley::getImageFiles ( )

Return array of image files for this HTML galley.

Returns
array

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

References DataObject\getData().

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

& ArticleHTMLGalley::getStyleFile ( )

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

Returns
ArticleFile

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

References DataObject\getData().

ArticleHTMLGalley::getStyleFileId ( )

Get ID of associated stylesheet file, if applicable.

Returns
int

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

References DataObject\getData().

Referenced by isDependentFile().

ArticleHTMLGalley::isDependentFile (   $fileId)

Check if the specified file is a dependent file.

Parameters
$fileIdint
Returns
boolean

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

References getImageFiles(), and getStyleFileId().

ArticleHTMLGalley::isHTMLGalley ( )

Check if galley is an HTML galley.

Returns
boolean

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

ArticleHTMLGalley::setImageFiles ( $images)

Set array of image files for this HTML galley.

Parameters
$imagesarray
Returns
array

Definition at line 251 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 233 of file ArticleHTMLGalley.inc.php.

References DataObject\setData().

ArticleHTMLGalley::setStyleFileId (   $styleFileId)

Set ID of associated stylesheet file.

Parameters
$styleFileIdint

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

References DataObject\setData().


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