JournalReportIterator Class Reference
[Journal]
Wrapper around DBRowIterator providing "factory" features for journal reports.
More...
Public Member Functions | |
| _cleanup () | |
| getMaxAuthors () | |
| getMaxEditors () | |
| getMaxReviewers () | |
| & | getSection ($sectionId) |
| JournalReportIterator ($journalId, &$records, $dateStart, $dateEnd, $reportType) | |
| & | next () |
| & | nextWithKey () |
Detailed Description
Wrapper around DBRowIterator providing "factory" features for journal reports.Definition at line 21 of file JournalReportIterator.inc.php.
Member Function Documentation
| JournalReportIterator._cleanup | ( | ) |
PRIVATE function used internally to clean up the record set. This is called aggressively because it can free resources.
Reimplemented from DBRowIterator.
Definition at line 247 of file JournalReportIterator.inc.php.
| JournalReportIterator.getMaxAuthors | ( | ) |
Return the maximum number of authors that can be expected for a single article in this report.
Definition at line 255 of file JournalReportIterator.inc.php.
Referenced by next().
| JournalReportIterator.getMaxEditors | ( | ) |
Return the maximum number of editors that can be expected for a single article in this report. This call can be used for all report types EXCEPT, of course, REPORT_TYPE_EDITOR.
Definition at line 272 of file JournalReportIterator.inc.php.
Referenced by next().
| JournalReportIterator.getMaxReviewers | ( | ) |
Return the maximum number of reviewers that can be expected for a single article in this report.
Definition at line 263 of file JournalReportIterator.inc.php.
Referenced by next().
| & JournalReportIterator.getSection | ( | $ | sectionId | ) |
Get a section (cached) by ID.
- Parameters:
-
$sectionId int
- Returns:
- object
Definition at line 100 of file JournalReportIterator.inc.php.
Referenced by next().
| JournalReportIterator.JournalReportIterator | ( | $ | journalId, | |
| &$ | records, | |||
| $ | dateStart, | |||
| $ | dateEnd, | |||
| $ | reportType | |||
| ) |
Constructor. Initialize the JournalReportIterator
- Parameters:
-
$journalId int ID of journal this report is generated on $records object ADO record set $dateStart string optional $dateEnd string optional $reportType int REPORT_TYPE_...
Definition at line 73 of file JournalReportIterator.inc.php.
References DBRowIterator.$records, and DAORegistry.getDAO().
| & JournalReportIterator.next | ( | ) |
Return the object representing the next row.
- Returns:
- object
Reimplemented from DBRowIterator.
Definition at line 111 of file JournalReportIterator.inc.php.
References SectionEditorSubmission.getEditorDecisionOptions(), getMaxAuthors(), getMaxEditors(), getMaxReviewers(), ReviewAssignment.getReviewerRatingOptions(), getSection(), and Locale.translate().
Referenced by nextWithKey().
| & JournalReportIterator.nextWithKey | ( | ) |
Return the next row, with key.
- Returns:
- array ($key, $value)
Reimplemented from DBRowIterator.
Definition at line 241 of file JournalReportIterator.inc.php.
References next().
The documentation for this class was generated from the following file:
- classes/journal/JournalReportIterator.inc.php
