Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
SectionEditorSubmissionDAO Class Reference
Inheritance diagram for SectionEditorSubmissionDAO:
DAO

Public Member Functions

 _generateUserNameSearchSQL ($search, $searchMatch, $prefix, &$params)
 
_getUnfilteredSectionEditorSubmissions ($sectionEditorId, $journalId, $sectionId=0, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $additionalWhereSql= '', $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
_returnSectionEditorSubmissionFromRow (&$row)
 
 copyeditorExists ($articleId, $copyeditorId)
 
 deleteDecisionsByArticle ($articleId)
 
 deleteReviewRoundsByArticle ($articleId)
 
 getCopyeditorStatistics ($journalId)
 
 getEditorDecisions ($articleId, $round=null)
 
 getLayoutEditorStatistics ($journalId)
 
 getMaxReviewRound ($articleId)
 
 getProofreaderStatistics ($journalId)
 
getReviewersForArticle ($journalId, $articleId, $round, $searchType=null, $search=null, $searchMatch=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getReviewersNotAssignedToArticle ($journalId, $articleId)
 
 getReviewerStatistics ($journalId)
 
getSectionEditorSubmission ($articleId)
 
getSectionEditorSubmissions ($sectionEditorId, $journalId, $status=true)
 
getSectionEditorSubmissionsArchives ($sectionEditorId, $journalId, $sectionId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getSectionEditorSubmissionsCount ($sectionEditorId, $journalId)
 
getSectionEditorSubmissionsInEditing ($sectionEditorId, $journalId, $sectionId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getSectionEditorSubmissionsInReview ($sectionEditorId, $journalId, $sectionId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
 getSortMapping ($heading)
 
 reviewerExists ($articleId, $reviewerId, $round)
 
 reviewRoundExists ($articleId, $round)
 
 SectionEditorSubmissionDAO ()
 
 updateSectionEditorSubmission (&$sectionEditorSubmission)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying SectionEditorSubmission objects.

See Also
SectionEditorSubmission

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

Member Function Documentation

SectionEditorSubmissionDAO::_generateUserNameSearchSQL (   $search,
  $searchMatch,
  $prefix,
$params 
)

FIXME Move this into somewhere common (SubmissionDAO?) as this is used in several classes.

Definition at line 470 of file SectionEditorSubmissionDAO.inc.php.

References DAO\concat().

Referenced by _getUnfilteredSectionEditorSubmissions().

& SectionEditorSubmissionDAO::_getUnfilteredSectionEditorSubmissions (   $sectionEditorId,
  $journalId,
  $sectionId = 0,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $additionalWhereSql = '',
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)
& SectionEditorSubmissionDAO::_returnSectionEditorSubmissionFromRow ( $row)

Internal function to return a SectionEditorSubmission object from a row.

Parameters
$rowarray
Returns
SectionEditorSubmission

Definition at line 107 of file SectionEditorSubmissionDAO.inc.php.

References HookRegistry\call(), and getEditorDecisions().

Referenced by getSectionEditorSubmission(), and getSectionEditorSubmissions().

SectionEditorSubmissionDAO::copyeditorExists (   $articleId,
  $copyeditorId 
)

Check if a copyeditor is assigned to a specified article.

Parameters
$articleIdint
$copyeditorIdint
Returns
boolean

Definition at line 874 of file SectionEditorSubmissionDAO.inc.php.

References DAO\retrieve().

SectionEditorSubmissionDAO::deleteDecisionsByArticle (   $articleId)

Delete copyediting assignments by article.

Parameters
$articleIdint

Definition at line 622 of file SectionEditorSubmissionDAO.inc.php.

References DAO\update().

SectionEditorSubmissionDAO::deleteReviewRoundsByArticle (   $articleId)

Delete review rounds article.

Parameters
$articleIdint

Definition at line 633 of file SectionEditorSubmissionDAO.inc.php.

References DAO\update().

SectionEditorSubmissionDAO::getCopyeditorStatistics (   $journalId)

Get the assignment counts and last assigned date for all copyeditors of the given journal.

Returns
array

Definition at line 1020 of file SectionEditorSubmissionDAO.inc.php.

References DAO\datetimeFromDB(), and DAO\retrieve().

SectionEditorSubmissionDAO::getEditorDecisions (   $articleId,
  $round = null 
)

Get the editor decisions for a review round of an article.

Parameters
$articleIdint
$roundint

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

References DAO\retrieve().

Referenced by _returnSectionEditorSubmissionFromRow().

SectionEditorSubmissionDAO::getLayoutEditorStatistics (   $journalId)

Get the assignment counts and last assigned date for all layout editors of the given journal.

Returns
array

Definition at line 885 of file SectionEditorSubmissionDAO.inc.php.

References DAO\datetimeFromDB(), and DAO\retrieve().

SectionEditorSubmissionDAO::getMaxReviewRound (   $articleId)

Get the highest review round.

Parameters
$articleIdint
Returns
int

Definition at line 679 of file SectionEditorSubmissionDAO.inc.php.

References DAO\retrieve().

SectionEditorSubmissionDAO::getProofreaderStatistics (   $journalId)

Get the assignment counts and last assigned date for all proofreaders of the given journal.

Returns
array

Definition at line 1066 of file SectionEditorSubmissionDAO.inc.php.

References DAO\datetimeFromDB(), and DAO\retrieve().

& SectionEditorSubmissionDAO::getReviewersForArticle (   $journalId,
  $articleId,
  $round,
  $searchType = null,
  $search = null,
  $searchMatch = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Retrieve a list of all reviewers with respect to an article's current round.

Parameters
$journalIdint
$articleIdint
$roundint
$searchTypeint USER_FIELD_...
$searchstring
$searchMatchstring "is" or "contains" or "startsWith"
$rangeInfoRangeInfo optional
Returns
DAOResultFactory containing matching Users

Definition at line 738 of file SectionEditorSubmissionDAO.inc.php.

References DAO\getDirectionMapping(), and DAO\retrieveRange().

& SectionEditorSubmissionDAO::getReviewersNotAssignedToArticle (   $journalId,
  $articleId 
)

Retrieve a list of all reviewers not assigned to the specified article.

Parameters
$journalIdint
$articleIdint
Returns
array matching Users

Definition at line 842 of file SectionEditorSubmissionDAO.inc.php.

References RoleDAO\getRoleIdFromPath(), and DAO\retrieve().

SectionEditorSubmissionDAO::getReviewerStatistics (   $journalId)

Get the last assigned and last completed dates for all reviewers of the given journal.

Returns
array

Definition at line 931 of file SectionEditorSubmissionDAO.inc.php.

References DAO\datetimeFromDB(), and DAO\retrieve().

& SectionEditorSubmissionDAO::getSectionEditorSubmission (   $articleId)

Retrieve a section editor submission by article ID.

Parameters
$articleIdint
Returns
EditorSubmission

Definition at line 62 of file SectionEditorSubmissionDAO.inc.php.

References _returnSectionEditorSubmissionFromRow(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and DAO\retrieve().

& SectionEditorSubmissionDAO::getSectionEditorSubmissions (   $sectionEditorId,
  $journalId,
  $status = true 
)

Get all section editor submissions for a section editor.

Parameters
$sectionEditorIdint
$statusboolean true if active, false if completed.
Returns
array SectionEditorSubmission

Definition at line 278 of file SectionEditorSubmissionDAO.inc.php.

References _returnSectionEditorSubmissionFromRow(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and DAO\retrieve().

& SectionEditorSubmissionDAO::getSectionEditorSubmissionsArchives (   $sectionEditorId,
  $journalId,
  $sectionId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions in archives for a journal.

Parameters
$journalIdint
$sectionIdint
$searchFieldint Symbolic SUBMISSION_FIELD_... identifier
$searchMatchstring "is" or "contains" or "startsWith"
$searchString to look in $searchField for
$dateFieldint Symbolic SUBMISSION_FIELD_DATE_... identifier
$dateFromString date to search from
$dateToString date to search to
$rangeInfoobject
Returns
array EditorSubmission

Definition at line 551 of file SectionEditorSubmissionDAO.inc.php.

References _getUnfilteredSectionEditorSubmissions().

& SectionEditorSubmissionDAO::getSectionEditorSubmissionsCount (   $sectionEditorId,
  $journalId 
)

Function used for counting purposes for right nav bar

Definition at line 566 of file SectionEditorSubmissionDAO.inc.php.

References DAO\retrieve().

& SectionEditorSubmissionDAO::getSectionEditorSubmissionsInEditing (   $sectionEditorId,
  $journalId,
  $sectionId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions in editing for a journal.

Parameters
$journalIdint
$sectionIdint
$searchFieldint Symbolic SUBMISSION_FIELD_... identifier
$searchMatchstring "is" or "contains" or "startsWith"
$searchString to look in $searchField for
$dateFieldint Symbolic SUBMISSION_FIELD_DATE_... identifier
$dateFromString date to search from
$dateToString date to search to
$rangeInfoobject
Returns
array EditorSubmission

Definition at line 526 of file SectionEditorSubmissionDAO.inc.php.

References _getUnfilteredSectionEditorSubmissions().

& SectionEditorSubmissionDAO::getSectionEditorSubmissionsInReview (   $sectionEditorId,
  $journalId,
  $sectionId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions in review for a journal.

Parameters
$journalIdint
$sectionIdint
$searchFieldint Symbolic SUBMISSION_FIELD_... identifier
$searchMatchstring "is" or "contains" or "startsWith"
$searchString to look in $searchField for
$dateFieldint Symbolic SUBMISSION_FIELD_DATE_... identifier
$dateFromString date to search from
$dateToString date to search to
$rangeInfoobject
Returns
array EditorSubmission

Definition at line 501 of file SectionEditorSubmissionDAO.inc.php.

References _getUnfilteredSectionEditorSubmissions().

SectionEditorSubmissionDAO::getSortMapping (   $heading)

Map a column heading value to a database value for sorting

Parameters
string
Returns
string

Definition at line 1112 of file SectionEditorSubmissionDAO.inc.php.

Referenced by _getUnfilteredSectionEditorSubmissions().

SectionEditorSubmissionDAO::reviewerExists (   $articleId,
  $reviewerId,
  $round 
)

Check if a reviewer is assigned to a specified article.

Parameters
$articleIdint
$reviewerIdint
Returns
boolean

Definition at line 715 of file SectionEditorSubmissionDAO.inc.php.

References DAO\retrieve().

SectionEditorSubmissionDAO::reviewRoundExists (   $articleId,
  $round 
)

Check if a review round exists for a specified article.

Parameters
$articleIdint
$roundint
Returns
boolean

Definition at line 697 of file SectionEditorSubmissionDAO.inc.php.

References DAO\retrieve().

Referenced by updateSectionEditorSubmission().

SectionEditorSubmissionDAO::SectionEditorSubmissionDAO ( )

Constructor.

Definition at line 41 of file SectionEditorSubmissionDAO.inc.php.

References DAORegistry\getDAO().

SectionEditorSubmissionDAO::updateSectionEditorSubmission ( $sectionEditorSubmission)

Update an existing section editor submission.

Parameters
$sectionEditorSubmissionSectionEditorSubmission

Definition at line 162 of file SectionEditorSubmissionDAO.inc.php.

References DAO\datetimeToDB(), DAO\getInsertId(), reviewRoundExists(), and DAO\update().


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