X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=69fe2ddccb37f24de7cd429b2151abdabe4e3f6c;hb=385fb947236fcbf429a147be90569db9c7edc152;hp=201ce7dfe5642cf7ee77b17c360e2ceeccb5b29e;hpb=2d8ad0409d8e78ec35a65156bc375eacbe561963;p=quix0rs-gnu-social.git

diff --git a/EVENTS.txt b/EVENTS.txt
index 201ce7dfe5..69fe2ddccb 100644
--- a/EVENTS.txt
+++ b/EVENTS.txt
@@ -1,4 +1,4 @@
-InitializePlugin: a chance to initialize a plugin in a complete environment
+\InitializePlugin: a chance to initialize a plugin in a complete environment
 
 CleanupPlugin: a chance to cleanup a plugin at the end of a program
 
@@ -150,6 +150,12 @@ StartAddressData: Allows the site owner to provide additional information about
 EndAddressData: At the end of <address>
 - $action: the current action
 
+StartShowSiteNotice: Before showing site notice
+- $action: the current action
+
+EndShowSiteNotice: After showing site notice
+- $action: the current action
+
 StartLoginGroupNav: Before showing the login and register navigation menu
 - $action: the current action
 
@@ -162,6 +168,42 @@ StartAccountSettingsNav: Before showing the account settings menu
 EndAccountSettingsNav: After showing the account settings menu
 - $action: the current action
 
+StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsProfileMenuItem: After showing the Profile menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsPasswordMenuItem: After showing the Password menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsEmailMenuItem: Before showing the Email menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsEmailMenuItem: After showing the Email menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsDesignMenuItem: Before showing the Design menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsDesignMenuItem: After showing the Design menu item
+- $widget: AccountSettingsNav instance being shown
+
+StartAccountSettingsOtherMenuItem: Before showing the Other menu item
+- $widget: AccountSettingsNav instance being shown
+
+EndAccountSettingsOtherMenuItem: After showing the Other menu item
+- $widget: AccountSettingsNav instance being shown
+
 Autoload: When trying to autoload a class
 - $cls: the class being sought. A plugin might require_once the file for the class.
 
@@ -191,6 +233,12 @@ StartPersonalGroupNav: beginning of personal group nav menu
 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 - $action: action object being shown
 
+StartGroupGroupNav: Showing the group nav menu
+- $action: the current action
+
+EndGroupGroupNav: At the end of the group nav menu
+- $action: the current action
+
 StartEndHTML: just before the </html> tag
 - $action: action object being shown
 
@@ -248,6 +296,18 @@ StartRegistrationTry: before validating and saving a new user
 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 - $action: action object being shown
 
+StartAvatarFormData: before displaying avatar form
+- $action: action object being shown
+
+EndAvatarFormData: after displaying avatar form
+- $action: action object being shown
+
+StartAvatarSaveForm: before saving the avatar
+- $action: action object being shown
+
+EndAvatarSaveForm: after saving the avatar
+- $action: action object being shown
+
 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 - $qm: empty queue manager to set
 
@@ -295,102 +355,110 @@ EndShowHeadElements: Right before the </head> tag; put <script>s here if you nee
 
 CheckSchema: chance to check the schema
 
+StartProfileRemoteSubscribe: Before showing the link to remote subscription
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
+EndProfileRemoteSubscribe: After showing the link to remote subscription
+- $userprofile: UserProfile widget
+- &$profile: the profile being shown
+
 StartProfilePageProfileSection: Starting to show the section of the
                               profile page with the actual profile data;
                               hook to prevent showing the profile (e.g.)
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageProfileElements: inside the section, before the first
                                element; prepend elements here
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageProfileElements: inside the section, after the last element;
                              append elements here
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageProfileSection: After showing the section of the profile
                             page with the profile elements
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageActionsSection: Starting to show the section of the
                                     profile page with action links; hook
                                     to hide them (for example)
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageActionsElements: inside the list, before the first
                                      element; prepend elements here
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageActionsElements: inside the list, after the last element;
                                    append elements here
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageActionsSection: After showing the section of the profile
                                   page with the entity actions
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageAvatar: before showing the avatar on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageAvatar: after showing the avatar on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageNickname: before showing the nickname on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageNickname: after showing the nickname on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageFullName: before showing the fullname on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageFullName: after showing the fullname on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageLocation: before showing the location on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageLocation: after showing the location on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageHomepage: before showing the homepage link on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageHomepage: after showing the homepage on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageBio: before showing the bio on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageBio: after showing the bio on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfilePageProfileTags: before showing the tags on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 EndProfilePageProfileTags: after showing the tags on the profile page
-- $action: the current action
+- $userprofile: UserProfile widget
 - &$profile: the profile being shown
 
 StartProfileList: when starting a list of profiles (before <ul>)
@@ -475,17 +543,182 @@ EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 - $action: the current action
 - &$xrdsoutputter - XRDSOutputter object to write to
 
-CheckPassword: Check a username/password
+StartCheckPassword: Check a username/password
 - $nickname: The nickname to check
 - $password: The password to check
