DAO Class Reference
[Db]

Operations for retrieving and modifying objects from a database. More...

Inheritance diagram for DAO:

AccessKeyDAO AnnouncementDAO AnnouncementTypeDAO ArticleCommentDAO ArticleDAO ArticleEmailLogDAO ArticleEventLogDAO ArticleFileDAO ArticleGalleyDAO ArticleNoteDAO ArticleReportDAO ArticleSearchDAO AuthorDAO AuthorSubmissionDAO AuthSourceDAO CaptchaDAO CommentDAO CopyAssignmentDAO CopyeditorSubmissionDAO CountryDAO CurrencyDAO EditAssignmentDAO EditorSubmissionDAO EmailTemplateDAO GroupDAO GroupMembershipDAO IssueDAO JournalDAO JournalSettingsDAO JournalStatisticsDAO LayoutAssignmentDAO LayoutEditorSubmissionDAO LogEntryDAO NotificationStatusDAO OAIDAO OJSCompletedPaymentDAO PayPalDAO PluginSettingsDAO ProofAssignmentDAO ProofreaderSubmissionDAO PublishedArticleDAO QueuedPaymentDAO ReviewAssignmentDAO ReviewerSubmissionDAO ReviewFormDAO ReviewFormElementDAO ReviewFormResponseDAO RoleDAO RTDAO ScheduledTaskDAO SectionDAO SectionEditorsDAO SectionEditorSubmissionDAO SessionDAO SiteDAO SiteSettingsDAO SubscriptionDAO SubscriptionTypeDAO SuppFileDAO TemporaryFileDAO ThesisDAO UserDAO UserSettingsDAO VersionDAO

List of all members.

Public Member Functions

 convertFromDB ($value, $type)
 convertToDB ($value, &$type)
 DAO ($dataSource=null, $callHooks=true)
 dateFromDB ($d)
 datetimeFromDB ($dt)
 datetimeToDB ($dt)
 dateToDB ($d)
 flushCache ()
 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 ()
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)

Public Attributes

 $_dataSource


Detailed Description

Operations for retrieving and modifying objects from a database.

See also:
DAORegistry

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


Member Function Documentation

DAO.convertFromDB ( value,
type 
)

Convert a stored type from the database

Parameters:
$value string Value from DB
$type string Type from DB
Returns:
mixed

Definition at line 276 of file DAO.inc.php.

Referenced by ReviewFormResponseDAO._returnReviewFormResponseFromRow(), JournalSettingsDAO.getJournalSettings(), PluginSettingsDAO.getPluginSettings(), UserSettingsDAO.getSetting(), UserSettingsDAO.getSettingsByJournal(), and SiteSettingsDAO.getSiteSettings().

DAO.convertToDB ( value,
&$  type 
)

Convert a PHP variable into a string to be stored in the DB

Parameters:
$value mixed
$type string
Returns:
string

Definition at line 332 of file DAO.inc.php.

References getType().

Referenced by UserSettingsDAO.getUsersBySetting(), ReviewFormResponseDAO.insertReviewFormResponse(), ReviewFormResponseDAO.updateReviewFormResponse(), UserSettingsDAO.updateSetting(), SiteSettingsDAO.updateSetting(), PluginSettingsDAO.updateSetting(), and JournalSettingsDAO.updateSetting().

DAO.DAO ( dataSource = null,
callHooks = true 
)

Constructor. Initialize the database connection.

Definition at line 31 of file DAO.inc.php.

References HookRegistry.call(), and DBConnection.getConn().

DAO.dateFromDB ( d  ) 

Return date from DB as ISO date string.

Parameters:
$d string date from DB
Returns:
string

Definition at line 265 of file DAO.inc.php.

Referenced by AnnouncementDAO._returnAnnouncementFromRow(), SubscriptionDAO._returnSubscriptionFromRow(), SuppFileDAO._returnSuppFileFromRow(), and ThesisDAO._returnThesisFromRow().

DAO.datetimeFromDB ( dt  ) 

Return datetime from DB as ISO datetime string.

Parameters:
$dt string datetime from DB
Returns:
string

Definition at line 256 of file DAO.inc.php.

Referenced by ArticleDAO._articleFromRow(), AccessKeyDAO._returnAccessKeyFromRow(), AnnouncementDAO._returnAnnouncementFromRow(), ArticleCommentDAO._returnArticleCommentFromRow(), ArticleFileDAO._returnArticleFileFromRow(), ArticleNoteDAO._returnArticleNoteFromRow(), AuthorSubmissionDAO._returnAuthorSubmissionFromRow(), CaptchaDAO._returnCaptchaFromRow(), CommentDAO._returnCommentFromRow(), CopyAssignmentDAO._returnCopyAssignmentFromRow(), CopyeditorSubmissionDAO._returnCopyeditorSubmissionFromRow(), EditAssignmentDAO._returnEditAssignmentFromRow(), ArticleGalleyDAO._returnGalleyFromRow(), OAIDAO._returnIdentifierFromRow(), IssueDAO._returnIssueFromRow(), LayoutAssignmentDAO._returnLayoutAssignmentFromRow(), ArticleEventLogDAO._returnLogEntryFromRow(), ArticleEmailLogDAO._returnLogEntryFromRow(), OJSCompletedPaymentDAO._returnPaymentFromRow(), ProofAssignmentDAO._returnProofAssignmentFromRow(), OAIDAO._returnRecordFromRow(), ReviewAssignmentDAO._returnReviewAssignmentFromRow(), ReviewerSubmissionDAO._returnReviewerSubmissionFromRow(), SectionEditorSubmissionDAO._returnSectionEditorSubmissionFromRow(), PublishedArticleDAO._returnSimplePublishedArticleFromRow(), SuppFileDAO._returnSuppFileFromRow(), TemporaryFileDAO._returnTemporaryFileFromRow(), UserDAO._returnUserFromRow(), VersionDAO._returnVersionFromRow(), JournalStatisticsDAO.getArticleStatistics(), SectionEditorSubmissionDAO.getCopyeditorStatistics(), OAIDAO.getEarliestDatestamp(), ReviewAssignmentDAO.getEarliestNotificationByRound(), SectionEditorSubmissionDAO.getEditorDecisions(), ReviewerSubmissionDAO.getEditorDecisions(), EditorSubmissionDAO.getEditorDecisions(), AuthorSubmissionDAO.getEditorDecisions(), EditorSubmissionDAO.getEditorSubmissionsArchives(), EditorSubmissionDAO.getEditorSubmissionsInEditing(), ReviewAssignmentDAO.getLastModifiedByRound(), ScheduledTaskDAO.getLastRunTime(), SectionEditorSubmissionDAO.getLayoutEditorStatistics(), SectionEditorSubmissionDAO.getProofreaderStatistics(), PublishedArticleDAO.getPublishedArticleById(), SectionEditorSubmissionDAO.getReviewerStatistics(), and JournalStatisticsDAO.getReviewerStatistics().

