Inheritance diagram for ReviewAssignment:

Public Member Functions
	getCancelled ()

	getComments ()

	getCompetingInterests ()

	getDateAcknowledged ()

	getDateAssigned ()

	getDateCompleted ()

	getDateConfirmed ()

	getDateDue ()

	getDateNotified ()

	getDateRated ()

	getDateReminded ()

	getDateResponseDue ()

	getDeclined ()

	getLastModified ()

	getLocalizedRecommendation ()

	getQuality ()

	getRecommendation ()

	getReminderWasAutomatic ()

	getReviewerFullName ()

	getReviewerId ()

	getReviewFormId ()

	getReviewMethod ()

	getReviewMethodKey ($method=null)

	getReviewRoundId ()

	getRound ()

	getStageId ()

	getStatus ()

	getStatusKey ($status=null)

	getSubmissionId ()

	getUnconsidered ()

	getWeeksDue ()

	isRead ()

	setCancelled ($cancelled)

	setComments ($comments)

	setCompetingInterests ($competingInterests)

	setDateAcknowledged ($dateAcknowledged)

	setDateAssigned ($dateAssigned)

	setDateCompleted ($dateCompleted)

	setDateConfirmed ($dateConfirmed)

	setDateDue ($dateDue)

	setDateNotified ($dateNotified)

	setDateRated ($dateRated)

	setDateReminded ($dateReminded)

	setDateResponseDue ($dateResponseDue)

	setDeclined ($declined)

	setLastModified ($dateModified)

	setQuality ($quality)

	setRecommendation ($recommendation)

	setReminderWasAutomatic ($wasAutomatic)

	setReviewerFullName ($reviewerFullName)

	setReviewerId ($reviewerId)

	setReviewFormId ($reviewFormId)

	setReviewMethod ($method)

	setReviewRoundId ($reviewRoundId)

	setRound ($round)

	setStageId ($stageId)

	setSubmissionId ($submissionId)

	setUnconsidered ($unconsidered)

	stampModified ()

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	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)

Static Public Member Functions
static	getReviewerRecommendationOptions ()

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

Describes review assignment properties.

See also: ReviewAssignmentDAO

Definition at line 50 of file ReviewAssignment.inc.php.

Member Function Documentation

◆ getCancelled()

ReviewAssignment::getCancelled ( )

Get the cancelled value.

Returns: boolean

Definition at line 403 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus().

◆ getComments()

ReviewAssignment::getComments ( )

Get reviewer comments.

Returns: string

Definition at line 108 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getCompetingInterests()

ReviewAssignment::getCompetingInterests ( )

Get competing interests.

Returns: string

Definition at line 124 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getDateAcknowledged()

ReviewAssignment::getDateAcknowledged ( )

Get the reviewer's acknowledged date.

Returns: string

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

References DataObject\getData().

Referenced by getStatus().

◆ getDateAssigned()

ReviewAssignment::getDateAssigned ( )

Get the reviewer's assigned date.

Returns: string

Definition at line 259 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getDateCompleted()

ReviewAssignment::getDateCompleted ( )

Get the reviewer's completed date.

Returns: string

Definition at line 307 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus().

◆ getDateConfirmed()

ReviewAssignment::getDateConfirmed ( )

Get the reviewer's confirmed date.

Returns: string

Definition at line 291 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus().

◆ getDateDue()

ReviewAssignment::getDateDue ( )

Get the reviewer's due date.

Returns: string

Definition at line 355 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus(), and getWeeksDue().

◆ getDateNotified()

ReviewAssignment::getDateNotified ( )

Get the reviewer's notified date.

Returns: string

Definition at line 275 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getDateRated()

ReviewAssignment::getDateRated ( )

Get the date the reviewer was rated.

Returns: string

Definition at line 220 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getDateReminded()

ReviewAssignment::getDateReminded ( )

Get the reviewer's last reminder date.

Returns: string

Definition at line 339 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getDateResponseDue()

ReviewAssignment::getDateResponseDue ( )

Get the reviewer's response due date.

Returns: string

Definition at line 371 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus().

◆ getDeclined()

ReviewAssignment::getDeclined ( )

Get the declined value.

Returns: boolean

Definition at line 387 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getStatus().

◆ getLastModified()

ReviewAssignment::getLastModified ( )

Get the date of the last modification.

Returns: date

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

References DataObject\getData().

◆ getLocalizedRecommendation()

ReviewAssignment::getLocalizedRecommendation ( )

Return a localized string representing the reviewer recommendation.

Definition at line 673 of file ReviewAssignment.inc.php.

References getRecommendation(), and getReviewerRecommendationOptions().

◆ getQuality()

ReviewAssignment::getQuality ( )

Get quality.

Returns: int|null

Definition at line 435 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getRecommendation()

ReviewAssignment::getRecommendation ( )

Get reviewer recommendation.

Returns: string

Definition at line 188 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getLocalizedRecommendation().

◆ getReminderWasAutomatic()

ReviewAssignment::getReminderWasAutomatic ( )

Get a boolean indicating whether or not the last reminder was automatic.

Returns: boolean

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

