Open Monograph Press  3.3.0
Submission Class Reference
Inheritance diagram for Submission:
PKPSubmission DataObject ReviewerSubmission

Public Member Functions

 _getContextLicenseFieldValue ($locale, $field, $publication=null)
 
 getAuthorOrEditorString ($preferred=true)
 
 getCoverImage ()
 
 getCoverImageAltText ()
 
 getEnableChapterPublicationDates ()
 
 getLocalizedSupportingAgencies ()
 
 getPressId ()
 
 getSectionId ()
 
 getSeriesId ()
 
 getSeriesPosition ()
 
 getSupportingAgencies ($locale)
 
 getWorkType ()
 
 setEnableChapterPublicationDates ($enableChapterPublicationDates)
 
 setPressId ($pressId)
 
 setSeriesId ($id)
 
 setSeriesPosition ($seriesPosition)
 
 setSupportingAgencies ($supportingAgencies, $locale)
 
 setWorkType ($workType)
 
- Public Member Functions inherited from PKPSubmission
 __construct ()
 
 _getContextLicenseFieldValue ($locale, $field)
 
 getAbstract ($locale)
 
 getAuthorEmails ()
 
 getAuthors ($onlyIncludeInBrowse=false)
 
 getAuthorString ($preferred=true, $familyOnly=false)
 
 getBestId ()
 
 getCitations ()
 
 getContextId ()
 
 getCopyrightHolder ($locale)
 
 getCopyrightNotice ($locale)
 
 getCopyrightYear ()
 
 getCoverage ($locale)
 
 getCurrentPublication ()
 
 getDAO ()
 
 getDatePublished ()
 
 getDateStatusModified ()
 
 getDateSubmitted ()
 
 getDiscipline ($locale)
 
 getEndingPage ()
 
 getFullTitle ($locale)
 
 getLanguage ()
 
 getLastModified ()
 
 getLatestPublication ()
 
 getLicenseURL ()
 
 getLocale ()
 
 getLocalizedAbstract ()
 
 getLocalizedCopyrightHolder ($preferredLocale=null)
 
 getLocalizedCoverage ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedDiscipline ()
 
 getLocalizedFullTitle ()
 
 getLocalizedPrefix ()
 
 getLocalizedSponsor ()
 
 getLocalizedSubject ()
 
 getLocalizedSubtitle ()
 
 getLocalizedTitle ($preferredLocale=null, $includePrefix=true)
 
 getLocalizedType ()
 
 getPageArray ()
 
 getPages ()
 
 getPrefix ($locale)
 
 getPrimaryAuthor ()
 
 getPublishedPublications ()
 
 getRights ($locale)
 
 getShortAuthorString ()
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getStageId ()
 
 getStartingPage ()
 
 getStatus ()
 
 getStatusKey ()
 
getStatusMap ()
 
 getStoredPubId ($pubIdType)
 
 getSubject ($locale)
 
 getSubmissionProgress ()
 
 getSubtitle ($locale)
 
 getTitle ($locale, $includePrefix=true)
 
 getType ($locale)
 
 getViews ()
 
 isCCLicense ()
 
 setAbstract ($abstract, $locale)
 
 setCitations ($citations)
 
 setContextId ($contextId)
 
 setCopyrightHolder ($copyrightHolder, $locale)
 
 setCopyrightNotice ($copyrightNotice, $locale)
 
 setCopyrightYear ($copyrightYear)
 
 setCoverage ($coverage, $locale)
 
 setDatePublished ($datePublished)
 
 setDateStatusModified ($dateModified)
 
 setDateSubmitted ($dateSubmitted)
 
 setDiscipline ($discipline, $locale)
 
 setHideAuthor ($hideAuthor)
 
 setLanguage ($language)
 
 setLastModified ($dateModified)
 
 setLicenseURL ($licenseURL)
 
 setLocale ($locale)
 
 setPages ($pages)
 
 setPrefix ($prefix, $locale)
 
 setRights ($rights, $locale)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setStageId ($stageId)
 
 setStatus ($status)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setSubject ($subject, $locale)
 
 setSubmissionProgress ($submissionProgress)
 
 setSubtitle ($subtitle, $locale)
 
 setTitle ($title, $locale)
 
 setType ($type, $locale)
 
 stampLastActivity ()
 
 stampModified ()
 
 stampStatusModified ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

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