DAO.datetimeToDB ( dt  ) 

Return datetime formatted for DB insertion.

Parameters:
$dt int/string *nix timestamp or ISO datetime string
Returns:
string

Definition at line 238 of file DAO.inc.php.

Referenced by AccessKeyDAO.deleteExpiredKeys(), AccessKeyDAO.getAccessKey(), AccessKeyDAO.getAccessKeyByKeyHash(), ThesisDAO.getActiveThesesByJournalId(), JournalStatisticsDAO.getArticleStatistics(), CopyeditorSubmissionDAO.getCopyeditorSubmissionsByCopyeditorId(), JournalStatisticsDAO.getEditorReport(), CaptchaDAO.getExpiredCaptchas(), OAIDAO.getIdentifiers(), JournalStatisticsDAO.getIssueStatistics(), JournalStatisticsDAO.getJournalReport(), JournalStatisticsDAO.getMaxAuthorCount(), JournalStatisticsDAO.getMaxEditorCount(), JournalStatisticsDAO.getMaxReviewerCount(), ArticleSearchDAO.getPhraseResults(), OAIDAO.getRecords(), JournalStatisticsDAO.getReviewerReport(), JournalStatisticsDAO.getReviewerStatistics(), JournalStatisticsDAO.getSectionReport(), ProofreaderSubmissionDAO.getSubmissions(), LayoutEditorSubmissionDAO.getSubmissions(), SubscriptionDAO.getSubscriptionsByJournalId(), JournalStatisticsDAO.getSubscriptionStatistics(), ThesisDAO.getThesesByJournalId(), EditorSubmissionDAO.getUnfilteredEditorSubmissions(), SectionEditorSubmissionDAO.getUnfilteredSectionEditorSubmissions(), JournalStatisticsDAO.getUserStatistics(), AccessKeyDAO.insertAccessKey(), ArticleDAO.insertArticle(), ArticleCommentDAO.insertArticleComment(), ArticleFileDAO.insertArticleFile(), ArticleNoteDAO.insertArticleNote(), CaptchaDAO.insertCaptcha(), CommentDAO.insertComment(), OJSCompletedPaymentDAO.insertCompletedPayment(), CopyeditorSubmissionDAO.insertCopyeditorSubmission(), EditAssignmentDAO.insertEditAssignment(), EditorSubmissionDAO.insertEditorSubmission(), IssueDAO.insertIssue(), LayoutAssignmentDAO.insertLayoutAssignment(), ArticleEventLogDAO.insertLogEntry(), ArticleEmailLogDAO.insertLogEntry(), ProofAssignmentDAO.insertProofAssignment(), PublishedArticleDAO.insertPublishedArticle(), QueuedPaymentDAO.insertQueuedPayment(), ReviewAssignmentDAO.insertReviewAssignment(), SuppFileDAO.insertSuppFile(), TemporaryFileDAO.insertTemporaryFile(), ThesisDAO.insertThesis(), UserDAO.insertUser(), VersionDAO.insertVersion(), AccessKeyDAO.updateAccessKey(), ArticleDAO.updateArticle(), ArticleCommentDAO.updateArticleComment(), ArticleFileDAO.updateArticleFile(), ArticleNoteDAO.updateArticleNote(), CaptchaDAO.updateCaptcha(), CommentDAO.updateComment(), CopyeditorSubmissionDAO.updateCopyeditorSubmission(), EditAssignmentDAO.updateEditAssignment(), IssueDAO.updateIssue(), ScheduledTaskDAO.updateLastRunTime(), LayoutAssignmentDAO.updateLayoutAssignment(), ProofAssignmentDAO.updateProofAssignment(), PublishedArticleDAO.updatePublishedArticle(), QueuedPaymentDAO.updateQueuedPayment(), ReviewAssignmentDAO.updateReviewAssignment(), ReviewerSubmissionDAO.updateReviewerSubmission(), SectionEditorSubmissionDAO.updateSectionEditorSubmission(), TemporaryFileDAO.updateTemporaryFile(), ThesisDAO.updateThesis(), and UserDAO.updateUser().

DAO.dateToDB ( d  ) 

DAO.flushCache (  ) 

Flush the system cache.

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

References setCacheDir().

DAO.getInsertId ( table = '',
id = '',
callHooks = true 
)

Return the last ID inserted in an autonumbered field.

Parameters:
$table string table name
$id string the ID/key column in the table
Returns:
int

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

