Public Member Functions

Monograph Class Reference
[Monograph]

Class for a Monograph. More...

Inheritance diagram for Monograph:
PublishedMonograph ReviewerSubmission SeriesEditorSubmission

List of all members.

Public Member Functions

 getAssocType ()
 getCommentsToEditor ()
 getCopyrightNotice ($locale)
 getDatePublished ()
 getHideAuthor ()
 getLocalizedFullTitle ()
 getLocalizedSubtitle ()
 getLocalizedSupportingAgencies ()
 getPressId ()
 getSeriesAbbrev ()
 getSeriesId ()
 getSeriesPosition ()
 getSeriesTitle ()
 getStageId ()
 getSubtitle ($locale)
 getSupportingAgencies ($locale)
 getWorkType ()
 isMetadataApproved ()
 Monograph ()
 setCommentsToEditor ($commentsToEditor)
 setCopyrightNotice ($copyrightNotice, $locale)
 setDatePublished ($datePublished)
 setHideAuthor ($hideAuthor)
 setPressId ($pressId)
 setSeriesAbbrev ($abbrev)
 setSeriesId ($id)
 setSeriesPosition ($seriesPosition)
 setSeriesTitle ($title)
 setStageId ($stageId)
 setSubtitle ($subtitle, $locale)
 setSupportingAgencies ($title, $locale)
 setWorkType ($workType)

Detailed Description

Class for a Monograph.

See also:
MonographDAO

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

Member Function Documentation

Monograph.getAssocType (  ) 
See also:
Submission.getAssocType()

Definition at line 54 of file Monograph.inc.php.

Monograph.getCommentsToEditor (  ) 

Get comments to editor.

Returns:
string

Definition at line 142 of file Monograph.inc.php.

Monograph.getCopyrightNotice ( $  locale  ) 

Get the copyright notice for a given locale

Parameters:
string $locale
Returns:
string

Definition at line 159 of file Monograph.inc.php.

Monograph.getDatePublished (  ) 

Get date published.

Returns:
date

Definition at line 300 of file Monograph.inc.php.

Referenced by isMetadataApproved().

Monograph.getHideAuthor (  ) 

Return boolean indicating if author should be hidden in contributor statement.

Returns:
boolean

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

Monograph.getLocalizedFullTitle (  ) 

Get the monograph full title (with prefix, title and subtitle).

Returns:
string

Definition at line 229 of file Monograph.inc.php.

References getLocalizedSubtitle().

Monograph.getLocalizedSubtitle (  ) 

Get the localized version of the subtitle

Returns:
string

Definition at line 248 of file Monograph.inc.php.

Referenced by getLocalizedFullTitle().

Monograph.getLocalizedSupportingAgencies (  ) 

Get localized supporting agencies array.

Returns:
array

Definition at line 274 of file Monograph.inc.php.

Monograph.getPressId (  ) 

get press id

Returns:
int

Definition at line 62 of file Monograph.inc.php.

Referenced by PublishedMonograph.getCategories().

Monograph.getSeriesAbbrev (  ) 

Get the series's abbreviated identifier.

Returns:
string

Definition at line 110 of file Monograph.inc.php.

Monograph.getSeriesId (  ) 

Get the series id.

Returns:
int

Definition at line 78 of file Monograph.inc.php.

Monograph.getSeriesPosition (  ) 

Get the position of this monograph within a series.

Returns:
string

Definition at line 126 of file Monograph.inc.php.

Monograph.getSeriesTitle (  ) 

Get the series's title.

Returns:
string

Definition at line 94 of file Monograph.inc.php.

Monograph.getStageId (  ) 

Get the monograph's current publication stage ID

Returns:
int

Reimplemented in ReviewerSubmission.

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

Referenced by SeriesEditorSubmission.getSubmissionStatus().

Monograph.getSubtitle ( $  locale  ) 

Get the subtitle for a given locale

Parameters:
string $locale
Returns:
string

Definition at line 257 of file Monograph.inc.php.

Monograph.getSupportingAgencies ( $  locale  ) 

Get supporting agencies.

Parameters:
$locale 
Returns:
array

Definition at line 283 of file Monograph.inc.php.

Monograph.getWorkType (  ) 

Get the work type (constant in WORK_TYPE_...)

Returns:
int

Definition at line 212 of file Monograph.inc.php.

Monograph.isMetadataApproved (  ) 

Get whether or not this monograph has metadata approved to be available in catalog.

Returns:
boolean;

Definition at line 318 of file Monograph.inc.php.

References getDatePublished().

Referenced by PublishedMonograph.isAvailable().

Monograph.Monograph (  ) 

get monograph id

Returns:
int Constructor.

Definition at line 44 of file Monograph.inc.php.

Referenced by PublishedMonograph.PublishedMonograph(), ReviewerSubmission.ReviewerSubmission(), and SeriesEditorSubmission.SeriesEditorSubmission().

Monograph.setCommentsToEditor ( $  commentsToEditor  ) 

Set comments to editor.

Parameters:
$commentsToEditor string

Definition at line 150 of file Monograph.inc.php.

Monograph.setCopyrightNotice ( $  copyrightNotice,
$  locale 
)

Set the copyright notice for a locale

Parameters:
string $copyrightNotice
string $locale

Definition at line 168 of file Monograph.inc.php.

Monograph.setDatePublished ( $  datePublished  ) 

Set date published.

Parameters:
$datePublished date

Definition at line 309 of file Monograph.inc.php.

Monograph.setHideAuthor ( $  hideAuthor  ) 

Set if author should be hidden in the contributor statement.

Parameters:
$hideAuthor boolean

Definition at line 184 of file Monograph.inc.php.

Monograph.setPressId ( $  pressId  ) 

set press id

Parameters:
$pressId int

Definition at line 70 of file Monograph.inc.php.

Monograph.setSeriesAbbrev ( $  abbrev  ) 

Set the series's abbreviated identifier.

Parameters:
$abbrev string

Definition at line 118 of file Monograph.inc.php.

Monograph.setSeriesId ( $  id  ) 

Set the series id.

Parameters:
$id int

Definition at line 86 of file Monograph.inc.php.

Monograph.setSeriesPosition ( $  seriesPosition  ) 

Set the series position for this monograph.

Parameters:
$seriesPosition string

Definition at line 134 of file Monograph.inc.php.

Monograph.setSeriesTitle ( $  title  ) 

Set the series title.

Parameters:
$title string

Definition at line 102 of file Monograph.inc.php.

Monograph.setStageId ( $  stageId  ) 

Set the monograph's current publication stage ID

Parameters:
$stageId int

Reimplemented in ReviewerSubmission.

Definition at line 200 of file Monograph.inc.php.

Monograph.setSubtitle ( $  subtitle,
$  locale 
)

Set the subtitle for a locale

Parameters:
string $subtitle
string $locale

Definition at line 266 of file Monograph.inc.php.

Monograph.setSupportingAgencies ( $  title,
$  locale 
)

Set supporting agencies.

Parameters:
$supportingAgencies array
$locale 

Definition at line 292 of file Monograph.inc.php.

Monograph.setWorkType ( $  workType  ) 

Set the work type (constant in WORK_TYPE_...)

Parameters:
$workType int

Definition at line 220 of file Monograph.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