Open Journal Systems  3.3.0
Submission Class Reference
Inheritance diagram for Submission:
PKPSubmission DataObject ReviewerSubmission

Public Member Functions

 _getContextLicenseFieldValue ($locale, $field, $publication=null)
 
 getBestArticleId ()
 
 getCoverImage ($locale)
 
 getCoverImageAltText ($locale)
 
 getGalleys ()
 
 getHideAuthor ()
 
 getJournalId ()
 
 getLocalizedCoverImage ()
 
 getLocalizedCoverImageAltText ()
 
 getLocalizedCoverImageUrl ()
 
 getLocalizedGalleys ()
 
 getSectionId ()
 
 setJournalId ($journalId)
 
 setSectionId ($sectionId)
 
- 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

Article class.

See also
SubmissionDAO

Definition at line 34 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 47 of file Submission.inc.php.

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

◆ getBestArticleId()

Submission::getBestArticleId ( )
See also
PKPSubmission::getBestId()
Deprecated:
3.2.0.0
Returns
string

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

◆ getCoverImage()

Submission::getCoverImage (   $locale)

get cover page server-side file name

Parameters
$localestring
Returns
string
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getCoverImageAltText()

Submission::getCoverImageAltText (   $locale)

get cover page alternate text

Parameters
$localestring
Returns
string
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getGalleys()

Submission::getGalleys ( )

Get the galleys for an article.

Returns
array ArticleGalley
Deprecated:
3.2.0.0

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

References PKPApplication\get(), PKPSubmission\getCurrentPublication(), DataObject\getData(), DataObject\getId(), and DataObject\setData().

◆ getHideAuthor()

Submission::getHideAuthor ( )

Return option selection indicating if author should be hidden in issue ToC.

Returns
int AUTHOR_TOC_...
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getJournalId()

Submission::getJournalId ( )

Get ID of journal.

Deprecated:
3.2.0.0
Returns
int

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

References DataObject\getData().

◆ getLocalizedCoverImage()

Submission::getLocalizedCoverImage ( )

Get the localized cover page server-side file name

Returns
string
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getLocalizedCoverImageAltText()

Submission::getLocalizedCoverImageAltText ( )

Get the localized cover page alternate text

Returns
string
Deprecated:
3.2.0.0

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

References PKPSubmission\getCurrentPublication().

◆ getLocalizedCoverImageUrl()

Submission::getLocalizedCoverImageUrl ( )

Get a full URL to the localized cover image

Returns
string
Deprecated:
3.2.0.0

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

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

◆ getLocalizedGalleys()

Submission::getLocalizedGalleys ( )

Get the localized galleys for an article.

Returns
array ArticleGalley
Deprecated:
3.2.0.0

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

References HookRegistry\call(), DataObject\getData(), AppLocale\getLocale(), PKPSubmission\getLocale(), and AppLocale\getPrimaryLocale().

◆ getSectionId()

Submission::getSectionId ( )

Get ID of article's section.

Returns
int

Reimplemented from PKPSubmission.

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

References PKPSubmission\getCurrentPublication().

◆ setJournalId()

Submission::setJournalId (   $journalId)

Set ID of journal.

Deprecated:
3.2.0.0
Parameters
$journalIdint

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

References DataObject\setData().

◆ setSectionId()

Submission::setSectionId (   $sectionId)

Set ID of article's section.

Parameters
$sectionIdint

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

References PKPSubmission\getCurrentPublication().


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