Paper Class Reference
[Paper]

Paper class. More...

Inheritance diagram for Paper:

AuthorSubmission PublishedPaper ReviewerSubmission TrackDirectorSubmission DirectorSubmission List of all members.

Public Member Functions

 addAuthor ($author)
 getAssociatedUserIds ($authors=true, $reviewers=true, $trackDirectors=true, $directors=true)
getCommentsStatusOptions ()
 getCommentsStatusString ()
 getCommentsToDirector ()
 getCurrentStage ()
 getDateReminded ()
 getDateToArchive ()
 getDateToPresentations ()
 getDirectorFileId ()
 getEnableComments ()
 getEndTime ()
 getLayoutFileId ()
 getPaperAbstract ()
 getPaperCoverageChron ()
 getPaperCoverageGeo ()
 getPaperCoverageSample ()
 getPaperDiscipline ()
 getPaperId ()
 getPaperSponsor ()
 getPaperSubject ()
 getPaperSubjectClass ()
 getPaperTitle ()
 getPaperType ()
 getReviewMode ()
 getSchedConfId ()
 getStartTime ()
 getTrackAbbrev ()
 getTrackId ()
 getTrackTitle ()
 Paper ()
 setCommentsToDirector ($commentsToDirector)
 setCurrentStage ($currentStage)
 setDateReminded ($dateReminded)
 setDateToArchive ($dateToArchive)
 setDateToPresentations ($dateToPresentations)
 setDirectorFileId ($directorFileId)
 setEndTime ($endTime)
 setLayoutFileId ($layoutFileId)
 setPaperId ($paperId)
 setReviewMode ($reviewMode)
 setSchedConfId ($schedConfId)
 setStartTime ($startTime)
 setTrackAbbrev ($trackAbbrev)
 setTrackId ($trackId)
 setTrackTitle ($trackTitle)
 stampDateToArchive ()
 stampDateToPresentations ()

Detailed Description

Paper class.

See also:
PaperDAO

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


Member Function Documentation

Paper.addAuthor ( author  ) 

Add an author.

Parameters:
$author Author

Definition at line 66 of file Paper.inc.php.

References getPaperId().

Paper.getAssociatedUserIds ( authors = true,
reviewers = true,
trackDirectors = true,
directors = true 
)

Get an array of user IDs associated with this paper

Parameters:
$authors boolean
$reviewers boolean
$trackDirectors boolean
$directors boolean
Returns:
array User IDs

Definition at line 494 of file Paper.inc.php.

& Paper.getCommentsStatusOptions (  ) 

Get an associative array matching RT comments status codes with locale strings.

Returns:
array comments status => localeString

Definition at line 477 of file Paper.inc.php.

Referenced by SubmissionEditHandler.submission().

Paper.getCommentsStatusString (  ) 

Return locale string corresponding to RT comments status.

Returns:
string

Definition at line 439 of file Paper.inc.php.

Paper.getCommentsToDirector (  ) 

Get comments to director.

Returns:
string

Definition at line 265 of file Paper.inc.php.

Paper.getCurrentStage (  ) 

Get current stage.

Returns:
int

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

Paper.getDateReminded (  ) 

Get the date of the "submission due" reminder.

Returns:
date

Definition at line 327 of file Paper.inc.php.

Paper.getDateToArchive (  ) 

Get date sent to presentations.

Returns:
date

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

Paper.getDateToPresentations (  ) 

Get date sent to presentations.

Returns:
date

Definition at line 281 of file Paper.inc.php.

Paper.getDirectorFileId (  ) 

Get director file id.

Returns:
int

Definition at line 423 of file Paper.inc.php.

Paper.getEnableComments (  ) 

Return boolean indicating if paper RT comments should be enabled. Checks both the track and paper comments status. Paper status overrides track status.

Returns:
int

Definition at line 456 of file Paper.inc.php.

References getSchedConfId(), and getTrackId().

Paper.getEndTime (  ) 

Get the presentation end time.

Returns:
date

Definition at line 359 of file Paper.inc.php.

Paper.getLayoutFileId (  ) 

Get layout file id.

Returns:
int

Definition at line 407 of file Paper.inc.php.

Paper.getPaperAbstract (  ) 

Get "localized" paper abstract (if applicable). DEPRECATED in favour of getLocalizedAbstract.

Returns:
string

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

Paper.getPaperCoverageChron (  ) 

Return the localized chron coverage. DEPRECATED in favour of getLocalizedCoverageChron.

Returns:
string

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

Paper.getPaperCoverageGeo (  ) 

Return the localized geo coverage. DEPRECATED in favour of getLocalizedCoverageGeo.

Returns:
string

Definition at line 216 of file Paper.inc.php.

Paper.getPaperCoverageSample (  ) 

Return the localized sample coverage. DEPRECATED in favour of getLocalizedCoverageSample.

Returns:
string

Definition at line 236 of file Paper.inc.php.

Paper.getPaperDiscipline (  ) 

Return the localized discipline. DEPRECATED in favour of getLocalizedDiscipline.

Parameters:
$locale string
Returns:
string

Definition at line 185 of file Paper.inc.php.

