Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Monograph Class Reference
Inheritance diagram for Monograph:
Submission DataObject PublishedMonograph ReviewerSubmission SeriesEditorSubmission

Public Member Functions

 getLocalizedSupportingAgencies ()
 
 getPressId ()
 
 getSectionId ()
 
 getSeriesAbbrev ()
 
 getSeriesId ()
 
 getSeriesPosition ()
 
 getSeriesTitle ()
 
 getSupportingAgencies ($locale)
 
 getWorkType ()
 
 isMetadataApproved ()
 
 Monograph ()
 
 setPressId ($pressId)
 
 setSeriesAbbrev ($abbrev)
 
 setSeriesId ($id)
 
 setSeriesPosition ($seriesPosition)
 
 setSeriesTitle ($title)
 
 setSupportingAgencies ($title, $locale)
 
 setWorkType ($workType)
 
- Public Member Functions inherited from Submission
 getAbstract ($locale)
 
 getAuthorEmails ()
 
 getAuthors ()
 
 getAuthorString ($lastOnly=false, $nameSeparator= ', ', $userGroupSeparator= '; ')
 
 getCitations ()
 
 getCommentsStatus ()
 
 getCommentsToEditor ()
 
 getContextId ()
 
 getCopyrightNotice ($locale)
 
 getCoverageChron ($locale)
 
 getCoverageGeo ($locale)
 
 getCoverageSample ($locale)
 
 getCoverPageAltText ($locale)
 
 getDatePublished ()
 
 getDateStatusModified ()
 
 getDateSubmitted ()
 
 getDiscipline ($locale)
 
 getFileName ($locale)
 
 getFirstAuthor ($lastOnly=false)
 
 getHeight ($locale)
 
 getHideAuthor ()
 
 getHideCoverPageAbstract ($locale)
 
 getHideCoverPageToc ($locale)
 
 getLanguage ()
 
 getLastModified ()
 
 getLocale ()
 
 getLocalizedAbstract ()
 
 getLocalizedCoverageChron ()
 
 getLocalizedCoverageGeo ()
 
 getLocalizedCoverageSample ()
 
 getLocalizedCoverPageAltText ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedDiscipline ()
 
 getLocalizedFileName ()
 
 getLocalizedFullTitle ()
 
 getLocalizedHeight ()
 
 getLocalizedHideCoverPageAbstract ()
 
 getLocalizedOriginalFileName ()
 
 getLocalizedPrefix ()
 
 getLocalizedShowCoverPage ()
 
 getLocalizedSponsor ()
 
 getLocalizedSubject ()
 
 getLocalizedSubjectClass ()
 
 getLocalizedSubtitle ()
 
 getLocalizedTitle ($preferredLocale=null)
 
 getLocalizedType ()
 
 getLocalizedWidth ()
 
 getOriginalFileName ($locale)
 
 getPages ()
 
 getPrefix ($locale)
 
 getPrimaryAuthor ()
 
 getPubId ($pubIdType, $preview=false)
 
 getRights ($locale)
 
 getSectionId ()
 
 getShowCoverPage ($locale)
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getStageId ()
 
 getStatus ()
 
 getStatusKey ()
 
