Public Member Functions

ArtworkFile Class Reference
[Monograph]

Artwork file class. More...

Inheritance diagram for ArtworkFile:
MonographFile

List of all members.

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)

Detailed Description

Artwork file class.

See also:
SubmissionFileDAO

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

Member Function Documentation

ArtworkFile.ArtworkFile (  ) 

Constructor

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

References MonographFile.MonographFile().

ArtworkFile.copyEditableMetadataFrom ( $  monographFile  ) 

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

Parameters:
$monographFile MonographFile

Reimplemented from MonographFile.

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

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

ArtworkFile.getCaption (  ) 

Get artwork caption.

Returns:
string

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

ArtworkFile.getChapterId (  ) 

Get the monograph component id.

Returns:
int

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

ArtworkFile.getContactAuthor (  ) 

Get the contact author's id.

Returns:
int

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

ArtworkFile.getCopyrightOwner (  ) 

Get the copyright owner.

Returns:
string

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

ArtworkFile.getCopyrightOwnerContactDetails (  ) 

Get contact details for the copyright owner.

Returns:
string

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

ArtworkFile.getCredit (  ) 

Get the credit.

Returns:
string

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

ArtworkFile.getHeight (  ) 

Get the height of the image in pixels.

Returns:
integer

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

References MonographFile.getFilePath().

ArtworkFile.getPermissionFileId (  ) 

Get the permission form file id.

Returns:
int

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

ArtworkFile.getPermissionTerms (  ) 

Get the permission terms.

Returns:
string

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

ArtworkFile.getWidth (  ) 

Get the width of the image in pixels.

Returns:
integer

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

References MonographFile.getFilePath().

ArtworkFile.setCaption ( $  caption  ) 

Set artwork caption.

Parameters:
$caption string

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

Referenced by copyEditableMetadataFrom().

ArtworkFile.setChapterId ( $  chapterId  ) 

Set the monograph chapter id.

Parameters:
$chapterId int

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

ArtworkFile.setContactAuthor ( $  authorId  ) 

Set the contact author's id.

Parameters:
$authorId int

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

ArtworkFile.setCopyrightOwner ( $  owner  ) 

Set the copyright owner.

Parameters:
$owner string

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

Referenced by copyEditableMetadataFrom().

ArtworkFile.setCopyrightOwnerContactDetails ( $  contactDetails  ) 

Set the contact details for the copyright owner.

Parameters:
$contactDetails string

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

Referenced by copyEditableMetadataFrom().

ArtworkFile.setCredit ( $  credit  ) 

Set the credit.

Parameters:
$credit string

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

Referenced by copyEditableMetadataFrom().

ArtworkFile.setPermissionFileId ( $  fileId  ) 

Set the permission form file id.

Parameters:
$fileId int

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

ArtworkFile.setPermissionTerms ( $  terms  ) 

Set the permission terms.

Parameters:
$terms string

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

Referenced by copyEditableMetadataFrom().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:56 for Open Monograph Press by  doxygen 1.7.1