CWIS Developer Documentation
Events.php
Go to the documentation of this file.
1 <?PHP
2 
3 # ----- HOOKABLE CWIS EVENTS
4 # (Only the events covered in the Developer Documentation have been implemented.)
5 $GLOBALS["AF"]->RegisterEvent(array(
6  # --- User Events
7  "EVENT_USER_ADDED" => ApplicationFramework::EVENTTYPE_DEFAULT,
8  "EVENT_USER_VERIFIED" => ApplicationFramework::EVENTTYPE_DEFAULT,
9  "EVENT_USER_DELETED" => ApplicationFramework::EVENTTYPE_DEFAULT,
10  "EVENT_USER_LOGIN" => ApplicationFramework::EVENTTYPE_DEFAULT,
11  "EVENT_USER_LOGIN_RETURN" => ApplicationFramework::EVENTTYPE_CHAIN,
12  "EVENT_USER_LOGOUT" => ApplicationFramework::EVENTTYPE_DEFAULT,
13  "EVENT_USER_LOGOUT_RETURN" => ApplicationFramework::EVENTTYPE_CHAIN,
14  "EVENT_USER_PASSWORD_CHANGED" => ApplicationFramework::EVENTTYPE_DEFAULT,
15  "EVENT_USER_REAL_NAME_CHANGED" => ApplicationFramework::EVENTTYPE_DEFAULT,
16  "EVENT_USER_EMAIL_CHANGED" => ApplicationFramework::EVENTTYPE_DEFAULT,
17  "EVENT_USER_AUTHENTICATION" => ApplicationFramework::EVENTTYPE_FIRST,
18  "EVENT_USER_SIGNUP_VERIFY" => ApplicationFramework::EVENTTYPE_CHAIN,
19  "EVENT_USER_SIGNUP_EXTEND_ERROR_LIST" => ApplicationFramework::EVENTTYPE_CHAIN,
20  # --- Search Events
21  "EVENT_KEYWORD_SEARCH" => ApplicationFramework::EVENTTYPE_CHAIN,
22  "EVENT_FIELDED_SEARCH" => ApplicationFramework::EVENTTYPE_CHAIN,
23  "EVENT_SEARCH_RESULTS" => ApplicationFramework::EVENTTYPE_CHAIN,
24  "EVENT_SEARCH_COMPLETE" => ApplicationFramework::EVENTTYPE_DEFAULT,
25  "EVENT_SEARCH_EXTERNAL" => ApplicationFramework::EVENTTYPE_NAMED,
26  # --- Resource Events
27  "EVENT_RESOURCE_CREATE" => ApplicationFramework::EVENTTYPE_DEFAULT,
28  "EVENT_RESOURCE_ADD" => ApplicationFramework::EVENTTYPE_DEFAULT,
29  "EVENT_RESOURCE_DUPLICATE" => ApplicationFramework::EVENTTYPE_DEFAULT,
30  "EVENT_RESOURCE_MODIFY" => ApplicationFramework::EVENTTYPE_DEFAULT,
31  "EVENT_RESOURCE_DELETE" => ApplicationFramework::EVENTTYPE_DEFAULT,
32  "EVENT_RESOURCE_FILE_ADD" => ApplicationFramework::EVENTTYPE_DEFAULT,
33  "EVENT_RESOURCE_FILE_DELETE" => ApplicationFramework::EVENTTYPE_DEFAULT,
34  "EVENT_RESOURCE_AUTHOR_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
35  "EVENT_RESOURCE_EDIT_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
36  "EVENT_RESOURCE_VIEW_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
37  "EVENT_RESOURCE_SHOW_RATING" => ApplicationFramework::EVENTTYPE_CHAIN,
38  # --- Metadata Field Events
39  "EVENT_PRE_FIELD_EDIT_FILTER" => ApplicationFramework::EVENTTYPE_CHAIN,
40  "EVENT_POST_FIELD_EDIT_FILTER" => ApplicationFramework::EVENTTYPE_CHAIN,
41  "EVENT_FIELD_DISPLAY_FILTER" => ApplicationFramework::EVENTTYPE_CHAIN,
42  "EVENT_FIELD_SEARCH_FILTER" => ApplicationFramework::EVENTTYPE_CHAIN,
43  "EVENT_APPEND_HTML_TO_FIELD_DISPLAY" => ApplicationFramework::EVENTTYPE_CHAIN,
44  "EVENT_FIELD_VIEW_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
45  "EVENT_FIELD_AUTHOR_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
46  "EVENT_FIELD_EDIT_PERMISSION_CHECK" => ApplicationFramework::EVENTTYPE_CHAIN,
47  "EVENT_CNAME_REMAPPED" => ApplicationFramework::EVENTTYPE_DEFAULT,
48  "EVENT_FIELD_ADDED" => ApplicationFramework::EVENTTYPE_DEFAULT,
49  "EVENT_PRE_FIELD_DELETE" => ApplicationFramework::EVENTTYPE_DEFAULT,
50  # --- User Interface Events
51  "EVENT_IN_HTML_HEADER" => ApplicationFramework::EVENTTYPE_DEFAULT,
52  "EVENT_REQUEST_SIDEBAR_CONTENT" => ApplicationFramework::EVENTTYPE_NAMED,
53  "EVENT_COLLECTION_ADMINISTRATION_MENU" => ApplicationFramework::EVENTTYPE_NAMED,
54  "EVENT_USER_ADMINISTRATION_MENU" => ApplicationFramework::EVENTTYPE_NAMED,
55  "EVENT_SYSTEM_ADMINISTRATION_MENU" => ApplicationFramework::EVENTTYPE_NAMED,
56  "EVENT_DEVELOPER_SUPPORT_MENU" => ApplicationFramework::EVENTTYPE_NAMED,
57  "EVENT_SYSTEM_INFO_LIST" => ApplicationFramework::EVENTTYPE_NAMED,
58  "EVENT_MODIFY_PRIMARY_NAV" => ApplicationFramework::EVENTTYPE_CHAIN,
59  "EVENT_MODIFY_SECONDARY_NAV" => ApplicationFramework::EVENTTYPE_CHAIN,
60  "EVENT_APPEND_HTML_TO_FORM" => ApplicationFramework::EVENTTYPE_CHAIN,
61  "EVENT_VALIDATE_USER_COMMENT" => ApplicationFramework::EVENTTYPE_FIRST,
62  "EVENT_URL_FIELD_CLICK" => ApplicationFramework::EVENTTYPE_DEFAULT,
63  "EVENT_FULL_RECORD_VIEW" => ApplicationFramework::EVENTTYPE_DEFAULT,
64  "EVENT_HTML_INSERTION_POINT" => ApplicationFramework::EVENTTYPE_DEFAULT,
65  "EVENT_IMAGE_URL_FILTER" => ApplicationFramework::EVENTTYPE_CHAIN,
66  "EVENT_FILTER_RESOURCE_BROWSE_LIST" => ApplicationFramework::EVENTTYPE_CHAIN,
67  # --- Plugin Events
68  "EVENT_PLUGIN_CONFIG_CHANGE" => ApplicationFramework::EVENTTYPE_DEFAULT,
69  "EVENT_PLUGIN_EXTEND_EDIT_RESOURCE_COMPLETE_ACCESS_LIST" => ApplicationFramework::EVENTTYPE_CHAIN,
70  # --- Other Events
71  "EVENT_OAIPMH_REQUEST" => ApplicationFramework::EVENTTYPE_DEFAULT,
72  "EVENT_GET_SYSCONFIG_VALUE" => ApplicationFramework::EVENTTYPE_CHAIN,
73  "EVENT_SET_SYSCONFIG_VALUE" => ApplicationFramework::EVENTTYPE_CHAIN,
74  "EVENT_LOCAL_COLLECTION_STATS" => ApplicationFramework::EVENTTYPE_CHAIN,
75  ));
const EVENTTYPE_NAMED
Named result event type.
const EVENTTYPE_FIRST
First response event type.
const EVENTTYPE_DEFAULT
Default event type.
Definition: User.php:48
const EVENTTYPE_CHAIN
Result chaining event type.
Base class for all plugins.
Definition: Plugin.php:13
Represents a "resource" in CWIS.
Definition: Resource.php:13