Public Member Functions

MonographFile Class Reference
[Monograph]

Monograph file class. More...

Inheritance diagram for MonographFile:
ArtworkFile

List of all members.

Public Member Functions

 _fileStageToPath ($fileStage)
 _generateFileName ()
 copyEditableMetadataFrom ($monographFile)
 getAssocId ()
 getAssocType ()
 getDirectSalesPrice ()
 getDocumentType ()
 getExtension ()
 getFileLabel ($locale=null)
 getFileName ()
 getFilePath ()
 getGenreId ()
 getLocalizedName ()
 getMonographId ()
 getName ($locale)
 getUploaderUserId ()
 getUserGroupId ()
 MonographFile ()
 setAssocId ($assocId)
 setAssocType ($assocType)
 setDirectSalesPrice ($directSalesPrice)
 setFileName ($fileName)
 setGenreId ($genreId)
 setMonographId ($monographId)
 setName ($name, $locale)
 setUploaderUserId ($uploaderUserId)
 setUserGroupId ($userGroupId)

Detailed Description

Monograph file class.

See also:
SubmissionFileDAO

Definition at line 38 of file MonographFile.inc.php.

Member Function Documentation

MonographFile._fileStageToPath ( $  fileStage  ) 

Return path associated with a file stage code.

Parameters:
$fileStage string
Returns:
string

Definition at line 296 of file MonographFile.inc.php.

Referenced by getFilePath().

MonographFile._generateFileName (  ) 

Generate the unique filename for this monograph file.

Returns:
string

Definition at line 323 of file MonographFile.inc.php.

References getExtension(), getGenreId(), and getMonographId().

Referenced by getFileName().

MonographFile.copyEditableMetadataFrom ( $  monographFile  ) 

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

Parameters:
$monographFile MonographFile

Reimplemented in ArtworkFile.

Definition at line 237 of file MonographFile.inc.php.

References setName().

MonographFile.getAssocId (  ) 

Get id that is associated with this file.

Returns:
int

Definition at line 103 of file MonographFile.inc.php.

MonographFile.getAssocType (  ) 

Get type that is associated with this file.

Returns:
int

Definition at line 87 of file MonographFile.inc.php.

MonographFile.getDirectSalesPrice (  ) 

Get price of monograph file.

Returns:
numeric

Definition at line 135 of file MonographFile.inc.php.

MonographFile.getDocumentType (  ) 

Get the file's document type (enumerated types)

Returns:
string

Definition at line 187 of file MonographFile.inc.php.

MonographFile.getExtension (  ) 

Get the file's extension.

Returns:
string

Definition at line 177 of file MonographFile.inc.php.

Referenced by _generateFileName().

MonographFile.getFileLabel ( $  locale = null  ) 

Build a file name label.

Returns:
string

Definition at line 215 of file MonographFile.inc.php.

References getLocalizedName(), and getName().

MonographFile.getFileName (  ) 
See also:
PKPFile.getFileName() Generate the file name from identification data rather than retrieving it from the database.

Definition at line 250 of file MonographFile.inc.php.

References _generateFileName().

Referenced by getFilePath().

MonographFile.getFilePath (  ) 
See also:
SubmissionFile.getFilePath()

Definition at line 273 of file MonographFile.inc.php.

References _fileStageToPath(), getFileName(), and getMonographId().

Referenced by ArtworkFile.getHeight(), and ArtworkFile.getWidth().

MonographFile.getGenreId (  ) 

Get the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table

Returns:
int

Definition at line 207 of file MonographFile.inc.php.

Referenced by _generateFileName().

MonographFile.getLocalizedName (  ) 

Get the localized name of the file

Returns:
string

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

Referenced by getFileLabel().

MonographFile.getMonographId (  ) 

Get ID of monograph.

Returns:
int

Definition at line 119 of file MonographFile.inc.php.

Referenced by _generateFileName(), and getFilePath().

MonographFile.getName ( $  locale  ) 

Get the name of the file

Parameters:
$locale string
Returns:
string

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

Referenced by getFileLabel().

MonographFile.getUploaderUserId (  ) 

Get the uploader's user id.

Returns:
integer

Definition at line 63 of file MonographFile.inc.php.

MonographFile.getUserGroupId (  ) 

Get the uploader's user group id

Returns:
int

Definition at line 79 of file MonographFile.inc.php.

MonographFile.MonographFile (  ) 

Constructor.

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

Referenced by ArtworkFile.ArtworkFile().

MonographFile.setAssocId ( $  assocId  ) 

Set id that is associated with this file.

Parameters:
$assocId int

Definition at line 111 of file MonographFile.inc.php.

MonographFile.setAssocType ( $  assocType  ) 

Set type that is associated with this file.

Parameters:
$assocType int

Definition at line 95 of file MonographFile.inc.php.

MonographFile.setDirectSalesPrice ( $  directSalesPrice  ) 

Set direct sales price.

Parameters:
$directSalesPrice numeric

Definition at line 143 of file MonographFile.inc.php.

MonographFile.setFileName ( $  fileName  ) 
See also:
PKPFile.setFileName() Do not allow setting the file name of a Monograph file directly because it is generated from identification data.

Definition at line 261 of file MonographFile.inc.php.

MonographFile.setGenreId ( $  genreId  ) 

Set the genre id of this file (i.e. referring to Manuscript, Index, etc) Foreign key into genres table

Parameters:
$genreId int

Definition at line 198 of file MonographFile.inc.php.

MonographFile.setMonographId ( $  monographId  ) 

Set ID of monograph.

Parameters:
$monographId int

Definition at line 127 of file MonographFile.inc.php.

MonographFile.setName ( $  name,
$  locale 
)

Set the name of the file

Parameters:
$name string
$locale string

Definition at line 152 of file MonographFile.inc.php.

Referenced by copyEditableMetadataFrom().

MonographFile.setUploaderUserId ( $  uploaderUserId  ) 

Set the uploader's user id.

Parameters:
$uploaderUserId integer

Definition at line 55 of file MonographFile.inc.php.

MonographFile.setUserGroupId ( $  userGroupId  ) 

Set the uploader's user group id

Parameters:
$userGroupId int

Definition at line 71 of file MonographFile.inc.php.

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