Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Submission Class Reference
Inheritance diagram for Submission:
DataObject Article AuthorSubmission CopyeditorSubmission LayoutEditorSubmission ProofreaderSubmission PublishedArticle ReviewerSubmission SectionEditorSubmission EditorSubmission

Public Member Functions

 getAbstract ($locale)
 
 getAssocType ()
 
 getAuthorEmails ()
 
getAuthors ()
 
 getAuthorString ($lastOnly=false, $separator= ', ')
 
 getCitations ()
 
 getCommentsStatus ()
 
 getCoverageChron ($locale)
 
 getCoverageGeo ($locale)
 
 getCoverageSample ($locale)
 
 getCoverPageAltText ($locale)
 
 getDateStatusModified ()
 
 getDateSubmitted ()
 
 getDiscipline ($locale)
 
 getFileName ($locale)
 
 getFirstAuthor ($lastOnly=false)
 
 getHeight ($locale)
 
 getHideCoverPageAbstract ($locale)
 
 getHideCoverPageToc ($locale)
 
 getLanguage ()
 
 getLastModified ()
 
 getLocale ()
 
 getLocalizedAbstract ()
 
 getLocalizedCoverageChron ()
 
 getLocalizedCoverageGeo ()
 
 getLocalizedCoverageSample ()
 
 getLocalizedCoverPageAltText ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedDiscipline ()
 
 getLocalizedFileName ()
 
 getLocalizedHeight ()
 
 getLocalizedHideCoverPageAbstract ()
 
 getLocalizedOriginalFileName ()
 
 getLocalizedPrefix ()
 
 getLocalizedShowCoverPage ()
 
 getLocalizedSponsor ()
 
 getLocalizedSubject ()
 
 getLocalizedSubjectClass ()
 
 getLocalizedTitle ($preferredLocale=null)
 
 getLocalizedType ()
 
 getLocalizedWidth ()
 
 getOriginalFileName ($locale)
 
 getPages ()
 
 getPrefix ($locale)
 
getPrimaryAuthor ()
 
 getReviewFileId ()
 
 getRevisedFileId ()
 
 getRights ($locale)
 
 getShowCoverPage ($locale)
 
 getSource ($locale)
 
 getSponsor ($locale)
 
 getStatus ()
 
 getStatusKey ()
 
getStatusMap ()
 
 getSubject ($locale)
 
 getSubjectClass ($locale)
 
 getSubmissionFileId ()
 
 getSubmissionProgress ()
 
 getTitle ($locale)
 
 getType ($locale)
 
 getUser ()
 
 getUserId ()
 
 getWidth ($locale)
 
 setAbstract ($abstract, $locale)
 
 setCitations ($citations)
 
 setCleanTitle ($cleanTitle, $locale)
 
 setCommentsStatus ($commentsStatus)
 
 setCoverageChron ($coverageChron, $locale)
 
 setCoverageGeo ($coverageGeo, $locale)
 
 setCoverageSample ($coverageSample, $locale)
 
 setCoverPageAltText ($coverPageAltText, $locale)
 
 setDateStatusModified ($dateModified)
 
 setDateSubmitted ($dateSubmitted)
 
 setDiscipline ($discipline, $locale)
 
 setFileName ($fileName, $locale)
 
 setHeight ($height, $locale)
 
 setHideCoverPageAbstract ($hideCoverPageAbstract, $locale)
 
 setHideCoverPageToc ($hideCoverPageToc, $locale)
 
 setLanguage ($language)
 
 setLastModified ($dateModified)
 
 setLocale ($locale)
 
 setOriginalFileName ($originalFileName, $locale)
 
 setPages ($pages)
 
 setPrefix ($prefix, $locale)
 
 setReviewFileId ($reviewFileId)
 
 setRevisedFileId ($revisedFileId)
 
 setRights ($rights, $locale)
 
 setShowCoverPage ($showCoverPage, $locale)
 
 setSource ($source, $locale)
 
 setSponsor ($sponsor, $locale)
 
 setStatus ($status)
 
 setSubject ($subject, $locale)
 
 setSubjectClass ($subjectClass, $locale)
 
 setSubmissionFileId ($submissionFileId)
 
 setSubmissionProgress ($submissionProgress)
 
 setTitle ($title, $locale)
 
 setType ($type, $locale)
 
 setUserId ($userId)
 
 setWidth ($width, $locale)
 
 stampModified ()
 
 stampStatusModified ()
 
 Submission ()
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