Paper.getPaperId (  ) 

Get ID of paper.

Returns:
int

Definition at line 101 of file Paper.inc.php.

Referenced by addAuthor(), TrackDirectorSubmission.addReviewAssignment(), and AuthorSubmission.addReviewAssignment().

Paper.getPaperSponsor (  ) 

Return the localized sponsor. DEPRECATED in favour of getLocalizedSponsor.

Returns:
string

Definition at line 256 of file Paper.inc.php.

Paper.getPaperSubject (  ) 

Return the localized subject. DEPRECATED in favour of getLocalizedSubject.

Returns:
string

Definition at line 206 of file Paper.inc.php.

Paper.getPaperSubjectClass (  ) 

Return the localized subject classification. DEPRECATED in favour of getLocalizedSubjectClass.

Parameters:
$locale string
Returns:
string

Definition at line 196 of file Paper.inc.php.

Paper.getPaperTitle (  ) 

Get "localized" paper title (if applicable). DEPRECATED in favour of getLocalizedTitle.

Returns:
string

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

Paper.getPaperType (  ) 

Return the localized type. DEPRECATED in favour of getLocalizedType.

Returns:
string

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

Paper.getReviewMode (  ) 

Get review mode.

Returns:
int REVIEW_MODE_...

Definition at line 391 of file Paper.inc.php.

Referenced by TrackDirectorSubmission.getDirectorDecisionOptions(), and TrackDirectorSubmission.isOriginalSubmissionComplete().

Paper.getSchedConfId (  ) 

Get ID of scheduled conference.

Returns:
int

Reimplemented in PublishedPaper.

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

Referenced by getEnableComments(), and AuthorSubmission.getSubmissionStatus().

Paper.getStartTime (  ) 

Get the presentation start time.

Returns:
date

Definition at line 343 of file Paper.inc.php.

Paper.getTrackAbbrev (  ) 

Get track abbreviation.

Returns:
string

Definition at line 167 of file Paper.inc.php.

Paper.getTrackId (  ) 

Get ID of paper's track.

Returns:
int

Reimplemented in PublishedPaper.

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

Referenced by getEnableComments().

Paper.getTrackTitle (  ) 

Get title of paper's track.

Returns:
string

Definition at line 151 of file Paper.inc.php.

Paper.Paper (  ) 

Constructor.

Definition at line 58 of file Paper.inc.php.

Paper.setCommentsToDirector ( commentsToDirector  ) 

Set comments to director.

Parameters:
$commentsToDirector string

Definition at line 273 of file Paper.inc.php.

Paper.setCurrentStage ( currentStage  ) 

Set current stage.

Parameters:
$currentStage int

Definition at line 383 of file Paper.inc.php.

Paper.setDateReminded ( dateReminded  ) 

Set the date of the "submission due" reminder.

Parameters:
$dateModified date

Definition at line 335 of file Paper.inc.php.

Paper.setDateToArchive ( dateToArchive  ) 

Set date sent to presentations.

Parameters:
$dateToArchive date

Definition at line 305 of file Paper.inc.php.

Referenced by stampDateToArchive().

Paper.setDateToPresentations ( dateToPresentations  ) 

Set date sent to presentations.

Parameters:
$dateToPresentations date

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

Referenced by stampDateToPresentations().

Paper.setDirectorFileId ( directorFileId  ) 

Set director file id.

Parameters:
$directorFileId int

Definition at line 431 of file Paper.inc.php.

Paper.setEndTime ( endTime  ) 

Get the presentation end time.

Parameters:
$endTime date

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

Paper.setLayoutFileId ( layoutFileId  ) 

Set layout file id.

Parameters:
$layoutFileId int

Definition at line 415 of file Paper.inc.php.

Paper.setPaperId ( paperId  ) 

Set ID of paper.

Parameters:
$paperId int

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

Paper.setReviewMode ( reviewMode  ) 

Set review mode.

Parameters:
$reviewMode int REVIEW_MODE_...

Definition at line 399 of file Paper.inc.php.

Paper.setSchedConfId ( schedConfId  ) 

Set ID of scheduled conference.

Parameters:
$schedConfId int

Reimplemented in PublishedPaper.

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

Paper.setStartTime ( startTime  ) 

Set the presentation start time.

Parameters:
$startTime date

Definition at line 351 of file Paper.inc.php.

Paper.setTrackAbbrev ( trackAbbrev  ) 

Set track abbreviation.

Parameters:
$trackAbbrev string

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

Paper.setTrackId ( trackId  ) 

Set ID of paper's track.

Parameters:
$trackId int

Reimplemented in PublishedPaper.

Definition at line 143 of file Paper.inc.php.

Paper.setTrackTitle ( trackTitle  ) 

Set title of paper's track.

Parameters:
$trackTitle string

Definition at line 159 of file Paper.inc.php.

Paper.stampDateToArchive (  ) 

Stamp the date moved to the archive to the current time.

Definition at line 312 of file Paper.inc.php.

References setDateToArchive().

Paper.stampDateToPresentations (  ) 

Stamp the date moved to presentations to the current time.

Definition at line 319 of file Paper.inc.php.

References setDateToPresentations().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7