References DataObject\getData().

◆ getReviewerFullName()

ReviewAssignment::getReviewerFullName ( )

Get full name of reviewer.

Returns: string

Definition at line 92 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getReviewerId()

ReviewAssignment::getReviewerId ( )

Get ID of reviewer.

Returns: int

Definition at line 76 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getReviewerRecommendationOptions()

static ReviewAssignment::getReviewerRecommendationOptions ( )

static

Get an associative array matching reviewer recommendation codes with locale strings. (Includes default '' => "Choose One" string.)

Returns: array recommendation => localeString

Definition at line 656 of file ReviewAssignment.inc.php.

Referenced by PKPReviewerReviewStep3Form\fetch(), getLocalizedRecommendation(), AuthorReviewerGridHandler\readReview(), and PKPReviewerGridHandler\readReview().

◆ getReviewFormId()

ReviewAssignment::getReviewFormId ( )

Get review form id.

Returns: int

Definition at line 467 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getReviewMethod()

ReviewAssignment::getReviewMethod ( )

Get the method of the review (open, blind, or double-blind).

Returns: int

Definition at line 156 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by getReviewMethodKey().

◆ getReviewMethodKey()

ReviewAssignment::getReviewMethodKey ( $method = null )

Get the translation key for the review method

Parameters

$method int|null Optionally pass a method to retrieve a specific key. Default will return the key for the current review method

Returns: string

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

References getReviewMethod().

◆ getReviewRoundId()

ReviewAssignment::getReviewRoundId ( )

Get review round id.

Returns: int

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

References DataObject\getData().

◆ getRound()

ReviewAssignment::getRound ( )

Get round.

Returns: int

Definition at line 451 of file ReviewAssignment.inc.php.

References DataObject\getData().

◆ getStageId()

ReviewAssignment::getStageId ( )

Get the workflow stage id.

Returns: int WORKFLOW_STAGE_ID_...

Definition at line 140 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by isRead().

◆ getStatus()

ReviewAssignment::getStatus ( )

Get the current status of this review assignment

Returns: int REVIEW_ASSIGNMENT_STATUS_...

Definition at line 483 of file ReviewAssignment.inc.php.

References getCancelled(), getDateAcknowledged(), getDateCompleted(), getDateConfirmed(), getDateDue(), getDateResponseDue(), getDeclined(), getUnconsidered(), and isRead().

Referenced by getStatusKey().

◆ getStatusKey()

ReviewAssignment::getStatusKey ( $status = null )

Get the translation key for the current status

Parameters

int $status Optionally pass a status to retrieve a specific key. Default will return the key for the current status.

Returns: string

Definition at line 580 of file ReviewAssignment.inc.php.

References getStatus().

◆ getSubmissionId()

ReviewAssignment::getSubmissionId ( )

Get ID of review assignment's submission.

Returns: int

Definition at line 60 of file ReviewAssignment.inc.php.

References DataObject\getData().

Referenced by isRead().

◆ getUnconsidered()

ReviewAssignment::getUnconsidered ( )

Get unconsidered state.

Returns: int

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

References DataObject\getData().

Referenced by getStatus().

◆ getWeeksDue()

ReviewAssignment::getWeeksDue ( )

Get number of weeks until review is due (or number of weeks overdue).

Returns: int

Definition at line 645 of file ReviewAssignment.inc.php.

References getDateDue().

◆ isRead()

ReviewAssignment::isRead ( )

Determine whether an editorial user has read this review

Returns: bool

Definition at line 532 of file ReviewAssignment.inc.php.

References DAORegistry\getDAO(), getStageId(), and getSubmissionId().

Referenced by getStatus().

◆ setCancelled()

ReviewAssignment::setCancelled ( $cancelled )

Set the reviewer's cancelled value.

Parameters

$cancelled boolean

Definition at line 411 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setComments()

ReviewAssignment::setComments ( $comments )

Set reviewer comments.

Parameters

$comments string

Definition at line 116 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setCompetingInterests()

ReviewAssignment::setCompetingInterests ( $competingInterests )

Set competing interests.

Parameters

$competingInterests string

Definition at line 132 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateAcknowledged()

ReviewAssignment::setDateAcknowledged ( $dateAcknowledged )

Set the reviewer's acknowledged date.

Parameters

$dateAcknowledged string

Definition at line 331 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateAssigned()

ReviewAssignment::setDateAssigned ( $dateAssigned )

Set the reviewer's assigned date.

Parameters

$dateAssigned string

Definition at line 267 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateCompleted()

ReviewAssignment::setDateCompleted ( $dateCompleted )

Set the reviewer's completed date.

Parameters

$dateCompleted string

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

References DataObject\setData().

◆ setDateConfirmed()

ReviewAssignment::setDateConfirmed ( $dateConfirmed )

Set the reviewer's confirmed date.

Parameters

$dateConfirmed string

Definition at line 299 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateDue()

ReviewAssignment::setDateDue ( $dateDue )

Set the reviewer's due date.

Parameters

$dateDue string

Definition at line 363 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateNotified()

ReviewAssignment::setDateNotified ( $dateNotified )