Referenced by AccessKeyDAO.getInsertAccessKeyId(), AnnouncementDAO.getInsertAnnouncementId(), ArticleCommentDAO.getInsertArticleCommentId(), ArticleFileDAO.getInsertArticleFileId(), ArticleDAO.getInsertArticleId(), ArticleNoteDAO.getInsertArticleNoteId(), AuthorDAO.getInsertAuthorId(), CaptchaDAO.getInsertCaptchaId(), CommentDAO.getInsertCommentId(), OJSCompletedPaymentDAO.getInsertCompletedPaymentId(), CopyeditorSubmissionDAO.getInsertCopyedId(), CopyAssignmentDAO.getInsertCopyedId(), EditorSubmissionDAO.getInsertEditId(), EditAssignmentDAO.getInsertEditId(), EmailTemplateDAO.getInsertEmailId(), ArticleGalleyDAO.getInsertGalleyId(), GroupDAO.getInsertGroupId(), IssueDAO.getInsertIssueId(), JournalDAO.getInsertJournalId(), LayoutAssignmentDAO.getInsertLayoutId(), ArticleEventLogDAO.getInsertLogId(), ArticleEmailLogDAO.getInsertLogId(), ProofAssignmentDAO.getInsertProofId(), PublishedArticleDAO.getInsertPublishedArticleId(), QueuedPaymentDAO.getInsertQueuedPaymentId(), ReviewFormElementDAO.getInsertReviewFormElementId(), ReviewFormDAO.getInsertReviewFormId(), ReviewAssignmentDAO.getInsertReviewId(), SectionDAO.getInsertSectionId(), SubscriptionDAO.getInsertSubscriptionId(), SubscriptionTypeDAO.getInsertSubscriptionTypeId(), SuppFileDAO.getInsertSuppFileId(), TemporaryFileDAO.getInsertTemporaryFileId(), ThesisDAO.getInsertThesisId(), AnnouncementTypeDAO.getInsertTypeId(), UserDAO.getInsertUserId(), RTDAO.insertContext(), ArticleSearchDAO.insertKeyword(), ArticleSearchDAO.insertObject(), RTDAO.insertSearch(), AuthSourceDAO.insertSource(), and RTDAO.insertVersion().

DAO.getType ( value  ) 

Get the type of a value to be stored in the database

Parameters:
$value string
Returns:
string

Definition at line 306 of file DAO.inc.php.

Referenced by convertToDB(), ArticleFileDAO.insertArticleFile(), OJSCompletedPaymentDAO.insertCompletedPayment(), SuppFileDAO.insertSuppFile(), ArticleFileDAO.updateArticleFile(), and SuppFileDAO.updateSuppFile().

DAO.replace ( table,
arrFields,
keyCols 
)

Insert a row in a table, replacing an existing row if necessary.

Parameters:
$table string
$arrFields array Associative array of colName => value
$keyCols array Array of column names that are keys

Definition at line 193 of file DAO.inc.php.

Referenced by SiteSettingsDAO.updateSetting(), and JournalSettingsDAO.updateSetting().

& DAO.retrieve ( sql,
params = false,
callHooks = true 
)

Execute a SELECT SQL statement.

Parameters:
$sql string the SQL statement
$params array parameters for the SQL statement
Returns:
ADORecordSet

Definition at line 55 of file DAO.inc.php.

References HookRegistry.call().

