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

Public Member Functions

 getAgents ()
 
 getAudience ()
 
 getAudienceRangeExact ()
 
 getAudienceRangeFrom ()
 
 getAudienceRangeQualifier ()
 
 getAudienceRangeTo ()
 
 getCategories ()
 
 getCoverImage ()
 
 getPublicationFormats ($onlyApproved=false)
 
 getPublicationFormatString ()
 
 getSuppliers ()
 
 getViews ()
 
 hasPublicationFormats ()
 
 isAvailable ()
 
 PublishedMonograph ()
 
 setAudience ($audience)
 
 setAudienceRangeExact ($audienceRangeExact)
 
 setAudienceRangeFrom ($audienceRangeFrom)
 
 setAudienceRangeQualifier ($audienceRangeQualifier)
 
 setAudienceRangeTo ($audienceRangeTo)
 
 setCoverImage ($coverImage)
 
 setViews ($views)
 
- Public Member Functions inherited from Monograph
 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

Published monograph class.

See Also
PublishedMonographDAO

Definition at line 24 of file PublishedMonograph.inc.php.

Member Function Documentation

PublishedMonograph::getAgents ( )

Get the Representative objects assigned as agents for this published monograph.

Returns
Array Representative

Definition at line 230 of file PublishedMonograph.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

PublishedMonograph::getAudience ( )

Get the audience of the published monograph.

Returns
int

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

References DataObject\getData().

PublishedMonograph::getAudienceRangeExact ( )

Get the audienceRangeExact field of the published monograph.

Returns
int

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

References DataObject\getData().

PublishedMonograph::getAudienceRangeFrom ( )

Get the audienceRangeFrom field for the published monograph.

Returns
int

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

References DataObject\getData().

PublishedMonograph::getAudienceRangeQualifier ( )

Get the audienceRangeQualifier of the published monograph.

Returns
int

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

References DataObject\getData().

PublishedMonograph::getAudienceRangeTo ( )

Get the audienceRangeTo field for the published monograph.

Returns
int

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

References DataObject\getData().

PublishedMonograph::getCategories ( )

Get the categories for this published monograph.

See Also
PublishedMonographDAO::getCategories
Returns
Iterator

Definition at line 178 of file PublishedMonograph.inc.php.

References DAORegistry\getDAO(), DataObject\getId(), and Monograph\getPressId().

PublishedMonograph::getCoverImage ( )

Get the cover image.

Returns
array

Definition at line 190 of file PublishedMonograph.inc.php.

References DataObject\getData().

PublishedMonograph::getPublicationFormats (   $onlyApproved = false)

Retrieves the assigned publication formats for this submission

Parameters
$onlyApprovedboolean whether to fetch only those that are approved for publication.
Returns
array PublicationFormat

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

References DAORegistry\getDAO(), and DataObject\getId().

Referenced by getPublicationFormatString(), hasPublicationFormats(), and isAvailable().

PublishedMonograph::getPublicationFormatString ( )

Return string of approved publication formats, separated by comma.

Returns
string

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

References getPublicationFormats().

PublishedMonograph::getSuppliers ( )

Get the Representative objects assigned as suppliers for this published monograph.

Returns
Array Representative

Definition at line 221 of file PublishedMonograph.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

PublishedMonograph::getViews ( )

Get views of the published monograph.

Returns
int

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

References DataObject\getId().

PublishedMonograph::hasPublicationFormats ( )

Returns whether or not this published monograph has formats assigned to it

Returns
boolean

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

References getPublicationFormats().

PublishedMonograph::isAvailable ( )

Get whether or not this monograph is available in the catalog. A monograph is available if it has at least one publication format that has been flagged as 'available' in the catalog and if it has metadata approved.

Returns
boolean

Definition at line 209 of file PublishedMonograph.inc.php.

References getPublicationFormats(), and Monograph\isMetadataApproved().

PublishedMonograph::PublishedMonograph ( )

Constructor.

Definition at line 29 of file PublishedMonograph.inc.php.

PublishedMonograph::setAudience (   $audience)

Set the audience for the published monograph.

Parameters
$audienceint (onix code)

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

References DataObject\setData().

PublishedMonograph::setAudienceRangeExact (   $audienceRangeExact)

Set the audienceRangeExact field for the published monograph.

Parameters
$audienceRangeExactint (onix code)

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

References DataObject\setData().

PublishedMonograph::setAudienceRangeFrom (   $audienceRangeFrom)

Set the audienceRangeFrom field for the published monograph.

Parameters
$audienceRangeFromint (onix code)

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

References DataObject\setData().

PublishedMonograph::setAudienceRangeQualifier (   $audienceRangeQualifier)

Set the audienceRangeQualifier for the published monograph.

Parameters
$audienceRangeQualifierint (onix code)

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

References DataObject\setData().

PublishedMonograph::setAudienceRangeTo (   $audienceRangeTo)

Set the audienceRangeTo field for the published monograph.

Parameters
$audienceRangeToint (onix code)

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

References DataObject\setData().

PublishedMonograph::setCoverImage (   $coverImage)

Set the cover image.

Parameters
$coverImagearray

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

References DataObject\setData().

PublishedMonograph::setViews (   $views)

Set views of the published monograph.

Parameters
$viewsint

Definition at line 46 of file PublishedMonograph.inc.php.

References DataObject\setData().


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