Submission class.

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

Member Function Documentation

Submission::getAbstract (   $locale)

Get abstract.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getAssocType ( )

Returns the association type of this submission

Returns
integer one of the ASSOC_TYPE_* constants

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

Submission::getAuthorEmails ( )

Return a list of author email addresses.

Returns
array

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

References Mail\encodeDisplayName(), and getAuthors().

& Submission::getAuthors ( )

Get all authors of this submission.

Returns
array Authors

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

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

Referenced by getAuthorEmails(), getAuthorString(), and getFirstAuthor().

Submission::getAuthorString (   $lastOnly = false,
  $separator = ',
 
)

Return string of author names, separated by the specified token

Parameters
$lastOnlyboolean return list of lastnames only (default false)
$separatorstring separator for names (default comma+space)
Returns
string

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

References getAuthors().

Submission::getCitations ( )

Get citations.

Returns
string

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

References DataObject\getData().

Submission::getCommentsStatus ( )

Return submission RT comments status.

Returns
int

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

References DataObject\getData().

Referenced by Article\getCommentsStatusString(), and Article\getEnableComments().

Submission::getCoverageChron (   $locale)

Get chronological coverage.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getCoverageGeo (   $locale)

Get geographical coverage.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getCoverageSample (   $locale)

Get research sample coverage.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getCoverPageAltText (   $locale)

get cover page alternate text

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Submission::getDateStatusModified ( )

Get the date of the last status modification.

Returns
date

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

References DataObject\getData().

Submission::getDateSubmitted ( )

Get submission date.

Returns
date

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

References DataObject\getData().

Submission::getDiscipline (   $locale)

Get discipline

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getFileName (   $locale)

get file name

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Submission::getFirstAuthor (   $lastOnly = false)

Return first author

Parameters
$lastOnlyboolean return lastname only (default false)
Returns
string

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

References getAuthors().

Submission::getHeight (   $locale)

get height of cover page image

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Submission::getHideCoverPageAbstract (   $locale)

get hide cover page in abstract view

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Submission::getHideCoverPageToc (   $locale)

get hide cover page thumbnail in Toc

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Submission::getLanguage ( )

Get language.

Returns
string

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

References DataObject\getData().

Submission::getLastModified ( )

Get the date of the last modification.

Returns
date

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

References DataObject\getData().

Submission::getLocale ( )

Get the locale of the submission.

Returns
string

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

References DataObject\getData().

Referenced by getLocalizedData(), and PublishedArticle\getLocalizedGalleys().

Submission::getLocalizedAbstract ( )

Get "localized" submission abstract (if applicable).

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleAbstract().

Submission::getLocalizedCoverageChron ( )

Return the localized chronological coverage

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleCoverageChron().

Submission::getLocalizedCoverageGeo ( )

Return the localized geographical coverage

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleCoverageGeo().

Submission::getLocalizedCoverageSample ( )

Return the localized sample coverage

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleCoverageSample().

Submission::getLocalizedCoverPageAltText ( )

Get the localized cover alternate text

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleCoverPageAltText().

Submission::getLocalizedDiscipline ( )

Return the localized discipline

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleDiscipline().

Submission::getLocalizedFileName ( )

Get the localized cover filename

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleFileName().

Submission::getLocalizedHeight ( )

Get the localized submission cover height

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleHeight().

Submission::getLocalizedHideCoverPageAbstract ( )

Get localized hide cover page in abstract view

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

References getLocalizedData().

Submission::getLocalizedOriginalFileName ( )

Get the localized cover filename on the uploader's computer

Returns
string

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

References getLocalizedData().

Submission::getLocalizedPrefix ( )

Get "localized" submission prefix (if applicable).

Returns
string

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

References getLocalizedData().

Submission::getLocalizedShowCoverPage ( )

Get the flag indicating whether or not to show a cover page.

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleShowCoverPage().

Submission::getLocalizedSponsor ( )

Return the localized sponsor

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleSponsor().

Submission::getLocalizedSubject ( )

Return the localized subject

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleSubject().

Submission::getLocalizedSubjectClass ( )

