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

Public Member Functions

 _generateUserNameSearchSQL ($search, $searchMatch, $prefix, &$params)
 
_getUnfilteredEditorSubmissions ($journalId, $sectionId=0, $editorId=0, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $additionalWhereSql, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
_returnEditorSubmissionFromRow (&$row)
 
 EditorSubmissionDAO ()
 
 getEditorDecisions ($articleId, $round=null)
 
getEditorSubmission ($articleId)
 
getEditorSubmissions ($journalId, $sectionId, $editorId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getEditorSubmissionsArchives ($journalId, $sectionId, $editorId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getEditorSubmissionsCount ($journalId)
 
getEditorSubmissionsInEditing ($journalId, $sectionId, $editorId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getEditorSubmissionsInReview ($journalId, $sectionId, $editorId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
getEditorSubmissionsUnassigned ($journalId, $sectionId, $editorId, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
 getInsertEditId ()
 
 getSortMapping ($heading)
 
getUsersNotAssignedToArticle ($journalId, $articleId, $roleId, $searchType=null, $search=null, $searchMatch=null, $rangeInfo=null)
 
 insertEditorSubmission (&$editorSubmission)
 
 transferEditorDecisions ($oldUserId, $newUserId)
 
 updateEditorSubmission (&$editorSubmission)
 
- 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 EditorSubmission objects.

See Also
EditorSubmission

Definition at line 23 of file EditorSubmissionDAO.inc.php.

Member Function Documentation

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

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

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

References DAO\concat().

Referenced by _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::_getUnfilteredEditorSubmissions (   $journalId,
  $sectionId = 0,
  $editorId = 0,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $additionalWhereSql,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all unfiltered submissions for a journal.

Parameters
$journalIdint
$sectionIdint
$editorIdint
$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
$additionalWhereSqlString additional SQL "where" clause info
$rangeInfoobject
Returns
array result

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

References _generateUserNameSearchSQL(), DAO\datetimeToDB(), DAO\getDirectionMapping(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), getSortMapping(), and DAO\retrieveRange().

Referenced by getEditorSubmissions(), getEditorSubmissionsArchives(), getEditorSubmissionsInEditing(), getEditorSubmissionsInReview(), and getEditorSubmissionsUnassigned().

& EditorSubmissionDAO::_returnEditorSubmissionFromRow ( $row)

Internal function to return an EditorSubmission object from a row.

Parameters
$rowarray
Returns
EditorSubmission

Definition at line 90 of file EditorSubmissionDAO.inc.php.

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

Referenced by getEditorSubmission().

EditorSubmissionDAO::EditorSubmissionDAO ( )

Constructor.

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

References DAORegistry\getDAO().

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

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

Parameters
$articleIdint
$roundint

Definition at line 576 of file EditorSubmissionDAO.inc.php.

References DAO\retrieve().

Referenced by _returnEditorSubmissionFromRow().

& EditorSubmissionDAO::getEditorSubmission (   $articleId)

Retrieve an editor submission by article ID.

Parameters
$articleIdint
Returns
EditorSubmission

Definition at line 46 of file EditorSubmissionDAO.inc.php.

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

& EditorSubmissionDAO::getEditorSubmissions (   $journalId,
  $sectionId,
  $editorId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions for a journal.

Parameters
$journalIdint
$sectionIdint
$editorIdint
$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 477 of file EditorSubmissionDAO.inc.php.

References _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::getEditorSubmissionsArchives (   $journalId,
  $sectionId,
  $editorId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions archived for a journal.

Parameters
$journalIdint
$sectionIdint
$editorIdint
$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 451 of file EditorSubmissionDAO.inc.php.

References _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::getEditorSubmissionsCount (   $journalId)

Function used for counting purposes for right nav bar

Definition at line 492 of file EditorSubmissionDAO.inc.php.

References DAO\retrieve().

& EditorSubmissionDAO::getEditorSubmissionsInEditing (   $journalId,
  $sectionId,
  $editorId,
  $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
$editorIdint
$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 425 of file EditorSubmissionDAO.inc.php.

References _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::getEditorSubmissionsInReview (   $journalId,
  $sectionId,
  $editorId,
  $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
$editorIdint
$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 399 of file EditorSubmissionDAO.inc.php.

References _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::getEditorSubmissionsUnassigned (   $journalId,
  $sectionId,
  $editorId,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get all submissions unassigned for a journal.

Parameters
$journalIdint
$sectionIdint
$editorIdint
$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 373 of file EditorSubmissionDAO.inc.php.

References _getUnfilteredEditorSubmissions().

EditorSubmissionDAO::getInsertEditId ( )

Get the ID of the last inserted editor assignment.

Returns
int

Definition at line 685 of file EditorSubmissionDAO.inc.php.

References DAO\getInsertId().

Referenced by insertEditorSubmission().

EditorSubmissionDAO::getSortMapping (   $heading)

Map a column heading value to a database value for sorting

Parameters
string
Returns
string

Definition at line 694 of file EditorSubmissionDAO.inc.php.

Referenced by _getUnfilteredEditorSubmissions().

& EditorSubmissionDAO::getUsersNotAssignedToArticle (   $journalId,
  $articleId,
  $roleId,
  $searchType = null,
  $search = null,
  $searchMatch = null,
  $rangeInfo = null 
)

Retrieve a list of all users in the specified role not assigned as editors to the specified article.

Parameters
$journalIdint
$articleIdint
$roleIdint
Returns
DAOResultFactory containing matching Users

Definition at line 618 of file EditorSubmissionDAO.inc.php.

References DAO\retrieveRange().

EditorSubmissionDAO::insertEditorSubmission ( $editorSubmission)

Insert a new EditorSubmission.

Parameters
$editorSubmissionEditorSubmission

Definition at line 129 of file EditorSubmissionDAO.inc.php.

References DAO\datetimeToDB(), getInsertEditId(), and DAO\update().

EditorSubmissionDAO::transferEditorDecisions (   $oldUserId,
  $newUserId 
)

Get the editor decisions for an editor.

Parameters
$userIdint

Definition at line 604 of file EditorSubmissionDAO.inc.php.

References DAO\update().

EditorSubmissionDAO::updateEditorSubmission ( $editorSubmission)

Update an existing article.

Parameters
$articleArticle

Definition at line 158 of file EditorSubmissionDAO.inc.php.


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