Detailed Description

Class for a Submission.

See also
SubmissionDAO

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

Member Function Documentation

◆ _getContextLicenseFieldValue()

Submission::_getContextLicenseFieldValue (   $locale,
  $field,
  $publication = null 
)

Get the value of a license field from the containing context.

Parameters
$localestring Locale code
$fieldPERMISSIONS_FIELD_...
$publicationPublication
Returns
string|array|null

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

References PKPServices\get(), PKPSubmission\getCurrentPublication(), and DataObject\getData().

◆ getAuthorOrEditorString()

Submission::getAuthorOrEditorString (   $preferred = true)

Get a string indicating all authors or, if it is an edited volume, editors.

Parameters
$preferredboolean If the preferred public name should be used, if exist
Returns
string
Deprecated:
3.2.0.0

Definition at line 241 of file Submission.inc.php.

References PKPSubmission\getAuthors(), PKPSubmission\getCurrentPublication(), DAORegistry\getDAO(), and getWorkType().

◆ getCoverImage()

Submission::getCoverImage ( )

get cover page server-side file name

Returns
string
Deprecated:
3.2.0.0

Definition at line 213 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

◆ getCoverImageAltText()

Submission::getCoverImageAltText ( )

get cover page alternate text

Returns
string
Deprecated:
3.2.0.0

Definition at line 226 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

◆ getEnableChapterPublicationDates()

Submission::getEnableChapterPublicationDates ( )

get enableChapterPublicationDates status

Returns
int

Definition at line 260 of file Submission.inc.php.

References DataObject\getData().

◆ getLocalizedSupportingAgencies()

Submission::getLocalizedSupportingAgencies ( )

Get localized supporting agencies array.

Returns
array
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getPressId()

Submission::getPressId ( )

get press id

Returns
int
Deprecated:
3.2.0.0

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

References PKPSubmission\getContextId().

◆ getSectionId()

Submission::getSectionId ( )
See also
Submission::getSectionId()
Deprecated:
3.2.0.0

Reimplemented from PKPSubmission.

Definition at line 59 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

Referenced by getSeriesId().

◆ getSeriesId()

Submission::getSeriesId ( )

Get the series id.

Returns
int
Deprecated:
3.2.0.0

Definition at line 51 of file Submission.inc.php.

References getSectionId().

◆ getSeriesPosition()

Submission::getSeriesPosition ( )

Get the position of this monograph within a series.

Returns
string
Deprecated:
3.2.0.0

Definition at line 84 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

◆ getSupportingAgencies()

Submission::getSupportingAgencies (   $locale)

Get supporting agencies.

Parameters
$locale
Returns
array
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getWorkType()

Submission::getWorkType ( )

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

Returns
int
Deprecated:
3.2.0.0

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

References DataObject\getData().

Referenced by getAuthorOrEditorString().

◆ setEnableChapterPublicationDates()

Submission::setEnableChapterPublicationDates (   $enableChapterPublicationDates)

set enableChapterPublicationDates status

Parameters
$enableChapterPublicationDatesint

Definition at line 268 of file Submission.inc.php.

References DataObject\setData().

◆ setPressId()

Submission::setPressId (   $pressId)

set press id

Parameters
$pressIdint
Deprecated:
3.2.0.0

Definition at line 42 of file Submission.inc.php.

References PKPSubmission\setContextId().

◆ setSeriesId()

Submission::setSeriesId (   $id)

Set the series id.

Parameters
$idint
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ setSeriesPosition()

Submission::setSeriesPosition (   $seriesPosition)

Set the series position for this monograph.

Parameters
$seriesPositionstring
Deprecated:
3.2.0.0

Definition at line 97 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

◆ setSupportingAgencies()

Submission::setSupportingAgencies (   $supportingAgencies,
  $locale 
)

Set supporting agencies.

Parameters
$supportingAgenciesarray
$locale
Deprecated:
3.2.0.0

Definition at line 155 of file Submission.inc.php.

References PKPSubmission\getCurrentPublication().

◆ setWorkType()

Submission::setWorkType (   $workType)

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

Parameters
$workTypeint
Deprecated:
3.2.0.0

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

References DataObject\setData().


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