Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
ArtworkFile Class Reference
Inheritance diagram for ArtworkFile:
MonographFile SubmissionFile PKPFile DataObject

Public Member Functions

 ArtworkFile ()
 
 copyEditableMetadataFrom ($monographFile)
 
 getCaption ()
 
 getChapterId ()
 
 getContactAuthor ()
 
 getCopyrightOwner ()
 
 getCopyrightOwnerContactDetails ()
 
 getCredit ()
 
 getHeight ()
 
 getPermissionFileId ()
 
 getPermissionTerms ()
 
 getWidth ()
 
 setCaption ($caption)
 
 setChapterId ($chapterId)
 
 setContactAuthor ($authorId)
 
 setCopyrightOwner ($owner)
 
 setCopyrightOwnerContactDetails ($contactDetails)
 
 setCredit ($credit)
 
 setPermissionFileId ($fileId)
 
 setPermissionTerms ($terms)
 
- Public Member Functions inherited from MonographFile
 getMonographId ()
 
 MonographFile ()
 
 setMonographId ($monographId)
 
- Public Member Functions inherited from SubmissionFile
 _fileStageToPath ($fileStage)
 
 _generateFileName ()
 
 copyEditableMetadataFrom ($submissionFile)
 
 getAssocId ()
 
 getAssocType ()
 
 getClientFileName ()
 
 getDateModified ()
 
 getDirectSalesPrice ()
 
 getDocumentType ()
 
 getExtension ()
 
 getFileId ()
 
 getFileIdAndRevision ()
 
 getFileLabel ($locale=null)
 
 getFilePath ()
 
 getFileStage ()
 
 getGenreId ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getRevision ()
 
 getRound ()
 
 getSalesType ()
 
 getServerFileName ()
 
 getSourceFileId ()
 
 getSourceRevision ()
 
 getSubmissionId ()
 
 getType ()
 
 getUploaderUserId ()
 
 getUserGroupId ()
 
 getViewable ()
 
 getViews ()
 
 isInlineable ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setDateModified ($dateModified)
 
 setDirectSalesPrice ($directSalesPrice)
 
 setFileId ($fileId)
 
 setFileStage ($fileStage)
 
 setGenreId ($genreId)
 
 setName ($name, $locale)
 
 setRevision ($revision)
 
 setRound ($round)
 
 setSalesType ($salesType)
 
 setServerFileName ($fileName)
 
 setSourceFileId ($sourceFileId)
 
 setSourceRevision ($sourceRevision)
 
 setSubmissionId ($submissionId)
 
 setType ($type)
 
 setUploaderUserId ($uploaderUserId)
 
 setUserGroupId ($userGroupId)
 
 setViewable ($viewable)
 
 SubmissionFile ()
 
- Public Member Functions inherited from PKPFile
 getDateUploaded ()
 
 getFileId ()
 
 getFilePath ()
 
 getFileSize ()
 
 getFileType ()
 
 getNiceFileSize ()
 
 getOriginalFileName ()
 
 getServerFileName ()
 
 PKPFile ()
 
 setDateUploaded ($dateUploaded)
 
 setFileId ($fileId)
 
 setFileSize ($fileSize)
 
 setFileType ($fileType)
 
 setOriginalFileName ($originalFileName)
 
 setServerFileName ($fileName)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 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)
 

Public Attributes

 $_imageInfo
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Artwork file class.

See Also
SubmissionFileDAO

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

Member Function Documentation

ArtworkFile::ArtworkFile ( )

Constructor

Definition at line 29 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::copyEditableMetadataFrom (   $monographFile)

Copy the user-facing (editable) metadata from another monograph file.

Parameters
$monographFileMonographFile

Definition at line 193 of file ArtworkFile.inc.php.

ArtworkFile::getCaption ( )

Get artwork caption.

Returns
string

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

References DataObject\setData().

ArtworkFile::getChapterId ( )

Get the monograph component id.

Returns
int

Definition at line 137 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getContactAuthor ( )

Get the contact author's id.

Returns
int

Definition at line 153 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getCopyrightOwner ( )

Get the copyright owner.

Returns
string

Definition at line 73 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getCopyrightOwnerContactDetails ( )

Get contact details for the copyright owner.

Returns
string

Definition at line 89 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getCredit ( )

Get the credit.

Returns
string

Definition at line 57 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getHeight ( )

Get the height of the image in pixels.

Returns
integer

Definition at line 180 of file ArtworkFile.inc.php.

ArtworkFile::getPermissionFileId ( )

Get the permission form file id.

Returns
int

Definition at line 121 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getPermissionTerms ( )

Get the permission terms.

Returns
string

Definition at line 105 of file ArtworkFile.inc.php.

References DataObject\setData().

ArtworkFile::getWidth ( )

Get the width of the image in pixels.

Returns
integer

Definition at line 169 of file ArtworkFile.inc.php.

ArtworkFile::setCaption (   $caption)

Set artwork caption.

Parameters
$captionstring

Definition at line 49 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setChapterId (   $chapterId)

Set the monograph chapter id.

Parameters
$chapterIdint

Definition at line 145 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setContactAuthor (   $authorId)

Set the contact author's id.

Parameters
$authorIdint

Definition at line 161 of file ArtworkFile.inc.php.

References SubmissionFile\getFilePath().

ArtworkFile::setCopyrightOwner (   $owner)

Set the copyright owner.

Parameters
$ownerstring

Definition at line 81 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setCopyrightOwnerContactDetails (   $contactDetails)

Set the contact details for the copyright owner.

Parameters
$contactDetailsstring

Definition at line 97 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setCredit (   $credit)

Set the credit.

Parameters
$creditstring

Definition at line 65 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setPermissionFileId (   $fileId)

Set the permission form file id.

Parameters
$fileIdint

Definition at line 129 of file ArtworkFile.inc.php.

References DataObject\getData().

ArtworkFile::setPermissionTerms (   $terms)

Set the permission terms.

Parameters
$termsstring

Definition at line 113 of file ArtworkFile.inc.php.

References DataObject\getData().

Member Data Documentation

array ArtworkFile::$_imageInfo

image file information

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


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