Referenced by ArticleXMLGalleyDAO._getXMLGalleyFromId(), EmailTemplateDAO._returnLocaleEmailTemplateFromRow(), OAIDAO._returnRecordFromRow(), AnnouncementTypeDAO.announcementTypeExistsByTypeId(), ArticleXMLGalleyDAO.appendXMLGalleys(), CommentDAO.attributedCommentsExistForUser(), ArticleNoteDAO.clearAllArticleNotes(), SectionEditorSubmissionDAO.copyeditorExists(), IssueDAO.customIssueOrderingExists(), SectionDAO.customSectionOrderingExists(), EmailTemplateDAO.customTemplateExistsByKey(), ArticleSearchDAO.deleteArticleKeywords(), PublishedArticleDAO.deletePublishedArticlesBySectionId(), ReviewAssignmentDAO.deleteReviewAssignmentsByArticle(), SubscriptionDAO.deleteSubscriptionByTypeId(), SubscriptionDAO.deleteSubscriptionsByJournal(), SubscriptionDAO.deleteSubscriptionsByUserId(), SubscriptionTypeDAO.deleteSubscriptionTypesByJournal(), SectionEditorsDAO.editorExists(), ArticleGalleyDAO.galleyExistsByFileId(), AccessKeyDAO.getAccessKey(), AccessKeyDAO.getAccessKeyByKeyHash(), ReviewAssignmentDAO.getActiveReviewCountsForReviewForms(), ArticleNoteDAO.getAllArticleNoteFileIds(), AnnouncementDAO.getAnnouncement(), AnnouncementDAO.getAnnouncementJournalId(), AnnouncementTypeDAO.getAnnouncementType(), AnnouncementTypeDAO.getAnnouncementTypeJournalId(), AnnouncementTypeDAO.getAnnouncementTypeName(), ArticleDAO.getArticle(), ArticleCommentDAO.getArticleCommentById(), ArticleCommentDAO.getArticleComments(), ArticleCommentDAO.getArticleCommentsByUserId(), ArticleFileDAO.getArticleFile(), ArticleFileDAO.getArticleFileRevisions(), ArticleFileDAO.getArticleFileRevisionsInRange(), ArticleFileDAO.getArticleFilesByArticle(), ArticleFileDAO.getArticleFilesByAssocId(), ArticleDAO.getArticleJournalId(), ArticleNoteDAO.getArticleNoteById(), ArticleReportDAO.getArticleReport(), ArticleDAO.getArticlesByJournalId(), ArticleDAO.getArticlesByUserId(), JournalStatisticsDAO.getArticleStatistics(), AuthorDAO.getAuthor(), AuthorDAO.getAuthorIdsByArticle(), AuthorDAO.getAuthorsByArticle(), AuthorSubmissionDAO.getAuthorSubmission(), ReviewAssignmentDAO.getAuthorViewableFilesByRound(), ReviewAssignmentDAO.getAverageQualityRatings(), EmailTemplateDAO.getBaseEmailTemplate(), ReviewAssignmentDAO.getCancelsAndRegrets(), CaptchaDAO.getCaptcha(), CaptchaDAO.getCaptchasBySessionId(), CommentDAO.getComment(), CommentDAO.getCommentsByParentId(), CommentDAO.getCommentsByUserId(), OJSCompletedPaymentDAO.getCompletedPayment(), ReviewAssignmentDAO.getCompletedReviewCounts(), ReviewAssignmentDAO.getCompletedReviewCountsForReviewForms(), RTDAO.getContext(), CopyAssignmentDAO.getCopyAssignmentByArticleId(), CopyAssignmentDAO.getCopyAssignmentById(), EditorSubmissionDAO.getCopyedAssignment(), SectionEditorSubmissionDAO.getCopyeditorsNotAssignedToArticle(), SectionEditorSubmissionDAO.getCopyeditorStatistics(), CopyeditorSubmissionDAO.getCopyeditorSubmission(), IssueDAO.getCurrentIssue(), VersionDAO.getCurrentVersion(), IssueDAO.getCustomIssueOrder(), SectionDAO.getCustomSectionOrder(), AuthSourceDAO.getDefaultSource(), OAIDAO.getEarliestDatestamp(), ReviewAssignmentDAO.getEarliestNotificationByRound(), EditAssignmentDAO.getEditAssignment(), EditAssignmentDAO.getEditAssignmentsByArticleId(), EditAssignmentDAO.getEditAssignmentsByUserId(), EditAssignmentDAO.getEditingSectionEditorAssignmentsByArticleId(), EditAssignmentDAO.getEditorAssignmentsByArticleId(), SectionEditorSubmissionDAO.getEditorDecisions(), ReviewerSubmissionDAO.getEditorDecisions(), EditorSubmissionDAO.getEditorDecisions(), AuthorSubmissionDAO.getEditorDecisions(), JournalStatisticsDAO.getEditorReport(), SectionEditorsDAO.getEditorsBySectionId(), SectionDAO.getEditorSections(), SectionEditorsDAO.getEditorsNotInSection(), EditAssignmentDAO.getEditorStatistics(), EditorSubmissionDAO.getEditorSubmission(), EmailTemplateDAO.getEmailTemplate(), EmailTemplateDAO.getEmailTemplates(), JournalDAO.getEnabledJournals(), CaptchaDAO.getExpiredCaptchas(), OJSCompletedPaymentDAO.getFastTrackCompletedPayment(), ArticleGalleyDAO.getGalley(), ArticleGalleyDAO.getGalleyByPublicGalleyId(), ArticleGalleyDAO.getGalleyImages(), ArticleGalleyDAO.getGalleysByArticle(), GroupDAO.getGroup(), OAIDAO.getIdentifiers(), ReviewAssignmentDAO.getIncompleteReviewAssignments(), IssueDAO.getIssueByArticleId(), IssueDAO.getIssueById(), IssueDAO.getIssueByPublicIssueId(), JournalStatisticsDAO.getIssueStatistics(), JournalDAO.getJournal(), JournalDAO.getJournalByPath(), JournalStatisticsDAO.getJournalReport(), JournalSettingsDAO.getJournalSettings(), RoleDAO.getJournalUsersCount(), ReviewAssignmentDAO.getLastModifiedByRound(), ScheduledTaskDAO.getLastRunTime(), LayoutAssignmentDAO.getLayoutAssignmentByArticleId(), LayoutAssignmentDAO.getLayoutAssignmentById(), LayoutAssignmentDAO.getLayoutEditorIdByArticleId(), SectionEditorSubmissionDAO.getLayoutEditorStatistics(), EmailTemplateDAO.getLocaleEmailTemplate(), ArticleEventLogDAO.getLogEntry(), ArticleEmailLogDAO.getLogEntry(), JournalStatisticsDAO.getMaxAuthorCount(), JournalStatisticsDAO.getMaxEditorCount(), JournalStatisticsDAO.getMaxReviewerCount(), SectionEditorSubmissionDAO.getMaxReviewRound(), GroupMembershipDAO.getMembership(), ThesisDAO.getMostRecentActiveThesisByJournalId(), AnnouncementDAO.getMostRecentAnnouncementByJournalId(), ArticleGalleyDAO.getNextGalleySequence(), SuppFileDAO.getNextSuppFileSequence(), NotificationStatusDAO.getNotifiableUsersByJournalId(), NotificationStatusDAO.getNotifiableUsersCount(), IssueDAO.getNumArticles(), PluginSettingsDAO.getPluginSettings(), ProofAssignmentDAO.getProofAssignment(), ProofAssignmentDAO.getProofAssignmentByArticleId(), SectionEditorSubmissionDAO.getProofreaderStatistics(), OJSCompletedPaymentDAO.getPublicationCompletedPayment(), PublishedArticleDAO.getPublishedArticleAuthors(), PublishedArticleDAO.getPublishedArticleByArticleId(), PublishedArticleDAO.getPublishedArticleById(), PublishedArticleDAO.getPublishedArticleByPublicArticleId(), PublishedArticleDAO.getPublishedArticleCountByJournalId(), PublishedArticleDAO.getPublishedArticles(), PublishedArticleDAO.getPublishedArticlesBySectionId(), AuthorDAO.getPublishedArticlesForAuthor(), PublishedArticleDAO.getPublishedArticlesInSections(), IssueDAO.getPublishedIssuesByNumber(), QueuedPaymentDAO.getQueuedPayment(), OAIDAO.getRecord(), OAIDAO.getRecords(), ReviewFormElementDAO.getRequiredReviewFormElementIds(), ReviewAssignmentDAO.getReviewAssignment(), ReviewAssignmentDAO.getReviewAssignmentById(), ReviewAssignmentDAO.getReviewAssignmentsByArticleId(), ReviewAssignmentDAO.getReviewAssignmentsByReviewFormId(), ReviewAssignmentDAO.getReviewAssignmentsByUserId(), JournalStatisticsDAO.getReviewerReport(), SectionEditorSubmissionDAO.getReviewersNotAssignedToArticle(), SectionEditorSubmissionDAO.getReviewerStatistics(), JournalStatisticsDAO.getReviewerStatistics(), ReviewerSubmissionDAO.getReviewerSubmission(), ReviewAssignmentDAO.getReviewFilesByRound(), ReviewFormDAO.getReviewForm(), ReviewFormElementDAO.getReviewFormElement(), ReviewFormElementDAO.getReviewFormElements(), ReviewFormResponseDAO.getReviewFormResponse(), ReviewAssignmentDAO.getReviewIndexesForRound(), EditAssignmentDAO.getReviewingSectionEditorAssignmentsByArticleId(), ArticleFileDAO.getRevisionNumber(), RoleDAO.getRole(), RoleDAO.getRolesByJournalId(), RoleDAO.getRolesByUserId(), CommentDAO.getRootCommentsByArticleId(), RTDAO.getSearch(), SectionDAO.getSection(), SectionDAO.getSectionByAbbrev(), SectionDAO.getSectionByTitle(), SectionDAO.getSectionByTitleAndAbbrev(), SectionEditorSubmissionDAO.getSectionEditorSubmission(), SectionEditorSubmissionDAO.getSectionEditorSubmissions(), JournalStatisticsDAO.getSectionReport(), SectionDAO.getSectionsForIssue(), SessionDAO.getSession(), UserSettingsDAO.getSetting(), UserSettingsDAO.getSettingsByJournal(), SiteDAO.getSite(), SiteSettingsDAO.getSiteSettings(), AuthSourceDAO.getSource(), ProofreaderSubmissionDAO.getSubmission(), LayoutEditorSubmissionDAO.getSubmission(), OJSCompletedPaymentDAO.getSubmissionCompletedPayment(), ReviewerSubmissionDAO.getSubmissionsCount(), ProofreaderSubmissionDAO.getSubmissionsCount(), LayoutEditorSubmissionDAO.getSubmissionsCount(), CopyeditorSubmissionDAO.getSubmissionsCount(), AuthorSubmissionDAO.getSubmissionsCount(), SubscriptionDAO.getSubscription(), SubscriptionDAO.getSubscriptionIdByUser(), SubscriptionDAO.getSubscriptionJournalId(), JournalStatisticsDAO.getSubscriptionStatistics(), SubscriptionTypeDAO.getSubscriptionType(), SubscriptionTypeDAO.getSubscriptionTypeDisablePublicDisplay(), SubscriptionTypeDAO.getSubscriptionTypeInstitutional(), SubscriptionTypeDAO.getSubscriptionTypeJournalId(), SubscriptionTypeDAO.getSubscriptionTypeMembership(), SubscriptionTypeDAO.getSubscriptionTypeName(), SuppFileDAO.getSuppFile(), SuppFileDAO.getSuppFileByPublicSuppFileId(), SuppFileDAO.getSuppFilesByArticle(), ThesisDAO.getThesis(), ThesisDAO.getThesisJournalId(), OAIDAO.getToken(), UserDAO.getUser(), UserDAO.getUserByAuthStr(), UserDAO.getUserByCredentials(), UserDAO.getUserByEmail(), UserDAO.getUserByUsername(), UserDAO.getUserEmail(), UserDAO.getUserFullName(), UserSettingsDAO.getUsersBySetting(), JournalStatisticsDAO.getUserStatistics(), RTDAO.getVersion(), VersionDAO.getVersionHistory(), OJSCompletedPaymentDAO.hasPaidFastTrack(), OJSCompletedPaymentDAO.hasPaidPerViewArticle(), OJSCompletedPaymentDAO.hasPaidPublication(), OJSCompletedPaymentDAO.hasPaidSubmission(), ArticleDAO.incompleteSubmissionExists(), ArticleSearchDAO.insertKeyword(), ArticleSearchDAO.insertObject(), OAIDAO.insertToken(), IssueDAO.issueExists(), IssueDAO.issueIdExists(), ThesisDAO.isThesisActive(), SubscriptionDAO.isValidSubscriptionByDomain(), SubscriptionDAO.isValidSubscriptionByIP(), SubscriptionDAO.isValidSubscriptionByUser(), JournalDAO.journalExistsByPath(), IssueDAO.moveCustomIssueOrder(), PublishedArticleDAO.publicArticleIdExists(), ArticleGalleyDAO.publicGalleyIdExists(), IssueDAO.publicIssueIdExists(), OAIDAO.recordExists(), AuthorDAO.resequenceAuthors(), RTDAO.resequenceContexts(), IssueDAO.resequenceCustomIssueOrders(), SectionDAO.resequenceCustomSectionOrders(), ArticleGalleyDAO.resequenceGalleys(), GroupDAO.resequenceGroups(), JournalDAO.resequenceJournals(), GroupMembershipDAO.resequenceMemberships(), PublishedArticleDAO.resequencePublishedArticles(), ReviewFormElementDAO.resequenceReviewFormElements(), ReviewFormDAO.resequenceReviewForms(), RTDAO.resequenceSearches(), SectionDAO.resequenceSections(), SubscriptionTypeDAO.resequenceSubscriptionTypes(), SuppFileDAO.resequenceSuppFiles(), retrieveRange(), SectionEditorSubmissionDAO.reviewerExists(), ReviewFormElementDAO.reviewFormElementExists(), ReviewFormDAO.reviewFormExists(), ReviewFormResponseDAO.reviewFormResponseExists(), SectionEditorSubmissionDAO.reviewRoundExists(), RoleDAO.roleExists(), SectionDAO.sectionExists(), SessionDAO.sessionExistsById(), SectionDAO.setDefaultCustomSectionOrders(), SubscriptionDAO.subscriptionExistsByUser(), SubscriptionTypeDAO.subscriptionTypeExistsByTypeId(), SuppFileDAO.suppFileExistsByFileId(), SuppFileDAO.suppFileExistsByPublicId(), EmailTemplateDAO.templateExistsByKey(), ReviewFormDAO.unusedReviewFormExists(), ScheduledTaskDAO.updateLastRunTime(), EmailTemplateDAO.updateLocaleEmailTemplateData(), UserSettingsDAO.updateSetting(), PluginSettingsDAO.updateSetting(), UserDAO.userExistsByEmail(), UserDAO.userExistsById(), and UserDAO.userExistsByUsername().