Return the localized subject classification

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleSubjectClass().

Submission::getLocalizedTitle (   $preferredLocale = null)

Get "localized" submission title (if applicable).

Parameters
$preferredLocalestring
Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleTitle().

Submission::getLocalizedType ( )

Return the localized type (method/approach)

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleType().

Submission::getLocalizedWidth ( )

Get the localized submission cover width

Returns
string

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

References getLocalizedData().

Referenced by Article\getArticleWidth().

Submission::getOriginalFileName (   $locale)

get original file name

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Submission::getPages ( )

get pages

Returns
string

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

References DataObject\getData().

Submission::getPrefix (   $locale)

Get prefix.

Parameters
$locale
Returns
string

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

References DataObject\getData().

& Submission::getPrimaryAuthor ( )

Get the primary author of this submission.

Returns
Author

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

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

Submission::getReviewFileId ( )

Get review file id.

Returns
int

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

References DataObject\getData().

Submission::getRevisedFileId ( )

Get revised file id.

Returns
int

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

References DataObject\getData().

Submission::getRights (   $locale)

Get rights.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getShowCoverPage (   $locale)

get show cover page

Parameters
$localestring
Returns
int

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

References DataObject\getData().

Submission::getSource (   $locale)

Get source.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getSponsor (   $locale)

Get sponsor.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getStatus ( )
Submission::getStatusKey ( )

Get a locale key for the paper's current status.

Returns
string

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

References getStatus(), and getStatusMap().

& Submission::getStatusMap ( )

Get a map for status constant to locale key.

Returns
array

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

Referenced by getStatusKey().

Submission::getSubject (   $locale)

Get subject.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getSubjectClass (   $locale)

Get subject classification.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getSubmissionFileId ( )

Get submission file id.

Returns
int

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

References DataObject\getData().

Submission::getSubmissionProgress ( )

Get submission progress (most recently completed submission step).

Returns
int

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

References DataObject\getData().

Referenced by SectionEditorSubmission\getSubmissionStatus(), and AuthorSubmission\getSubmissionStatus().

Submission::getTitle (   $locale)

Get title.

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getType (   $locale)

Get type (method/approach).

Parameters
$locale
Returns
string

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

References DataObject\getData().

Submission::getUser ( )

Return the user of the submitter.

Returns
User

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

References DAORegistry\getDAO(), and getUserId().

Submission::getUserId ( )

Get user ID of the submitter.

Returns
int

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

References DataObject\getData().

Referenced by Article\getAssociatedUserIds(), and getUser().

Submission::getWidth (   $locale)

get width of cover page image

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Submission::setAbstract (   $abstract,
  $locale 
)

Set abstract.

Parameters
$abstractstring
$locale

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

References DataObject\setData().

Submission::setCitations (   $citations)

Set citations.

Parameters
$citationsstring

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

References DataObject\setData().

Submission::setCleanTitle (   $cleanTitle,
  $locale 
)

Set 'clean' title (with punctuation removed).

Parameters
$cleanTitlestring
$locale

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

References DataObject\setData().

Referenced by setTitle().

Submission::setCommentsStatus (   $commentsStatus)

Set submission RT comments status.

Parameters
$commentsStatusboolean

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

References DataObject\setData().

Submission::setCoverageChron (   $coverageChron,
  $locale 
)

Set chronological coverage.

Parameters
$coverageChronstring
$locale

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

References DataObject\setData().

Submission::setCoverageGeo (   $coverageGeo,
  $locale 
)

Set geographical coverage.

Parameters
$coverageGeostring
$locale

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

References DataObject\setData().

Submission::setCoverageSample (   $coverageSample,
  $locale 
)

Set geographical coverage.

Parameters
$coverageSamplestring
$locale

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

References DataObject\setData().

Submission::setCoverPageAltText (   $coverPageAltText,
  $locale 
)

set cover page alternate text

Parameters
$coverPageAltTextstring
$localestring

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

References DataObject\setData().

Submission::setDateStatusModified (   $dateModified)

Set the date of the last status modification.

Parameters
$dateModifieddate

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

References DataObject\setData().

Referenced by stampStatusModified().

Submission::setDateSubmitted (   $dateSubmitted)

Set submission date.

Parameters
$dateSubmitteddate

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