getStatusMap ()
 
 getStoredPubId ($pubIdType)
 
 getSubject ($locale)
 
 getSubjectClass ($locale)
 
 getSubmissionProgress ()
 
 getSubtitle ($locale)
 
 getTitle ($locale)
 
 getType ($locale)
 
 getUser ()
 
 getUserId ()
 
 getWidth ($locale)
 
 setAbstract ($abstract, $locale)
 
 setCitations ($citations)
 
 setCleanTitle ($cleanTitle, $locale)
 
 setCommentsStatus ($commentsStatus)
 
 setCommentsToEditor ($commentsToEditor)
 
 setContextId ($contextId)
 
 setCopyrightNotice ($copyrightNotice, $locale)
 
 setCoverageChron ($coverageChron, $locale)
 
 setCoverageGeo ($coverageGeo, $locale)
 
 setCoverageSample ($coverageSample, $locale)
 
 setCoverPageAltText ($coverPageAltText, $locale)
 
 setDatePublished ($datePublished)
 
 setDateStatusModified ($dateModified)
 
 setDateSubmitted ($dateSubmitted)
 
 setDiscipline ($discipline, $locale)
 
 setFileName ($fileName, $locale)
 
 setHeight ($height, $locale)
 
 setHideAuthor ($hideAuthor)
 
 setHideCoverPageAbstract ($hideCoverPageAbstract, $locale)
 
 setHideCoverPageToc ($hideCoverPageToc, $locale)
 
 setLanguage ($language)
 
 setLastModified ($dateModified)
 
 setLocale ($locale)
 
 setOriginalFileName ($originalFileName, $locale)
 
 setPages ($pages)
 
 setPrefix ($prefix, $locale)
 
 setRights ($rights, $locale)
 
 setShowCoverPage ($showCoverPage, $locale)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setStageId ($stageId)
 
 setStatus ($status)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setSubject ($subject, $locale)
 
 setSubjectClass ($subjectClass, $locale)
 
 setSubmissionProgress ($submissionProgress)
 
 setSubtitle ($subtitle, $locale)
 
 setTitle ($title, $locale)
 
 setType ($type, $locale)
 
 setUserId ($userId)
 
 setWidth ($width, $locale)
 
 stampModified ()
 
 stampStatusModified ()
 
 Submission ()
 
- 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)
 

Additional Inherited Members

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

Detailed Description

Class for a Monograph.

See Also
MonographDAO

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

Member Function Documentation

Monograph::getLocalizedSupportingAgencies ( )

Get localized supporting agencies array.

Returns
array

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

References Submission\getLocalizedData().

Monograph::getPressId ( )

get press id

Returns
int

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

References Submission\getContextId().

Referenced by PublishedMonograph\getCategories().

Monograph::getSectionId ( )
See Also
Submission::getSectionId()

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

References DataObject\getData().

Referenced by getSeriesId().

Monograph::getSeriesAbbrev ( )

Get the series's abbreviated identifier.

Returns
string

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

References DataObject\getData().

Monograph::getSeriesId ( )

Get the series id.

Returns
int

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

References getSectionId().

Monograph::getSeriesPosition ( )

Get the position of this monograph within a series.

Returns
string

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

References DataObject\getData().

Monograph::getSeriesTitle ( )

Get the series's title.

Returns
string

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

References DataObject\getData().

Monograph::getSupportingAgencies (   $locale)

Get supporting agencies.

Parameters
$locale
Returns
array

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

References DataObject\getData().

Monograph::getWorkType ( )

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

Returns
int

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

References DataObject\getData().

Monograph::isMetadataApproved ( )

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

Returns
boolean;

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

References Submission\getDatePublished().

Referenced by PublishedMonograph\isAvailable().

Monograph::Monograph ( )

get monograph id

Returns
int Constructor.

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

Monograph::setPressId (   $pressId)

set press id

Parameters
$pressIdint

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

References Submission\setContextId().

Monograph::setSeriesAbbrev (   $abbrev)

Set the series's abbreviated identifier.

Parameters
$abbrevstring

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

References DataObject\setData().

Monograph::setSeriesId (   $id)

Set the series id.

Parameters
$idint

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

References DataObject\setData().

Monograph::setSeriesPosition (   $seriesPosition)

Set the series position for this monograph.

Parameters
$seriesPositionstring

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

References DataObject\setData().

Monograph::setSeriesTitle (   $title)

Set the series title.

Parameters
$titlestring

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

References DataObject\setData().

Monograph::setSupportingAgencies (   $title,
  $locale 
)

Set supporting agencies.

Parameters
$supportingAgenciesarray
$locale

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

References DataObject\setData().

Monograph::setWorkType (   $workType)

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

Parameters
$workTypeint

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

References DataObject\setData().


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