& DAO.retrieveCached ( sql,
params = false,
secsToCache = 3600,
callHooks = true 
)

Execute a cached SELECT SQL statement.

Parameters:
$sql string the SQL statement
$params array parameters for the SQL statement
Returns:
ADORecordSet

Definition at line 81 of file DAO.inc.php.

References HookRegistry.call(), and setCacheDir().

Referenced by ArticleSearchDAO.getPhraseResults().

& DAO.retrieveLimit ( sql,
params = false,
numRows = false,
offset = false,
callHooks = true 
)

Execute a SELECT SQL statement with LIMIT on the rows returned.

Parameters:
$sql string the SQL statement
$params array parameters for the SQL statement
$numRows int maximum number of rows to return in the result set
$offset int row offset in the result set
Returns:
ADORecordSet

Definition at line 111 of file DAO.inc.php.

References HookRegistry.call().

Referenced by ArticleFileDAO.getArticleFile(), IssueDAO.getLastCreatedIssue(), ArticleCommentDAO.getMostRecentArticleComment(), PublishedArticleDAO.getPublishedArticles(), and TemporaryFileDAO.getTemporaryFile().

& DAO.retrieveRange ( sql,
params = false,
dbResultRange = null,
callHooks = true 
)

Execute a SELECT SQL statment, returning rows in the range supplied.