References DataObject\setData().

Submission::setDiscipline (   $discipline,
  $locale 
)

Set discipline

Parameters
$disciplinestring
$locale

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

References DataObject\setData().

Submission::setFileName (   $fileName,
  $locale 
)

set file name

Parameters
$fileNamestring
$localestring

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

References DataObject\setData().

Submission::setHeight (   $height,
  $locale 
)

set height of cover page image

Parameters
$localestring
$heightint

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

References DataObject\setData().

Submission::setHideCoverPageAbstract (   $hideCoverPageAbstract,
  $locale 
)

set hide cover page in abstract view

Parameters
$hideCoverPageAbstractint
$localestring

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

References DataObject\setData().

Submission::setHideCoverPageToc (   $hideCoverPageToc,
  $locale 
)

set hide cover page thumbnail in Toc

Parameters
$hideCoverPageTocint
$localestring

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

References DataObject\setData().

Submission::setLanguage (   $language)

Set language.

Parameters
$languagestring

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

References DataObject\setData().

Submission::setLastModified (   $dateModified)

Set the date of the last modification.

Parameters
$dateModifieddate

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

References DataObject\setData().

Referenced by stampModified().

Submission::setLocale (   $locale)

Set the locale of the submission.

Parameters
$localestring

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

References DataObject\setData().

Submission::setOriginalFileName (   $originalFileName,
  $locale 
)

set original file name

Parameters
$originalFileNamestring
$localestring

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

References DataObject\setData().

Submission::setPages (   $pages)

set pages

Parameters
$pagesstring

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

References DataObject\setData().

Submission::setPrefix (   $prefix,
  $locale 
)

Set prefix.

Parameters
$prefixstring
$locale

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

References DataObject\setData().

Submission::setReviewFileId (   $reviewFileId)

Set review file id.

Parameters
$reviewFileIdint

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

References DataObject\setData().

Submission::setRevisedFileId (   $revisedFileId)

Set revised file id.

Parameters
$revisedFileIdint

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

References DataObject\setData().

Submission::setRights (   $rights,
  $locale 
)

Set rights.

Parameters
$rightsstring
$locale

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

References DataObject\setData().

Submission::setShowCoverPage (   $showCoverPage,
  $locale 
)

set show cover page

Parameters
$showCoverPageint
$localestring

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

References DataObject\setData().

Submission::setSource (   $source,
  $locale 
)

Set source.

Parameters
$sourcestring
$locale

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

References DataObject\setData().

Submission::setSponsor (   $sponsor,
  $locale 
)

Set sponsor.

Parameters
$sponsorstring
$locale

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

References DataObject\setData().

Submission::setStatus (   $status)

Set submission status.

Parameters
$statusint

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

References DataObject\setData().

Submission::setSubject (   $subject,
  $locale 
)

Set subject.

Parameters
$subjectstring
$locale

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

References DataObject\setData().

Submission::setSubjectClass (   $subjectClass,
  $locale 
)

Set subject classification.

Parameters
$subjectClassstring
$locale

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

References DataObject\setData().

Submission::setSubmissionFileId (   $submissionFileId)

Set submission file id.

Parameters
$submissionFileIdint

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

References DataObject\setData().

Submission::setSubmissionProgress (   $submissionProgress)

Set submission progress.

Parameters
$submissionProgressint

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

References DataObject\setData().

Submission::setTitle (   $title,
  $locale 
)

Set title.

Parameters
$titlestring
$locale

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

References setCleanTitle(), and DataObject\setData().

Submission::setType (   $type,
  $locale 
)

Set type (method/approach).

Parameters
$typestring
$locale

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

References DataObject\setData().

Submission::setUserId (   $userId)

Set user ID of the submitter.

Parameters
$userIdint

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

References DataObject\setData().

Submission::setWidth (   $width,
  $locale 
)

set width of cover page image

Parameters
$localestring
$widthint

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

References DataObject\setData().

Submission::stampModified ( )

Stamp the date of the last modification to the current time.

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

References Core\getCurrentDate(), and setLastModified().

Submission::stampStatusModified ( )

Stamp the date of the last status modification to the current time.

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

References Core\getCurrentDate(), and setDateStatusModified().

Submission::Submission ( )

Constructor.

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


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