-- &$authenticated: set to true to indicate authentication succeeded.
+- &$authenticatedUser: set to User object if credentials match a user.
 
-AutoRegister: Register a new user with the given nickname. Should insert a new User and Profile into the database.
-- $nickname: The nickname to register
+EndCheckPassword: After checking a username/password pair
+- $nickname: The nickname that was checked
+- $password: The password that was checked
+- $authenticatedUser: User object if credentials match a user, else null.
 
-ChangePassword: Handle a password change request
-- $nickname: user's nickname
+StartChangePassword: Before changing a password
+- $user: user
 - $oldpassword: the user's old password
 - $newpassword: the desired new password
-- &$errormsg: set this to an error message if the password could not be changed. If the password was changed, leave this as false
+
+EndChangePassword: After changing a password
+- $user: user
+
+StartSetUser: Before setting the currently logged in user
+- $user: user
+
+EndSetUser: After setting the currently logged in user
+- $user: user
+
+StartSetApiUser: Before setting the current API user
+- $user: user
+
+EndSetApiUser: After setting the current API user
+- $user: user
+
+StartHasRole: Before determing if the a profile has a given role
+- $profile: profile in question
+- $name: name of the role in question
+- &$has_role: does this profile have the named role?
+
+EndHasRole: Before determing if the a profile has a given role
+- $profile: profile in question
+- $name: name of the role in question
+- $has_role: does this profile have the named role?
+
+UserDeleteRelated: Specify additional tables to delete entries from when deleting users
+- $user: User object
+- &$related: array of DB_DataObject class names to delete entries on matching user_id.
+
+GetUrlShorteners: Specify URL shorteners that are available for use
+- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
+
+StartShortenUrl: About to shorten a URL
+- $url: url to be shortened
+- $shortenerName: name of the requested shortener
+- &$shortenedUrl: short version of the url
+
+EndShortenUrl: After a URL has been shortened
+- $url: url to be shortened
+- $shortenerName: name of the requested shortener
+- $shortenedUrl: short version of the url
+
+StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
+- $action
+- &$src
+- &$theme
+- &$media
+
+EndCssLinkElement: After a <link rel="stylesheet"..> element is written
+- $action
+- $src
+- $theme
+- $media
+
+StartStyleElement: Before a <style...> element is written
+- $action
+- &$code
+- &$type
+- &$media
+
+EndStyleElement: After a <style...> element is written
+- $action
+- $code
+- $type
+- $media
+
+StartScriptElement: Before a <script...> element is written
+- $action
+- &$src
+- &$type
+
+EndScriptElement: After a <script...> element is written
+- $action
+- $src
+- $type
+
+StartInlineScriptElement: Before a <script...> element is written
+- $action
+- &$code
+- &$type
+
+EndInlineScriptElement: After a <script...> element is written
+- $action
+- $code
+- $type
+
+StartLog: Before writing to the logs
+- &$priority
+- &$msg
+- &$filename
+
+EndLog: After writing to the logs
+- $priority
+- $msg
+- $filename
+
+StartBlockProfile: when we're about to block
+- $user: the person doing the block
+- $profile: the person getting blocked, can be remote
+
+EndBlockProfile: when a block has succeeded
+- $user: the person doing the block
+- $profile: the person blocked, can be remote
+
+StartUnblockProfile: when we're about to unblock
+- $user: the person doing the unblock
+- $profile: the person getting unblocked, can be remote
+
+EndUnblockProfile: when an unblock has succeeded
+- $user: the person doing the unblock
+- $profile: the person unblocked, can be remote
+
+StartSubscribe: when a subscription is starting
+- $user: the person subscribing
+- $other: the person being subscribed to
+
+EndSubscribe: when a subscription is finished
+- $user: the person subscribing
+- $other: the person being subscribed to
+
+StartUnsubscribe: when an unsubscribe is starting
+- $user: the person unsubscribing
+- $other: the person being unsubscribed from
+
+EndUnsubscribe: when an unsubscribe is done
+- $user: the person unsubscribing
+- $other: the person being unsubscribed to
+
+StartJoinGroup: when a user is joining a group
+- $group: the group being joined
+- $user: the user joining
+
+EndJoinGroup: when a user finishes joining a group
+- $group: the group being joined
+- $user: the user joining
+
+StartLeaveGroup: when a user is leaving a group
+- $group: the group being left
+- $user: the user leaving
+
+EndLeaveGroup: when a user has left a group
+- $group: the group being left
+- $user: the user leaving
+
+StartShowContentLicense: Showing the default license for content
+- $action: the current action
+
+EndShowContentLicense: Showing the default license for content
+- $action: the current action
+
+StartUserRegister: When a new user is being registered
+- &$profile: new profile data (no ID)
+- &$user: new user account (no ID or URI)
+
+EndUserRegister: When a new user has been registered
+- &$profile: new profile data
+- &$user: new user account
+
+StartRobotsTxt: Before outputting the robots.txt page
+- &$action: RobotstxtAction being shown
+
+EndRobotsTxt: After the default robots.txt page (good place for customization)
+- &$action: RobotstxtAction being shown