Open Journal Systems
3.3.0
|
Static Public Member Functions | |
static | call ($hookName, $args=null) |
static | clear ($hookName) |
static & | getCalledHooks () |
static & | getHooks ($hookName=null) |
static | register ($hookName, $callback, $hookSequence=HOOK_SEQUENCE_NORMAL) |
static | rememberCalledHooks ($askOnly=false, $updateTo=true) |
static | resetCalledHooks ($leaveAlive=false) |
static | setHooks ($hookName, $callbacks) |
Class for linking core functionality with plugins.
Definition at line 21 of file HookRegistry.inc.php.
|
static |
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 86 of file HookRegistry.inc.php.
References getCalledHooks(), and getHooks().
Referenced by DAO\__construct(), LinkAction\__construct(), Form\__construct(), Installer\__construct(), SitemapHandler\_createContextSitemap(), OAIMetadataFormat_JATS\_findJats(), ReviewFormElementDAO\_fromRow(), ReviewFormDAO\_fromRow(), IssueFileDAO\_fromRow(), QueryDAO\_fromRow(), ReviewerSubmissionDAO\_fromRow(), SubmissionCommentDAO\_fromRow(), LibraryFileDAO\_fromRow(), DepositDAO\_fromRow(), CategoryDAO\_fromRow(), SubscriptionTypeDAO\_fromRow(), NoteDAO\_fromRow(), SectionDAO\_fromRow(), GenreDAO\_fromRow(), IndividualSubscriptionDAO\_fromRow(), IssueGalleyDAO\_fromRow(), NotificationDAO\_fromRow(), IssueDAO\_fromRow(), DepositObjectDAO\_fromRow(), SubscriptionDAO\_fromRow(), InstitutionalSubscriptionDAO\_fromRow(), PKPTemplateResource\_getFilename(), PKP\Services\QueryBuilders\PKPStatsQueryBuilder\_getObject(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject(), PKPAcronPlugin\_parseCrontab(), AccessKeyDAO\_returnAccessKeyFromRow(), UserGroupDAO\_returnFromRow(), PKPOAIDAO\_returnIdentifierFromRow(), IssueDAO\_returnIssueFromRow(), PKPOAIDAO\_returnRecordFromRow(), ReviewFormResponseDAO\_returnReviewFormResponseFromRow(), TemporaryFileDAO\_returnTemporaryFileFromRow(), VersionDAO\_returnVersionFromRow(), PKP\Services\PKPAnnouncementService\add(), PKP\Services\PKPAuthorService\add(), PKP\Services\PKPEmailTemplateService\add(), APP\Services\GalleyService\add(), PKP\Services\PKPContextService\add(), PKP\Services\PKPPublicationService\add(), PKP\Services\PKPSubmissionService\add(), EditorAction\addReviewer(), ArticleSearchIndex\articleDeleted(), HtmlArticleGalleyPlugin\articleDownloadCallback(), LensGalleyPlugin\articleDownloadCallback(), EventLogDAO\build(), EmailLogDAO\build(), PKPTemplateManager\compileLess(), ReviewerAction\confirmReview(), SubmissionFileManager\copyFileToFileStage(), PageHandler\css(), PKP\Services\PKPAnnouncementService\delete(), PKP\Services\PKPAuthorService\delete(), PKP\Services\PKPEmailTemplateService\delete(), APP\Services\GalleyService\delete(), PKP\Services\PKPContextService\delete(), PKP\Services\PKPPublicationService\delete(), PKP\Services\PKPSubmissionService\delete(), IssueGalleyDAO\deleteById(), FileManager\deleteByPath(), CrossRefExportPlugin\depositXML(), Installer\destroy(), Dispatcher\dispatch(), PKPTemplateManager\display(), IssueHandler\download(), ArticleHandler\download(), FileManager\downloadByPath(), PKP\Services\PKPSiteService\edit(), PKP\Services\PKPAnnouncementService\edit(), PKP\Services\PKPAuthorService\edit(), PKP\Services\PKPEmailTemplateService\edit(), APP\Services\GalleyService\edit(), PKP\Services\PKPContextService\edit(), PKP\Services\PKPPublicationService\edit(), PKP\Services\PKPSubmissionService\edit(), UnassignReviewerForm\execute(), ReinstateReviewerForm\execute(), IssueAccessForm\execute(), ThankReviewerForm\execute(), IssueForm\execute(), Form\execute(), Filter\execute(), Installer\executeInstaller(), Dc11SchemaArticleAdapter\extractMetadataFromDataObject(), Form\fetch(), PKPTemplateManager\fetch(), IssueFileManager\fromTemporaryFile(), PKP\Services\PKPSchemaService\get(), PKPStatsUserHandler\get(), PKPStatsEditorialHandler\get(), PKPStatsPublicationHandler\get(), PKPStatsPublicationHandler\getAbstract(), DAO\getAdditionalFieldNames(), PKPStatsEditorialHandler\getAverages(), PKP\Services\PKPStatsEditorialService\getAverages(), PKP\Services\PKPSubmissionService\getBackendListProperties(), PKPRequest\getBasePath(), PKPRequest\getBaseUrl(), IssueGalleyDAO\getById(), IssueGalleyDAO\getByIssueId(), IssueGalleyDAO\getByPubId(), PluginRegistry\getCategories(), CitationStyleLanguagePlugin\getCitationDownloads(), CitationStyleLanguagePlugin\getCitationStyles(), PKPRequest\getCompleteUrl(), PKP\components\forms\FormComponent\getConfig(), PKP\Services\QueryBuilders\PKPEmailTemplateQueryBuilder\getCustom(), PKP\Services\QueryBuilders\PKPEmailTemplateQueryBuilder\getDefault(), PKP\Services\PKPNavigationMenuService\getDisplayStatus(), APP\Services\SectionService\getFullProperties(), APP\Services\IssueService\getFullProperties(), PKP\Services\PKPUserService\getFullProperties(), PKPStatsPublicationHandler\getGalley(), PKPRequest\getIndexUrl(), PKPRouter\getIndexUrl(), OAIDAO\getJournalSets(), Form\getLocaleFieldNames(), DAO\getLocaleFieldNames(), Submission\getLocalizedGalleys(), PKPVocabHandler\getMany(), PKPUserHandler\getMany(), PKPBackendSubmissionsHandler\getMany(), IssueHandler\getMany(), PKPEmailTemplateHandler\getMany(), PKPContextHandler\getMany(), PKPStatsPublicationHandler\getMany(), PKPAnnouncementHandler\getMany(), PKPSubmissionHandler\getMany(), PKPStatsPublicationHandler\getManyAbstract(), PKPStatsPublicationHandler\getManyGalley(), PKP\Services\PKPNavigationMenuService\getMenuItemCustomEditTemplates(), PKP\Services\PKPNavigationMenuService\getMenuItemTypes(), NotificationManager\getNotificationMessage(), PKPNotificationSettingsForm\getNotificationSettingCategories(), PKPNotificationSettingsForm\getNotificationSettingsMap(), PKP\Services\PKPStatsService\getOrderedObjects(), PKP\Services\PKPStatsEditorialService\getOverview(), PKP\Services\PKPSiteService\getProperties(), APP\Services\SectionService\getProperties(), APP\Services\GalleyService\getProperties(), PKP\Services\PKPAnnouncementService\getProperties(), PKP\Services\PKPAuthorService\getProperties(), PKP\Services\PKPPublicationService\getProperties(), PKP\Services\PKPEmailTemplateService\getProperties(), PKP\Services\PKPContextService\getProperties(), PKP\Services\PKPSubmissionService\getProperties(), APP\Services\IssueService\getProperties(), PKP\Services\PKPUserService\getProperties(), PKPRequest\getProtocol(), APP\Services\QueryBuilders\GalleyQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPAnnouncementQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPPublicationQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPAuthorQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPContextQueryBuilder\getQuery(), APP\Services\QueryBuilders\IssueQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder\getQuery(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery(), APP\Services\GalleyService\getQueryBuilder(), PKP\Services\PKPAnnouncementService\getQueryBuilder(), PKP\Services\PKPAuthorService\getQueryBuilder(), PKP\Services\PKPPublicationService\getQueryBuilder(), PKP\Services\PKPUserService\getQueryBuilder(), APP\Services\IssueService\getQueryBuilder(), PKP\Services\PKPEmailTemplateService\getQueryBuilder(), PKP\Services\PKPSubmissionService\getQueryBuilder(), PKP\Services\PKPContextService\getQueryBuilder(), PKP\Services\PKPStatsService\getQueryBuilder(), PKP\Services\PKPStatsEditorialService\getQueryBuilder(), PKPRequest\getQueryString(), PKP\Services\PKPStatsService\getRecords(), PKPRequest\getRemoteAddr(), PKPRequest\getRemoteDomain(), PKPRouter\getRequestedContextPaths(), Request\getRequestedJournalPath(), PKPRequest\getRequestPath(), PKPRequest\getRequestUrl(), ArticleSearch\getResultSetOrderingOptions(), PKPUserHandler\getReviewers(), PKP\Services\PKPUserService\getReviewersQueryBuilder(), PKP\Services\PKPUserService\getReviewerSummaryProperties(), PKPComponentRouter\getRpcServiceEndpoint(), PKPRequest\getServerHost(), ArticleSearch\getSimilarityTerms(), PKPEditorDecisionActionsManager\getStageDecisions(), APP\Services\SectionService\getSummaryProperties(), APP\Services\IssueService\getSummaryProperties(), PKP\Services\PKPUserService\getSummaryProperties(), PKP\Services\PKPStatsService\getTimeline(), PKPUsageEventPlugin\getUsageEvent(), PKPRequest\getUserAgent(), JournalOAI\identifiers(), Form\initData(), GridHandler\initFeatures(), ArticleTombstoneManager\insertArticleTombstone(), IssueGalleyDAO\insertObject(), PKPLocale\installLocale(), PluginRegistry\loadCategory(), PKPUserAction\mergeUsers(), OAI\metadataFormats(), Installer\parseInstaller(), Installer\postInstall(), Installer\preInstall(), PKP\Services\PKPPublicationService\publish(), IssueGridHandler\publishIssue(), Form\readUserVars(), ArticleSearchIndex\rebuildIndex(), EditorAction\recordDecision(), JournalOAI\records(), PKPRequest\redirectUrl(), PKPLocale\registerLocaleFile(), PKP\Services\PKPEmailTemplateService\restoreDefaults(), PKP\Services\PKPContextService\restoreLocaleDefaults(), DAO\retrieve(), DAO\retrieveCached(), DAO\retrieveLimit(), DAO\retrieveRange(), SubmissionSearch\retrieveResults(), PKPPageRouter\route(), PKPSubmissionHandler\saveStep(), Mail\send(), EditorAction\setDueDates(), JournalOAI\sets(), PKPTemplateManager\setupBackendPage(), APIHandler\setupEndpoints(), PKPTemplateManager\smartyCallHook(), ArticleSearchIndex\submissionChangesFinished(), ArticleSearchIndex\submissionFileChanged(), ArticleSearchIndex\submissionFileDeleted(), ArticleSearchIndex\submissionFilesChanged(), ArticleSearchIndex\submissionMetadataChanged(), GoogleScholarPlugin\submissionView(), IssueAction\subscribedDomain(), IssueAction\subscribedUser(), IssueAction\subscriptionRequired(), PKPLocale\translate(), PKP\Services\PKPPublicationService\unpublish(), IssueGridHandler\unpublishIssue(), DAO\update(), PKP\Services\PKPSubmissionService\updateStatus(), Installer\updateVersion(), PKPUploadPublicFileHandler\uploadFile(), PKP\Services\PKPAnnouncementService\validate(), PKP\Services\PKPEmailTemplateService\validate(), Form\validate(), PKP\Services\PKPPublicationService\validatePublish(), PKP\Services\PKPPublicationService\version(), IssueHandler\view(), and ArticleHandler\view().
|
static |
Clear hooks registered against the given name.
$hookName | string Name of hook |
Definition at line 58 of file HookRegistry.inc.php.
References getHooks().
Referenced by ArticleSearchIndexTest\testDeleteTextIndex(), ArticleSearchIndexTest\testDeleteTextIndexViaPluginHook(), ArticleSearchIndexTest\testIndexArticleMetadata(), ArticleSearchIndexTest\testIndexArticleMetadataViaPluginHook(), ArticleSearchIndexTest\testIndexSubmissionFiles(), ArticleSearchIndexTest\testIndexSubmissionFilesViaPluginHook(), ArticleSearchIndexTest\testRebuildIndex(), ArticleSearchIndexTest\testRebuildIndexViaPluginHook(), PKPRequestTest\testRedirectUrl(), ArticleSearchTest\testRetrieveResults(), ArticleSearchTest\testRetrieveResultsViaPluginHook(), and ArticleSearchIndexTest\testUpdateFileIndexViaPluginHook().
|
static |
Return a reference to the stored hooks.
Definition at line 153 of file HookRegistry.inc.php.
Referenced by call(), resetCalledHooks(), ArticleSearchIndexTest\testDeleteTextIndexViaPluginHook(), PKPRequestTest\testGetBasePath(), PKPRequestTest\testGetBaseUrl(), PKPRouterTestCase\testGetIndexUrl(), PKPRequestTest\testGetProtocolNoHttpsVariable(), PKPRouterTestCase\testGetRequestedContextPathWithFullContextParameters(), PKPRouterTestCase\testGetRequestedContextPathWithFullPathInfo(), PKPRequestTest\testGetRequestPath(), ArticleSearchIndexTest\testIndexArticleMetadataViaPluginHook(), ArticleSearchIndexTest\testIndexSubmissionFilesViaPluginHook(), PKPRequestTest\testRedirectUrl(), ArticleSearchTest\testRetrieveResultsViaPluginHook(), and ArticleSearchIndexTest\testUpdateFileIndexViaPluginHook().
|
static |
Get the current set of hook registrations.
$hookName | string Name of hook to optionally return |
Definition at line 28 of file HookRegistry.inc.php.
References Registry\get().
Referenced by call(), PKPAcronPlugin\callbackManage(), clear(), PageHandler\css(), PKPUsageEventPlugin\getUsageEvent(), register(), setHooks(), and FunctionalMedraExportTest\testExportUnregisteredDois().
|
static |
Register a hook against the given hook name.
$hookName | string Name of hook to register against |
$callback | object Callback pseudotype |
$hookSequence | int Optional hook sequence specifier HOOK_SEQUENCE_... |
Definition at line 70 of file HookRegistry.inc.php.
References getHooks().
Referenced by StatsHandler\__construct(), BackendSubmissionsHandler\__construct(), APP\Services\ContextService\__construct(), APP\Services\SubmissionService\__construct(), APP\Services\PublicationService\__construct(), APP\Services\NavigationMenuService\__construct(), UsageStatsPlugin\displayReaderStatistics(), SettingsHandler\distribution(), rebuildSearchIndex\execute(), ImmersionThemePlugin\init(), HealthSciencesThemePlugin\init(), CriticalTimesThemePlugin\init(), PKPTemplateManager\initialize(), SubscriptionSSOPlugin\register(), PdfJsViewerPlugin\register(), HypothesisPlugin\register(), DublinCoreMetaPlugin\register(), GoogleAnalyticsPlugin\register(), AnnouncementFeedPlugin\register(), GoogleScholarPlugin\register(), HtmlArticleGalleyPlugin\register(), LensGalleyPlugin\register(), TinyMCEPlugin\register(), BrowseBySectionPlugin\register(), DOIPubIdPlugin\register(), URNPubIdPlugin\register(), OAIMetadataFormatPlugin\register(), PKPPubIdPlugin\register(), SwordPlugin\register(), DRIVERPlugin\register(), RecommendByAuthorPlugin\register(), RecommendBySimilarityPlugin\register(), PKPUsageEventPlugin\register(), CustomBlockManagerPlugin\register(), DefaultTranslationPlugin\register(), WebFeedPlugin\register(), PKPAcronPlugin\register(), TexturePlugin\register(), ManualPaymentPlugin\register(), PaypalPaymentPlugin\register(), OrcidProfilePlugin\register(), StaticPagesPlugin\register(), CitationStyleLanguagePlugin\register(), PubObjectsExportPlugin\register(), PLNPlugin\register(), ThemePlugin\register(), MarkupPlugin\register(), Plugin\register(), UsageStatsPlugin\register(), ArticleSearchIndexTest\testDeleteTextIndexViaPluginHook(), FunctionalMedraExportTest\testExportUnregisteredDois(), ArticleSearchIndexTest\testIndexArticleMetadataViaPluginHook(), ArticleSearchIndexTest\testIndexSubmissionFilesViaPluginHook(), ArticleSearchIndexTest\testRebuildIndexViaPluginHook(), PKPRequestTest\testRedirectUrl(), ArticleSearchTest\testRetrieveResultsViaPluginHook(), and ArticleSearchIndexTest\testUpdateFileIndexViaPluginHook().
|
static |
Set/query the flag that triggers storing of called hooks.
$askOnly | boolean When set to true, the flag will not be changed but only returned. |
$updateTo | boolean When $askOnly is set to 'true' then this parameter defines the value of the flag. |
Definition at line 128 of file HookRegistry.inc.php.
Referenced by resetCalledHooks(), PKPRequestTest\setUp(), PKPRouterTestCase\setUp(), ArticleSearchIndexTest\setUp(), and ArticleSearchTest\setUp().
|
static |
Switch off the function to store hooks and delete all stored hooks. Always call this after using otherwise we get a severe memory.
$leaveAlive | boolean Set this to true if you only want to delete hooks stored so far but if you want to record future hook calls, too. |
Definition at line 143 of file HookRegistry.inc.php.
References getCalledHooks(), and rememberCalledHooks().
Referenced by PKPRequestTest\tearDown(), PKPRouterTestCase\tearDown(), ArticleSearchIndexTest\tearDown(), ArticleSearchTest\tearDown(), PKPRequestTest\testGetBasePath(), PKPRequestTest\testGetBaseUrl(), PKPRouterTestCase\testGetIndexUrl(), PKPRequestTest\testGetProtocolNoHttpsVariable(), PKPRouterTestCase\testGetRequestedContextPathWithFullContextParameters(), PKPRouterTestCase\testGetRequestedContextPathWithFullPathInfo(), PKPRequestTest\testGetRequestPath(), and ArticleSearchTest\testRetrieveResultsViaPluginHook().
|
static |
Set the hooks table for the given hook name to the supplied array of callbacks.
$hookName | string Name of hook to set |
$callbacks | array Array of callbacks for this hook |
Definition at line 49 of file HookRegistry.inc.php.
References getHooks().