X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=1ed670697b7570506662bbf617f0754b25329cde;hb=9e7f47652d860d7f1e296dd369c4e68814bf2636;hp=9de2f8bc6bbfffaa271a442be37e8c36ba811ad3;hpb=76ac7c358a3245f4032f49152055cae94c4616ff;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 9de2f8bc6b..1ed670697b 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -129,6 +129,9 @@ StartSubGroupNav: Showing the subscriptions group nav menu EndSubGroupNav: At the end of the subscriptions group nav menu - $action: the current action +StartInitializeRouter: Before the router instance has been initialized; good place to add routes +- $m: the Net_URL_Mapper that has just been set up + RouterInitialized: After the router instance has been initialized - $m: the Net_URL_Mapper that has just been set up @@ -147,6 +150,12 @@ StartAddressData: Allows the site owner to provide additional information about EndAddressData: At the end of
- $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 @@ -159,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. @@ -188,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 tag - $action: action object being shown @@ -245,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,98 +358,344 @@ CheckSchema: chance to check the schema 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 ) +- $profilelist: ProfileList widget + +StartProfileListItem: when starting to show a profile list item +- $item: ProfileListItem widget + +EndProfileListItem: after showing a profile list item +- $item: ProfileListItem widget + +StartProfileListItemProfile: the profile data part of the item +- $item: ProfileListItem widget + +EndProfileListItemProfile: the profile data part of the item +- $item: ProfileListItem widget + +StartProfileListItemActions: the actions (buttons) for an item +- $item: ProfileListItem widget + +EndProfileListItemActions: the actions (buttons) for an item +- $item: ProfileListItem widget + +StartProfileListItemProfileElements: inside the
+- $item: ProfileListItem widget + +EndProfileListItemProfileElements: inside the
+- $item: ProfileListItem widget + +StartProfileListItemAvatar: Showing a profile list avatar +- $item: ProfileListItem widget + +EndProfileListItemAvatar: Showing a profile list avatar +- $item: ProfileListItem widget + +StartProfileListItemFullName: Showing the profile list full name +- $item: ProfileListItem widget + +EndProfileListItemFullName: Showing the profile list full name +- $item: ProfileListItem widget + +StartProfileListItemLocation: Showing the profile list location +- $item: ProfileListItem widget + +EndProfileListItemLocation: Showing the profile list location +- $item: ProfileListItem widget + +StartProfileListItemHomepage: Showing the profile list homepage +- $item: ProfileListItem widget + +EndProfileListItemHomepage: Showing the profile list homepage +- $item: ProfileListItem widget + +StartProfileListItemBio: Showing the profile list bio +- $item: ProfileListItem widget + +EndProfileListItemBio: Showing the profile list bio +- $item: ProfileListItem widget + +StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons) +- $item: ProfileListItem widget + +EndProfileListItemActionElements: Showing profile list actions (append a button here) +- $item: ProfileListItem widget + +StartUserXRDS: Start XRDS output (right after the opening XRDS tag) +- $action: the current action +- &$xrdsoutputter - XRDSOutputter object to write to + +EndUserXRDS: End XRDS output (right before the closing XRDS tag) +- $action: the current action +- &$xrdsoutputter - XRDSOutputter object to write to + +StartPublicXRDS: Start XRDS output (right after the opening XRDS tag) +- $action: the current action +- &$xrdsoutputter - XRDSOutputter object to write to + +EndPublicXRDS: End XRDS output (right before the closing XRDS tag) +- $action: the current action +- &$xrdsoutputter - XRDSOutputter object to write to + +StartCheckPassword: Check a username/password +- $nickname: The nickname to check +- $password: The password to check +- &$authenticatedUser: set to User object if credentials match a user. + +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. + +StartChangePassword: Before changing a password +- $user: user +- $oldpassword: the user's old password +- $newpassword: the desired new password + +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 element is written +- $action +- &$src +- &$theme +- &$media + +EndCssLinkElement: After a element is written +- $action +- $src +- $theme +- $media + +StartStyleElement: Before a element is written +- $action +- &$code +- &$type +- &$media + +EndStyleElement: After a element is written +- $action +- $code +- $type +- $media + +StartScriptElement: Before a element is written +- $action +- &$src +- &$type + +EndScriptElement: After a element is written +- $action +- $src +- $type + +StartInlineScriptElement: Before a element is written +- $action +- &$code +- &$type + +EndInlineScriptElement: After a 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