Public Member Functions | |
| call ($hookName, $args=null) | |
| clear ($hookName) | |
| & | getHooks () |
| register ($hookName, $callback) | |
| setHooks ($hookName, $hooks) | |
Definition at line 18 of file HookRegistry.inc.php.
| HookRegistry.call | ( | $ | hookName, | |
| $ | args = null | |||
| ) |
Call each callback registered against $hookName in sequence. The first callback that returns a value that evaluates to true will interrupt processing and this function will return its return value; otherwise, all callbacks will be called in sequence and the return value of this call will be the value returned by the last callback.
| $hookName | string The name of the hook to register against | |
| $args | string Hooks are called with this as the second param |
Definition at line 72 of file HookRegistry.inc.php.
References getHooks().
Referenced by ArticleDAO._articleFromRow(), AccessKeyDAO._returnAccessKeyFromRow(), ArticleCommentDAO._returnArticleCommentFromRow(), ArticleFileDAO._returnArticleFileFromRow(), ArticleNoteDAO._returnArticleNoteFromRow(), AuthorDAO._returnAuthorFromRow(), AuthorSubmissionDAO._returnAuthorSubmissionFromRow(), EmailTemplateDAO._returnBaseEmailTemplateFromRow(), CaptchaDAO._returnCaptchaFromRow(), CommentDAO._returnCommentFromRow(), RTDAO._returnContextFromRow(), CopyAssignmentDAO._returnCopyAssignmentFromRow(), CopyeditorSubmissionDAO._returnCopyeditorSubmissionFromRow(), CurrencyDAO._returnCurrencyFromRow(), EditAssignmentDAO._returnEditAssignmentFromRow(), EditorSubmissionDAO._returnEditorSubmissionFromRow(), EmailTemplateDAO._returnEmailTemplateFromRow(), ArticleGalleyDAO._returnGalleyFromRow(), GroupDAO._returnGroupFromRow(), IssueDAO._returnIssueFromRow(), JournalDAO._returnJournalFromRow(), RTDAO._returnJournalRTFromRow(), LayoutAssignmentDAO._returnLayoutAssignmentFromRow(), EmailTemplateDAO._returnLocaleEmailTemplateFromRow(), ArticleEventLogDAO._returnLogEntryFromRow(), ArticleEmailLogDAO._returnLogEntryFromRow(), GroupMembershipDAO._returnMembershipFromRow(), ProofAssignmentDAO._returnProofAssignmentFromRow(), PublishedArticleDAO._returnPublishedArticleFromRow(), ReviewAssignmentDAO._returnReviewAssignmentFromRow(), ReviewerSubmissionDAO._returnReviewerSubmissionFromRow(), ReviewFormElementDAO._returnReviewFormElementFromRow(), ReviewFormDAO._returnReviewFormFromRow(), ReviewFormResponseDAO._returnReviewFormResponseFromRow(), RoleDAO._returnRoleFromRow(), RTDAO._returnSearchFromRow(), SectionEditorSubmissionDAO._returnSectionEditorSubmissionFromRow(), SectionDAO._returnSectionFromRow(), PublishedArticleDAO._returnSimplePublishedArticleFromRow(), SiteDAO._returnSiteFromRow(), ProofreaderSubmissionDAO._returnSubmissionFromRow(), LayoutEditorSubmissionDAO._returnSubmissionFromRow(), SubscriptionDAO._returnSubscriptionFromRow(), SubscriptionTypeDAO._returnSubscriptionTypeFromRow(), SuppFileDAO._returnSuppFileFromRow(), TemporaryFileDAO._returnTemporaryFileFromRow(), UserDAO._returnUserFromRow(), VersionDAO._returnVersionFromRow(), RTDAO._returnVersionFromRow(), SectionEditorAction.addReviewer(), SectionEditorAction.addReviewForm(), SectionEditorAction.addSubmissionNote(), SectionEditorAction.archiveSubmission(), EditorAction.assignEditor(), SectionEditorAction.assignLayoutEditor(), ProofreaderAction.authorProofreadingUnderway(), SectionEditorAction.blindCcReviewsToReviewers(), SectionEditorAction.cancelReview(), SectionEditorAction.changeSection(), SectionEditorAction.clearAllSubmissionNotes(), SectionEditorAction.clearReview(), SectionEditorAction.clearReviewForm(), AuthorAction.completeAuthorCopyedit(), SectionEditorAction.completeCopyedit(), CopyeditorAction.completeCopyedit(), SectionEditorAction.completeFinalCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), ReviewerAction.confirmReview(), SectionEditorAction.confirmReviewForReviewer(), CopyeditorAction.copyeditUnderway(), AuthorAction.copyeditUnderway(), DAO.DAO(), SectionEditorAction.deleteArticleFile(), AuthorAction.deleteArticleFile(), SectionEditorAction.deleteArticleImage(), LayoutEditorAction.deleteArticleImage(), Action.deleteComment(), LayoutEditorAction.deleteGalley(), ArticleGalleyDAO.deleteGalleyById(), ReviewerAction.deleteReviewerVersion(), LayoutEditorAction.deleteSuppFile(), AuthorAction.designateReviewVersion(), Installer.destroy(), TemplateManager.display(), ArticleHandler.download(), AuthorAction.downloadAuthorFile(), CopyeditorAction.downloadCopyeditorFile(), LayoutEditorAction.downloadFile(), ProofreaderAction.downloadProofreaderFile(), ReviewerAction.downloadReviewerFile(), ReviewerAction.editComment(), Action.editComment(), ReviewerAction.editReviewFormResponse(), SectionEditorAction.emailEditorDecisionComment(), AuthorAction.emailEditorDecisionComment(), JournalSiteSettingsForm.execute(), Installer.executeInstaller(), Request.getBasePath(), Request.getBaseUrl(), PluginRegistry.getCategories(), Request.getCompleteUrl(), BlockPlugin.getContextMap(), TinyMCEPlugin.getEnableFields(), ArticleGalleyDAO.getGalley(), ArticleGalleyDAO.getGalleyByPublicGalleyId(), ArticleGalleyDAO.getGalleysByArticle(), Request.getIndexUrl(), PublishedArticle.getLocalizedGalleys(), Request.getProtocol(), Request.getQueryString(), Request.getRemoteAddr(), Request.getRemoteDomain(), Request.getRequestedJournalPath(), Request.getRequestPath(), Request.getRequestUrl(), Request.getServerHost(), Request.getUserAgent(), ArticleGalleyDAO.incrementViews(), SectionEditorAction.initiateCopyedit(), ArticleGalleyDAO.insertGalley(), Installer.Installer(), Action.instructions(), ProofreaderAction.layoutEditorProofreadingUnderway(), PluginRegistry.loadCategory(), Validation.login(), SectionEditorAction.makeReviewerFileViewable(), SectionEditorAction.notifyAuthorCopyedit(), SectionEditorAction.notifyCopyeditor(), SectionEditorAction.notifyFinalCopyedit(), SectionEditorAction.notifyLayoutEditor(), SectionEditorAction.notifyReviewer(), Installer.parseInstaller(), SectionEditorAction.postCopyeditComment(), CopyeditorAction.postCopyeditComment(), AuthorAction.postCopyeditComment(), SectionEditorAction.postEditorDecisionComment(), Installer.postInstall(), SectionEditorAction.postLayoutComment(), ProofreaderAction.postLayoutComment(), LayoutEditorAction.postLayoutComment(), CopyeditorAction.postLayoutComment(), AuthorAction.postLayoutComment(), SectionEditorAction.postPeerReviewComment(), ReviewerAction.postPeerReviewComment(), SectionEditorAction.postProofreadComment(), ProofreaderAction.postProofreadComment(), LayoutEditorAction.postProofreadComment(), AuthorAction.postProofreadComment(), Installer.preInstall(), ProofreaderAction.proofreadEmail(), ProofreaderAction.proofreaderProofreadingUnderway(), SectionEditorAction.rateReviewer(), SectionEditorAction.recordDecision(), ReviewerAction.recordRecommendation(), Request.redirectUrl(), SectionEditorAction.remindReviewer(), SectionEditorAction.removeSubmissionNote(), SectionEditorAction.restoreToQueue(), SectionEditorAction.resubmitFile(), DAO.retrieve(), DAO.retrieveCached(), DAO.retrieveLimit(), DAO.retrieveRange(), Action.saveComment(), Action.saveMetadata(), ReviewerAction.saveReviewFormResponse(), SectionEditorAction.selectCopyeditor(), ProofreaderAction.selectProofreader(), Mail.send(), SectionEditorAction.setCopyeditFile(), SectionEditorAction.setDueDate(), SectionEditorAction.setReviewerRecommendation(), TemplateManager.smartyCallHook(), IssueAction.subscribedDomain(), IssueAction.subscribedUser(), IssueAction.subscriptionRequired(), SectionEditorAction.thankAuthorCopyedit(), SectionEditorAction.thankCopyeditor(), SectionEditorAction.thankFinalCopyedit(), SectionEditorAction.thankLayoutEditor(), SectionEditorAction.thankReviewer(), SectionEditorAction.unsuitableSubmission(), DAO.update(), SectionEditorAction.updateCommentsStatus(), SectionEditorAction.updateSection(), SectionEditorAction.updateSubmissionNote(), Installer.updateVersion(), SectionEditorAction.uploadCopyeditVersion(), CopyeditorAction.uploadCopyeditVersion(), AuthorAction.uploadCopyeditVersion(), SectionEditorAction.uploadEditorVersion(), SectionEditorAction.uploadLayoutVersion(), LayoutEditorAction.uploadLayoutVersion(), ReviewerAction.uploadReviewerVersion(), SectionEditorAction.uploadReviewForReviewer(), SectionEditorAction.uploadReviewVersion(), AuthorAction.uploadRevisedVersion(), SectionEditorAction.viewCopyeditComments(), CopyeditorAction.viewCopyeditComments(), AuthorAction.viewCopyeditComments(), SectionEditorAction.viewEditorDecisionComments(), AuthorAction.viewEditorDecisionComments(), ArticleHandler.viewFile(), SectionEditorAction.viewLayoutComments(), ProofreaderAction.viewLayoutComments(), LayoutEditorAction.viewLayoutComments(), CopyeditorAction.viewLayoutComments(), AuthorAction.viewLayoutComments(), Action.viewMetadata(), SectionEditorAction.viewPeerReviewComments(), ReviewerAction.viewPeerReviewComments(), SectionEditorAction.viewProofreadComments(), ProofreaderAction.viewProofreadComments(), LayoutEditorAction.viewProofreadComments(), AuthorAction.viewProofreadComments(), and SectionEditorAction.viewReviewFormResponse().
| HookRegistry.clear | ( | $ | hookName | ) |
Clear hooks registered against the given name.
| $hookName | string Name of hook |
Definition at line 42 of file HookRegistry.inc.php.
References getHooks().
| & HookRegistry.getHooks | ( | ) |
Get the current set of hook registrations.
Definition at line 22 of file HookRegistry.inc.php.
Referenced by call(), clear(), register(), and setHooks().
| HookRegistry.register | ( | $ | hookName, | |
| $ | callback | |||
| ) |
Register a hook against the given hook name.
| $hookName | string Name of hook to register against | |
| $callback | object Callback pseudotype |
Definition at line 53 of file HookRegistry.inc.php.
References getHooks().
Referenced by CitationPlugin.cite(), XMLGalleyPlugin.register(), WebFeedPlugin.register(), TranslatorPlugin.register(), TinyMCEPlugin.register(), ThesisFeedPlugin.register(), ThesisPlugin.register(), SehlPlugin.register(), RoundedCornersPlugin.register(), PhpMyVisitesPlugin.register(), OpenAdsPlugin.register(), GoogleAnalyticsPlugin.register(), CounterPlugin.register(), CoinsPlugin.register(), CmsRssPlugin.register(), CmsPlugin.register(), AnnouncementFeedPlugin.register(), Plugin.register(), PaymethodPlugin.register(), and BlockPlugin.register().
| HookRegistry.setHooks | ( | $ | hookName, | |
| $ | hooks | |||
| ) |
Set the hooks table for the given hook name to the supplied array of callbacks.
| $hookName | string Name of hook to set | |
| $hooks | array Array of callbacks for this hook |
Definition at line 33 of file HookRegistry.inc.php.
References getHooks().
1.5.6