Set the reviewer's notified date.

Parameters

$dateNotified string

Definition at line 283 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateRated()

ReviewAssignment::setDateRated ( $dateRated )

Set the date the reviewer was rated.

Parameters

$dateRated string

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

References DataObject\setData().

◆ setDateReminded()

ReviewAssignment::setDateReminded ( $dateReminded )

Set the reviewer's last reminder date.

Parameters

$dateReminded string

Definition at line 347 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDateResponseDue()

ReviewAssignment::setDateResponseDue ( $dateResponseDue )

Set the reviewer's response due date.

Parameters

$dateResponseDue string

Definition at line 379 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setDeclined()

ReviewAssignment::setDeclined ( $declined )

Set the reviewer's declined value.

Parameters

$declined boolean

Definition at line 395 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setLastModified()

ReviewAssignment::setLastModified ( $dateModified )

Set the date of the last modification.

Parameters

$dateModified date

Definition at line 244 of file ReviewAssignment.inc.php.

References DataObject\setData().

Referenced by stampModified().

◆ setQuality()

ReviewAssignment::setQuality ( $quality )

Set quality.

Parameters

$quality int|null

Definition at line 443 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setRecommendation()

ReviewAssignment::setRecommendation ( $recommendation )

Set reviewer recommendation.

Parameters

$recommendation string

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

References DataObject\setData().

◆ setReminderWasAutomatic()

ReviewAssignment::setReminderWasAutomatic ( $wasAutomatic )

Set the boolean indicating whether or not the last reminder was automatic.

Parameters

$wasAutomatic boolean

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

References DataObject\setData().

◆ setReviewerFullName()

ReviewAssignment::setReviewerFullName ( $reviewerFullName )

Set full name of reviewer.

Parameters

$reviewerFullName string

Definition at line 100 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setReviewerId()

ReviewAssignment::setReviewerId ( $reviewerId )

Set ID of reviewer.

Parameters

$reviewerId int

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

References DataObject\setData().

◆ setReviewFormId()

ReviewAssignment::setReviewFormId ( $reviewFormId )

Set review form id.

Parameters

$reviewFormId int

Definition at line 475 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setReviewMethod()

ReviewAssignment::setReviewMethod ( $method )

Set the type of review.

Parameters

$method int

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

References DataObject\setData().

◆ setReviewRoundId()

ReviewAssignment::setReviewRoundId ( $reviewRoundId )

Set review round id.

Parameters

$reviewRoundId int

Definition at line 180 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setRound()

ReviewAssignment::setRound ( $round )

Set round.

Parameters

$round int

Definition at line 459 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setStageId()

ReviewAssignment::setStageId ( $stageId )

Set the workflow stage id.

Parameters

$stageId int WORKFLOW_STAGE_ID_...

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

References DataObject\setData().

◆ setSubmissionId()

ReviewAssignment::setSubmissionId ( $submissionId )

Set ID of review assignment's submission

Parameters

$submissionId int

Definition at line 68 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ setUnconsidered()

ReviewAssignment::setUnconsidered ( $unconsidered )

Set unconsidered state.

Parameters

$unconsidered int

Definition at line 212 of file ReviewAssignment.inc.php.

References DataObject\setData().

◆ stampModified()

ReviewAssignment::stampModified ( )

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

Definition at line 251 of file ReviewAssignment.inc.php.

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

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

ReviewAssignment.inc.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getCancelled()

◆ getComments()

◆ getCompetingInterests()

◆ getDateAcknowledged()

◆ getDateAssigned()

◆ getDateCompleted()

◆ getDateConfirmed()

◆ getDateDue()

◆ getDateNotified()

◆ getDateRated()

◆ getDateReminded()

◆ getDateResponseDue()

◆ getDeclined()

◆ getLastModified()

◆ getLocalizedRecommendation()

◆ getQuality()

◆ getRecommendation()

◆ getReminderWasAutomatic()

◆ getReviewerFullName()

◆ getReviewerId()

◆ getReviewerRecommendationOptions()

◆ getReviewFormId()

◆ getReviewMethod()

◆ getReviewMethodKey()

◆ getReviewRoundId()

◆ getRound()

◆ getStageId()

◆ getStatus()

◆ getStatusKey()

◆ getSubmissionId()

◆ getUnconsidered()

◆ getWeeksDue()

◆ isRead()

◆ setCancelled()

◆ setComments()

◆ setCompetingInterests()

◆ setDateAcknowledged()

◆ setDateAssigned()

◆ setDateCompleted()

◆ setDateConfirmed()

◆ setDateDue()

◆ setDateNotified()

◆ setDateRated()

◆ setDateReminded()

◆ setDateResponseDue()

◆ setDeclined()

◆ setLastModified()

◆ setQuality()

◆ setRecommendation()

◆ setReminderWasAutomatic()

◆ setReviewerFullName()

◆ setReviewerId()

◆ setReviewFormId()

◆ setReviewMethod()

◆ setReviewRoundId()

◆ setRound()

◆ setStageId()

◆ setSubmissionId()

◆ setUnconsidered()

◆ stampModified()