Open Journal Systems
3.3.0
|
Public Member Functions | |
_cacheMiss ($cache, $id) | |
_fromRow ($row) | |
& | _getCache () |
customSectionOrderingExists ($issueId) | |
deleteById ($sectionId, $contextId=null) | |
deleteByJournalId ($journalId) | |
deleteCustomSection ($issueId, $sectionId) | |
deleteCustomSectionOrdering ($issueId) | |
getAll ($rangeInfo=null) | |
getByAbbrev ($sectionAbbrev, $journalId, $locale=null) | |
getByContextId ($journalId, $rangeInfo=null, $submittableOnly=false) | |
getById ($sectionId, $journalId=null, $useCache=false) | |
getByIssueId ($issueId) | |
getByJournalId ($journalId, $rangeInfo=null) | |
getBySubmissionId ($submissionId) | |
getByTitle ($sectionTitle, $journalId, $locale=null) | |
getCustomSectionOrder ($issueId, $sectionId) | |
getEditorSections ($journalId) | |
getEmptyByJournalId ($journalId) | |
getInsertId () | |
getLocaleFieldNames () | |
insertCustomSectionOrder ($issueId, $sectionId, $seq) | |
insertObject ($section) | |
newDataObject () | |
resequenceCustomSectionOrders ($issueId) | |
resequenceSections ($journalId) | |
sectionExists ($sectionId, $journalId) | |
setDefaultCustomSectionOrders ($issueId) | |
updateCustomSectionOrder ($issueId, $sectionId, $seq) | |
updateLocaleFields ($section) | |
updateObject ($section) | |
Public Member Functions inherited from PKPSectionDAO | |
deleteByContextId ($contextId) | |
deleteObject ($section) | |
getById ($sectionId, $contextId=null) | |
getTitlesByContextId ($contextId, $submittableOnly=false) | |
Public Member Functions inherited from DAO | |
__construct ($dataSource=null, $callHooks=true) | |
concat () | |
convertFromDB ($value, $type) | |
convertToDB ($value, &$type) | |
dateFromDB ($d) | |
datetimeFromDB ($dt) | |
datetimeToDB ($dt) | |
dateToDB ($d) | |
flushCache () | |
formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true) | |
getAdditionalFieldNames () | |
getAffectedRows () | |
getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
getDataSource () | |
getDirectionMapping ($direction) | |
getDriver () | |
getType ($value) | |
handleError ($dataSource, $sql) | |
nullOrInt ($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) | |
Data Fields | |
$cache | |
Data Fields inherited from DAO | |
$_dataSource | |
Protected Member Functions | |
_getContextIdColumnName () | |
_getTableName () | |
Protected Member Functions inherited from DAO | |
_getInsertId ($table='', $id='') | |
Additional Inherited Members | |
Static Public Member Functions inherited from DAO | |
static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
Operations for retrieving and modifying Section objects.
Definition at line 20 of file SectionDAO.inc.php.
SectionDAO::_cacheMiss | ( | $cache, | |
$id | |||
) |
Definition at line 41 of file SectionDAO.inc.php.
SectionDAO::_fromRow | ( | $row | ) |
Internal function to return a Section object from a row.
$row | array |
Reimplemented from PKPSectionDAO.
Definition at line 186 of file SectionDAO.inc.php.
References HookRegistry\call(), and DAO\getDataObjectSettings().
Referenced by getByAbbrev(), getById(), getByIssueId(), getBySubmissionId(), getByTitle(), and getEditorSections().
& SectionDAO::_getCache | ( | ) |
Definition at line 47 of file SectionDAO.inc.php.
References $cache, and CacheManager\getManager().
Referenced by getById().
|
protected |
Get the name of the context ID table column
Definition at line 37 of file SectionDAO.inc.php.
|
protected |
Get the name of the section table in the database
Definition at line 28 of file SectionDAO.inc.php.
SectionDAO::customSectionOrderingExists | ( | $issueId | ) |
Check if an issue has custom section ordering.
$issueId | int |
Definition at line 568 of file SectionDAO.inc.php.
References DAO\retrieve().
SectionDAO::deleteById | ( | $sectionId, | |
$contextId = null |
|||
) |
Delete a section by ID.
$sectionId | int Section ID |
$contextId | int optional |
Reimplemented from PKPSectionDAO.
Definition at line 299 of file SectionDAO.inc.php.
References DAORegistry\getDAO(), sectionExists(), and DAO\update().
SectionDAO::deleteByJournalId | ( | $journalId | ) |
Delete sections by journal ID NOTE: This does not delete dependent entries EXCEPT from subeditor_submission_group. It is intended to be called only when deleting a journal.
$journalId | int Journal ID |
Definition at line 318 of file SectionDAO.inc.php.
References PKPSectionDAO\deleteByContextId().
SectionDAO::deleteCustomSection | ( | $issueId, | |
$sectionId | |||
) |
Delete a section from the custom section order table.
$issueId | int |
$sectionId | int |
Definition at line 526 of file SectionDAO.inc.php.
References getCustomSectionOrder(), and DAO\update().
SectionDAO::deleteCustomSectionOrdering | ( | $issueId | ) |
Delete the custom ordering of an issue's sections.
$issueId | int |
Definition at line 515 of file SectionDAO.inc.php.
References DAO\update().
SectionDAO::getAll | ( | $rangeInfo = null | ) |
Retrieve all sections.
$rangeInfo | DBResultRange optional |
Definition at line 431 of file SectionDAO.inc.php.
References DAO\retrieveRange().
SectionDAO::getByAbbrev | ( | $sectionAbbrev, | |
$journalId, | |||
$locale = null |
|||
) |
Retrieve a section by abbreviation.
$sectionAbbrev | string |
$journalId | int Journal ID |
$locale | string optional |
Definition at line 94 of file SectionDAO.inc.php.
References _fromRow(), and DAO\retrieve().
SectionDAO::getByContextId | ( | $journalId, | |
$rangeInfo = null , |
|||
$submittableOnly = false |
|||
) |
Retrieve all sections for a journal.
$journalId | int Journal ID |
$rangeInfo | DBResultRange optional |
$submittableOnly | boolean optional. Whether to return only sections that can be submitted to by anyone. |
Reimplemented from PKPSectionDAO.
Definition at line 417 of file SectionDAO.inc.php.
References DAO\retrieveRange().
Referenced by getByJournalId().
SectionDAO::getById | ( | $sectionId, | |
$journalId = null , |
|||
$useCache = false |
|||
) |
Retrieve a section by ID.
$sectionId | int |
$journalId | int Journal ID optional |
$useCache | boolean optional |
Definition at line 62 of file SectionDAO.inc.php.
References $cache, _fromRow(), _getCache(), and DAO\retrieve().
Referenced by _cacheMiss().
SectionDAO::getByIssueId | ( | $issueId | ) |
Retrieve all sections in which articles are currently published in the given issue.
$issueId | int Issue ID |
Definition at line 358 of file SectionDAO.inc.php.
References _fromRow(), PKPServices\get(), and DAO\retrieve().
Referenced by setDefaultCustomSectionOrders().
SectionDAO::getByJournalId | ( | $journalId, | |
$rangeInfo = null |
|||
) |
Retrieve all sections for a journal.
$journalId | int Journal ID |
$rangeInfo | DBResultRange optional |
Definition at line 405 of file SectionDAO.inc.php.
References getByContextId().
SectionDAO::getBySubmissionId | ( | $submissionId | ) |
Retrieve section a submission is assigned to.
$submissionId | int Submission id |
Definition at line 158 of file SectionDAO.inc.php.
References _fromRow(), and DAO\retrieve().
SectionDAO::getByTitle | ( | $sectionTitle, | |
$journalId, | |||
$locale = null |
|||
) |
Retrieve a section by title.
$sectionTitle | string |
$journalId | int Journal ID |
$locale | string optional |
Definition at line 127 of file SectionDAO.inc.php.
References _fromRow(), and DAO\retrieve().
SectionDAO::getCustomSectionOrder | ( | $issueId, | |
$sectionId | |||
) |
Get the custom section order of a section.
$issueId | int |
$sectionId | int |
Definition at line 584 of file SectionDAO.inc.php.
References DAO\retrieve().
Referenced by deleteCustomSection().
SectionDAO::getEditorSections | ( | $journalId | ) |
Retrieve an array associating all section editor IDs with arrays containing the sections they edit.
$journalId | int Journal ID |
Definition at line 328 of file SectionDAO.inc.php.
References _fromRow(), and DAO\retrieve().
SectionDAO::getEmptyByJournalId | ( | $journalId | ) |
Retrieve all empty (without articles) section ids for a journal.
$journalId | int Journal ID |
Definition at line 445 of file SectionDAO.inc.php.
References DAO\retrieve().
SectionDAO::getInsertId | ( | ) |
Get the ID of the last inserted section.
Definition at line 506 of file SectionDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
SectionDAO::getLocaleFieldNames | ( | ) |
Get the list of fields for which data can be localized.
Reimplemented from PKPSectionDAO.
Definition at line 210 of file SectionDAO.inc.php.
SectionDAO::insertCustomSectionOrder | ( | $issueId, | |
$sectionId, | |||
$seq | |||
) |
INTERNAL USE ONLY: Insert a custom section ordering
$issueId | int |
$sectionId | int |
$seq | int |
Definition at line 618 of file SectionDAO.inc.php.
References DAO\update().
Referenced by setDefaultCustomSectionOrders().
SectionDAO::insertObject | ( | $section | ) |
Insert a new section.
$section | Section |
Definition at line 232 of file SectionDAO.inc.php.
References getInsertId(), DAO\update(), and updateLocaleFields().
SectionDAO::newDataObject | ( | ) |
Return a new data object.
Reimplemented from PKPSectionDAO.
Definition at line 177 of file SectionDAO.inc.php.
SectionDAO::resequenceCustomSectionOrders | ( | $issueId | ) |
Sequentially renumber custom section orderings in their sequence order.
$issueId | int |
Definition at line 545 of file SectionDAO.inc.php.
References DAO\retrieve(), and DAO\update().
SectionDAO::resequenceSections | ( | $journalId | ) |
Sequentially renumber sections in their sequence order.
$journalId | int Journal ID |
Definition at line 481 of file SectionDAO.inc.php.
References DAO\retrieve(), and DAO\update().
SectionDAO::sectionExists | ( | $sectionId, | |
$journalId | |||
) |
Check if a section exists with the specified ID.
Definition at line 466 of file SectionDAO.inc.php.
References DAO\retrieve().
Referenced by deleteById().
SectionDAO::setDefaultCustomSectionOrders | ( | $issueId | ) |
Import the current section orders into the specified issue as custom issue orderings.
$issueId | int |
Definition at line 603 of file SectionDAO.inc.php.
References getByIssueId(), and insertCustomSectionOrder().
SectionDAO::updateCustomSectionOrder | ( | $issueId, | |
$sectionId, | |||
$seq | |||
) |
Update a custom section ordering
$issueId | int |
$sectionId | int |
$seq | int |
Definition at line 631 of file SectionDAO.inc.php.
References DAO\update().
SectionDAO::updateLocaleFields | ( | $section | ) |
Update the localized fields for this table
$section | object |
Definition at line 221 of file SectionDAO.inc.php.
References DAO\updateDataObjectSettings().
Referenced by insertObject(), and updateObject().
SectionDAO::updateObject | ( | $section | ) |
Update an existing section.
$section | Section |
Definition at line 262 of file SectionDAO.inc.php.
References DAO\update(), and updateLocaleFields().
SectionDAO::$cache |
Definition at line 21 of file SectionDAO.inc.php.
Referenced by _cacheMiss(), _getCache(), and getById().