Parameters:
$sql string the SQL statement
$params array parameters for the SQL statement
$dbResultRange object the DBResultRange object describing the desired range

Definition at line 136 of file DAO.inc.php.

References HookRegistry.call(), and retrieve().

Referenced by ThesisDAO.getActiveThesesByJournalId(), AnnouncementDAO.getAnnouncementsByJournalId(), AnnouncementDAO.getAnnouncementsByTypeId(), AnnouncementDAO.getAnnouncementsNotExpiredByJournalId(), AnnouncementTypeDAO.getAnnouncementTypesByJournalId(), ArticleEventLogDAO.getArticleLogEntriesByAssoc(), ArticleEmailLogDAO.getArticleLogEntriesByAssoc(), ArticleNoteDAO.getArticleNotes(), ArticleNoteDAO.getArticleNotesByUserId(), AuthorDAO.getAuthorsAlphabetizedByJournal(), AuthorSubmissionDAO.getAuthorSubmissions(), RTDAO.getContexts(), CopyeditorSubmissionDAO.getCopyeditorSubmissionsByCopyeditorId(), EditorSubmissionDAO.getEditorSubmissions(), EmailTemplateDAO.getEmailTemplates(), GroupDAO.getGroups(), IssueDAO.getIssues(), ReviewFormDAO.getJournalActiveReviewForms(), ReviewFormDAO.getJournalReviewForms(), JournalDAO.getJournals(), SectionDAO.getJournalSections(), ReviewFormDAO.getJournalUnusedReviewForms(), ReviewFormDAO.getJournalUsedReviewForms(), GroupMembershipDAO.getMemberships(), AnnouncementDAO.getNumAnnouncementsByJournalId(), AnnouncementDAO.getNumAnnouncementsNotExpiredByJournalId(), OJSCompletedPaymentDAO.getPaymentsByJournalId(), PublishedArticleDAO.getPublishedArticlesByJournalId(), IssueDAO.getPublishedIssues(), SectionEditorSubmissionDAO.getReviewersForArticle(), ReviewerSubmissionDAO.getReviewerSubmissionsByReviewerId(), ReviewFormElementDAO.getReviewFormElementsByReviewForm(), ReviewFormResponseDAO.getReviewReviewFormResponseValues(), RTDAO.getSearches(), AuthSourceDAO.getSources(), ProofreaderSubmissionDAO.getSubmissions(), LayoutEditorSubmissionDAO.getSubmissions(), SubscriptionDAO.getSubscriptions(), SubscriptionDAO.getSubscriptionsByDateEnd(), SubscriptionDAO.getSubscriptionsByJournalId(), SubscriptionTypeDAO.getSubscriptionTypesByJournalId(), ThesisDAO.getThesesByJournalId(), EditorSubmissionDAO.getUnfilteredEditorSubmissions(), SectionEditorSubmissionDAO.getUnfilteredSectionEditorSubmissions(), IssueDAO.getUnpublishedIssues(), UserDAO.getUsersByField(), RoleDAO.getUsersByJournalId(), RoleDAO.getUsersByRoleId(), EditorSubmissionDAO.getUsersNotAssignedToArticle(), and RTDAO.getVersions().

DAO.setCacheDir (  ) 

Configure the caching directory for database results NOTE: This is implemented as a GLOBAL setting and cannot be set on a per-connection basis.

Definition at line 213 of file DAO.inc.php.

Referenced by flushCache(), and retrieveCached().

DAO.update ( sql,
params = false,
callHooks = true,
dieOnError = true 
)

Execute an INSERT, UPDATE, or DELETE SQL statement.

Parameters:
$sql the SQL statement the execute
$params an array of parameters for the SQL statement
$callHooks boolean Whether or not to call hooks
$dieOnError boolean Whether or not to die if an error occurs
Returns:
boolean

Definition at line 168 of file DAO.inc.php.

References HookRegistry.call().

