Inheritance diagram for SubmissionArtworkFile:

Public Member Functions
	copyEditableMetadataFrom ($submissionFile)

	getCaption ()

	getContactAuthor ()

	getCopyrightOwner ()

	getCopyrightOwnerContactDetails ()

	getCredit ()

	getHeight ()

	getMetadataForm ($stageId, $reviewRound)

	getPermissionFileId ()

	getPermissionTerms ()

	getPhysicalHeight ($dpi)

	getPhysicalWidth ($dpi)

	getWidth ()

	setCaption ($caption)

	setContactAuthor ($authorId)

	setCopyrightOwner ($owner)

	setCopyrightOwnerContactDetails ($contactDetails)

	setCredit ($credit)

	setPermissionFileId ($fileId)

	setPermissionTerms ($terms)

Public Member Functions inherited from SubmissionFile
	_fileStageToPath ($fileStage)

	_generateFileName ()

	_generateName ($anonymous=false)

	getAssocId ()

	getAssocType ()

	getBestId ()

	getChapterId ()

	getClientFileName ()

	getDAO ()

	getDateModified ()

	getDirectSalesPrice ()

	getDocumentType ()

	getExtension ()

	getFileId ()

	getFileIdAndRevision ()

	getFileLabel ($locale=null)

	getFilePath ()

	getFileStage ()

	getGenreId ()

	getId ()

&	getLocalizedData ($key, $preferredLocale=null)

	getLocalizedName ()

	getName ($locale)

	getRevision ()

	getRound ()

	getSalesType ()

	getServerFileName ()

	getSourceFileId ()

	getSourceRevision ()

	getStoredPubId ($pubIdType)

	getSubmissionId ()

	getSubmissionLocale ()

	getUploaderUserId ()

	getViewable ()

	getViews ()

	setAssocId ($assocId)

	setAssocType ($assocType)

	setChapterId ($chapterId)

	setDateModified ($dateModified)

	setDirectSalesPrice ($directSalesPrice)

	setFileId ($fileId)

	setFileStage ($fileStage)

	setGenreId ($genreId)

	setId ($fileId)

	setName ($name, $locale)

	setRevision ($revision)

	setRound ($round)

	setSalesType ($salesType)

	setServerFileName ($fileName)

	setSourceFileId ($sourceFileId)

	setSourceRevision ($sourceRevision)

	setStoredPubId ($pubIdType, $pubId)

	setSubmissionId ($submissionId)

	setSubmissionLocale ($submissionLocale)

	setUploaderUserId ($uploaderUserId)

	setViewable ($viewable)

	supportsDependentFiles ()

Public Member Functions inherited from PKPFile
	getDateUploaded ()

	getFileSize ()

	getFileType ()

	getNiceFileSize ()

	getOriginalFileName ()

	setDateUploaded ($dateUploaded)

	setFileSize ($fileSize)

	setFileType ($fileType)

	setOriginalFileName ($originalFileName)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getLocaleMetadataFieldNames ()

	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)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Data Fields
	$_imageInfo

Data Fields 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 SubmissionArtworkFile.inc.php.

Member Function Documentation

◆ copyEditableMetadataFrom()

SubmissionArtworkFile::copyEditableMetadataFrom ( $submissionFile )

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

Parameters

$submissionFile SubmissionFile

Reimplemented from SubmissionFile.

Definition at line 205 of file SubmissionArtworkFile.inc.php.

References setCaption(), setCopyrightOwner(), setCopyrightOwnerContactDetails(), setCredit(), and setPermissionTerms().

◆ getCaption()

SubmissionArtworkFile::getCaption ( )

Get artwork caption.

Returns: string

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

References DataObject\getData().

◆ getContactAuthor()

SubmissionArtworkFile::getContactAuthor ( )

Get the contact author's id.

Returns: int

Definition at line 130 of file SubmissionArtworkFile.inc.php.

References DataObject\getData().

◆ getCopyrightOwner()

SubmissionArtworkFile::getCopyrightOwner ( )

Get the copyright owner.

Returns: string

Definition at line 66 of file SubmissionArtworkFile.inc.php.

References DataObject\getData().

◆ getCopyrightOwnerContactDetails()

SubmissionArtworkFile::getCopyrightOwnerContactDetails ( )

Get contact details for the copyright owner.

Returns: string

Definition at line 82 of file SubmissionArtworkFile.inc.php.

References DataObject\getData().

◆ getCredit()

SubmissionArtworkFile::getCredit ( )

Get the credit.

Returns: string

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

References DataObject\getData().

◆ getHeight()

SubmissionArtworkFile::getHeight ( )

Get the height of the image in pixels.

Returns: integer

Definition at line 157 of file SubmissionArtworkFile.inc.php.

References SubmissionFile\getFilePath().

◆ getMetadataForm()

SubmissionArtworkFile::getMetadataForm	(	$stageId,
		$reviewRound
	)

Get the metadata form for this submission file.

Parameters

$stageId	int FILE_STAGE_...
$reviewRound	ReviewRound

Returns: Form

Reimplemented from SubmissionFile.

Definition at line 220 of file SubmissionArtworkFile.inc.php.

◆ getPermissionFileId()

SubmissionArtworkFile::getPermissionFileId ( )

Get the permission form file id.

Returns: int

Definition at line 114 of file SubmissionArtworkFile.inc.php.

References DataObject\getData().

◆ getPermissionTerms()

SubmissionArtworkFile::getPermissionTerms ( )

Get the permission terms.

Returns: string

Definition at line 98 of file SubmissionArtworkFile.inc.php.

References DataObject\getData().

◆ getPhysicalHeight()

SubmissionArtworkFile::getPhysicalHeight ( $dpi )

Get the physical height of an image when printed

See also: self::getPhysicalWidth

Parameters

$dpi	int Dots (or pixels) per inch (or any other unit of measurement).

Returns: integer

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

◆ getPhysicalWidth()

SubmissionArtworkFile::getPhysicalWidth ( $dpi )

Get the physical width of an image when printed

Common use is to print at 300 DPI (dots per inch), but you can pass any any pixel density to this function to return it's printed width. For instance, a 300 DPI is roughly equal to 118 dpcm (dots per centimeter), so you'd pass $dpi = 118 to calculate the width in centimeters.

Parameters