Referenced by ArticleDAO.changeArticleStatus(), OAIDAO.clearTokens(), CommentDAO.decrementChildCount(), AccessKeyDAO.deleteAccessKeyById(), SessionDAO.deleteAllSessions(), AnnouncementDAO.deleteAnnouncementById(), AnnouncementTypeDAO.deleteAnnouncementTypeById(), ArticleDAO.deleteArticleById(), ArticleCommentDAO.deleteArticleCommentById(), ArticleCommentDAO.deleteArticleComments(), ArticleFileDAO.deleteArticleFileById(), ArticleFileDAO.deleteArticleFiles(), ArticleSearchDAO.deleteArticleKeywords(), ArticleEventLogDAO.deleteArticleLogEntries(), ArticleEmailLogDAO.deleteArticleLogEntries(), ArticleNoteDAO.deleteArticleNoteById(), AuthorDAO.deleteAuthorById(), CaptchaDAO.deleteCaptcha(), CommentDAO.deleteComment(), CommentDAO.deleteCommentsByArticle(), RTDAO.deleteContext(), CopyAssignmentDAO.deleteCopyAssignmentsByArticle(), IssueDAO.deleteCustomIssueOrdering(), SectionDAO.deleteCustomSectionOrdering(), SectionEditorSubmissionDAO.deleteDecisionsByArticle(), EmailTemplateDAO.deleteDefaultEmailTemplatesByLocale(), EditAssignmentDAO.deleteEditAssignmentById(), EditAssignmentDAO.deleteEditAssignmentsByArticle(), SectionEditorsDAO.deleteEditor(), SectionEditorsDAO.deleteEditorsByJournalId(), SectionEditorsDAO.deleteEditorsBySectionId(), SectionEditorsDAO.deleteEditorsByUserId(), EmailTemplateDAO.deleteEmailTemplateByKey(), EmailTemplateDAO.deleteEmailTemplatesByJournal(), EmailTemplateDAO.deleteEmailTemplatesByLocale(), AccessKeyDAO.deleteExpiredKeys(), ArticleGalleyDAO.deleteGalleyById(), ArticleGalleyDAO.deleteGalleyImage(), GroupDAO.deleteGroupById(), ArticleGalleyDAO.deleteImagesByGalley(), IssueDAO.deleteIssue(), JournalDAO.deleteJournalById(), LayoutAssignmentDAO.deleteLayoutAssignmentById(), LayoutAssignmentDAO.deleteLayoutAssignmentsByArticle(), ArticleEventLogDAO.deleteLogEntry(), ArticleEmailLogDAO.deleteLogEntry(), GroupMembershipDAO.deleteMembershipByGroupId(), GroupMembershipDAO.deleteMembershipById(), GroupMembershipDAO.deleteMembershipByUserId(), NotificationStatusDAO.deleteNotificationStatusByJournal(), NotificationStatusDAO.deleteNotificationStatusByUserId(), ProofAssignmentDAO.deleteProofAssignmentById(), ProofAssignmentDAO.deleteProofAssignmentsByArticle(), PublishedArticleDAO.deletePublishedArticleByArticleId(), PublishedArticleDAO.deletePublishedArticleById(), PublishedArticleDAO.deletePublishedArticlesByIssueId(), PublishedArticleDAO.deletePublishedArticlesBySectionId(), ReviewAssignmentDAO.deleteReviewAssignmentById(), ReviewAssignmentDAO.deleteReviewAssignmentsByArticle(), ReviewFormDAO.deleteReviewFormById(), ReviewFormElementDAO.deleteReviewFormElementById(), ReviewFormResponseDAO.deleteReviewFormResponseById(), ReviewFormResponseDAO.deleteReviewFormResponseByReviewFormElementId(), ReviewFormResponseDAO.deleteReviewFormResponseByReviewId(), SectionEditorSubmissionDAO.deleteReviewRoundsByArticle(), RoleDAO.deleteRole(), RoleDAO.deleteRoleByJournalId(), RoleDAO.deleteRoleByUserId(), RTDAO.deleteSearch(), RTDAO.deleteSearchesByContextId(), SectionDAO.deleteSectionById(), SessionDAO.deleteSessionById(), SessionDAO.deleteSessionByLastUsed(), SessionDAO.deleteSessionsByUserId(), UserSettingsDAO.deleteSetting(), SiteSettingsDAO.deleteSetting(), ReviewFormElementDAO.deleteSetting(), PluginSettingsDAO.deleteSetting(), JournalSettingsDAO.deleteSetting(), UserSettingsDAO.deleteSettings(), JournalSettingsDAO.deleteSettingsByJournal(), PluginSettingsDAO.deleteSettingsByJournalId(), PluginSettingsDAO.deleteSettingsByPlugin(), AuthSourceDAO.deleteSource(), SubscriptionDAO.deleteSubscriptionById(), SubscriptionDAO.deleteSubscriptionByTypeId(), SubscriptionDAO.deleteSubscriptionIPRangeBySubscriptionId(), SubscriptionDAO.deleteSubscriptionsByJournal(), SubscriptionDAO.deleteSubscriptionsByUserId(), SubscriptionTypeDAO.deleteSubscriptionTypeById(), SuppFileDAO.deleteSuppFileById(), TemporaryFileDAO.deleteTemporaryFileById(), TemporaryFileDAO.deleteTemporaryFilesByUserId(), ThesisDAO.deleteThesesByJournal(), ThesisDAO.deleteThesisById(), UserDAO.deleteUserById(), RTDAO.deleteVersion(), ArticleXMLGalleyDAO.deleteXMLGalleys(), CommentDAO.incrementChildCount(), ArticleGalleyDAO.incrementViews(), PublishedArticleDAO.incrementViewsByArticleId(), ArticleXMLGalleyDAO.incrementXMLViews(), AccessKeyDAO.insertAccessKey(), AnnouncementDAO.insertAnnouncement(), AnnouncementTypeDAO.insertAnnouncementType(), ArticleDAO.insertArticle(), ArticleCommentDAO.insertArticleComment(), ArticleFileDAO.insertArticleFile(), ArticleNoteDAO.insertArticleNote(), AuthorDAO.insertAuthor(), EmailTemplateDAO.insertBaseEmailTemplate(), CaptchaDAO.insertCaptcha(), CommentDAO.insertComment(), OJSCompletedPaymentDAO.insertCompletedPayment(), RTDAO.insertContext(), CopyeditorSubmissionDAO.insertCopyeditorSubmission(), IssueDAO.insertCustomIssueOrder(), SectionDAO.insertCustomSectionOrder(), EditAssignmentDAO.insertEditAssignment(), SectionEditorsDAO.insertEditor(), EditorSubmissionDAO.insertEditorSubmission(), ArticleGalleyDAO.insertGalley(), ArticleGalleyDAO.insertGalleyImage(), GroupDAO.insertGroup(), IssueDAO.insertIssue(), JournalDAO.insertJournal(), ArticleSearchDAO.insertKeyword(), LayoutAssignmentDAO.insertLayoutAssignment(), ArticleEventLogDAO.insertLogEntry(), ArticleEmailLogDAO.insertLogEntry(), GroupMembershipDAO.insertMembership(), ArticleSearchDAO.insertObject(), ArticleSearchDAO.insertObjectKeyword(), ProofAssignmentDAO.insertProofAssignment(), PublishedArticleDAO.insertPublishedArticle(), QueuedPaymentDAO.insertQueuedPayment(), ReviewAssignmentDAO.insertReviewAssignment(), ReviewFormDAO.insertReviewForm(), ReviewFormElementDAO.insertReviewFormElement(), ReviewFormResponseDAO.insertReviewFormResponse(), RoleDAO.insertRole(), RTDAO.insertSearch(), SectionDAO.insertSection(), SessionDAO.insertSession(), SiteDAO.insertSite(), AuthSourceDAO.insertSource(), SubscriptionDAO.insertSubscription(), SubscriptionDAO.insertSubscriptionIPRange(), SubscriptionTypeDAO.insertSubscriptionType(), SuppFileDAO.insertSuppFile(), TemporaryFileDAO.insertTemporaryFile(), ThesisDAO.insertThesis(), OAIDAO.insertToken(), UserDAO.insertUser(), VersionDAO.insertVersion(), RTDAO.insertVersion(), ArticleXMLGalleyDAO.insertXMLGalleys(), IssueDAO.moveCustomIssueOrder(), SectionDAO.moveCustomSectionOrder(), ArticleDAO.removeArticlesFromSection(), AuthorDAO.resequenceAuthors(), RTDAO.resequenceContexts(), IssueDAO.resequenceCustomIssueOrders(), SectionDAO.resequenceCustomSectionOrders(), ArticleGalleyDAO.resequenceGalleys(), GroupDAO.resequenceGroups(), JournalDAO.resequenceJournals(), GroupMembershipDAO.resequenceMemberships(), PublishedArticleDAO.resequencePublishedArticles(), ReviewFormElementDAO.resequenceReviewFormElements(), ReviewFormDAO.resequenceReviewForms(), RTDAO.resequenceSearches(), SectionDAO.resequenceSections(), SubscriptionTypeDAO.resequenceSubscriptionTypes(), SuppFileDAO.resequenceSuppFiles(), AuthSourceDAO.setDefault(), NotificationStatusDAO.setJournalNotifications(), AccessKeyDAO.transferAccessKeys(), ArticleEventLogDAO.transferArticleLogEntries(), ArticleEmailLogDAO.transferArticleLogEntries(), EditorSubmissionDAO.transferEditorDecisions(), AccessKeyDAO.updateAccessKey(), AnnouncementDAO.updateAnnouncement(), AnnouncementTypeDAO.updateAnnouncementType(), ArticleDAO.updateArticle(), ArticleCommentDAO.updateArticleComment(), ArticleFileDAO.updateArticleFile(), ArticleNoteDAO.updateArticleNote(), AuthorDAO.updateAuthor(), EmailTemplateDAO.updateBaseEmailTemplate(), CaptchaDAO.updateCaptcha(), CommentDAO.updateComment(), RTDAO.updateContext(), CopyeditorSubmissionDAO.updateCopyeditorSubmission(), IssueDAO.updateCurrentIssue(), EditAssignmentDAO.updateEditAssignment(), ArticleGalleyDAO.updateGalley(), GroupDAO.updateGroup(), IssueDAO.updateIssue(), JournalDAO.updateJournal(), ScheduledTaskDAO.updateLastRunTime(), LayoutAssignmentDAO.updateLayoutAssignment(), EmailTemplateDAO.updateLocaleEmailTemplateData(), GroupMembershipDAO.updateMembership(), ProofAssignmentDAO.updateProofAssignment(), PublishedArticleDAO.updatePublishedArticle(), PublishedArticleDAO.updatePublishedArticleField(), QueuedPaymentDAO.updateQueuedPayment(), ReviewAssignmentDAO.updateReviewAssignment(), ReviewerSubmissionDAO.updateReviewerSubmission(), ReviewFormDAO.updateReviewForm(), ReviewFormElementDAO.updateReviewFormElement(), ReviewFormResponseDAO.updateReviewFormResponse(), RTDAO.updateSearch(), SectionDAO.updateSection(), SectionEditorSubmissionDAO.updateSectionEditorSubmission(), SessionDAO.updateSession(), UserSettingsDAO.updateSetting(), SiteSettingsDAO.updateSetting(), PluginSettingsDAO.updateSetting(), JournalSettingsDAO.updateSetting(), SiteDAO.updateSite(), AuthSourceDAO.updateSource(), SubscriptionDAO.updateSubscription(), SubscriptionTypeDAO.updateSubscriptionType(), SuppFileDAO.updateSuppFile(), TemporaryFileDAO.updateTemporaryFile(), ThesisDAO.updateThesis(), UserDAO.updateUser(), and RTDAO.updateVersion().


Member Data Documentation

DAO.$_dataSource

The database connection object

Definition at line 25 of file DAO.inc.php.


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

Generated on Mon Jul 14 10:55:41 2008 for Open Journal Systems by  doxygen 1.5.6