X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=2f91a305f0cce8eaec4ac19c21f4f898a855af4c;hb=9077e3cea57c405325e3ebf0eaf1258fae2d0216;hp=b61fff8a182a9b770a462e7bd75cec72f97872ab;hpb=2eea7a2d4b18765be42810eb53ff1ae710ffe7d4;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index b61fff8a18..2f91a305f0 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -2,6 +2,13 @@ InitializePlugin: a chance to initialize a plugin in a complete environment CleanupPlugin: a chance to cleanup a plugin at the end of a program +StartActionExecute: Right before the "prepare" call of the current Action +- $action: the current Action object +- &$args: array of arguments, referenced so you can modify the array + +EndActionExecute: Right after the "handle" call of the current Action +- $action: the current Action object + StartPrimaryNav: Showing the primary nav menu - $action: the current action @@ -257,6 +264,22 @@ StartShowNoticeItem: just before showing the notice item EndShowNoticeItem: just after showing the notice item - $item: the NoticeListItem object being shown +StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML +- $item: The NoticeListItem object being shown + +EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML +- $item: The NoticeListItem object being shown + +StartShowNoticeContent: just before outputting the content part of a Notice +- $stored: The Notice object +- $out: HTMLOutputter for writing to +- $scoped: optional Profile object for permission scoping + +EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually +- $stored: The Notice object +- $out: HTMLOutputter for writing to +- $scoped: optional Profile object for permission scoping + StartShowNoticeInfo: just before showing notice info - $item: The NoticeListItem object being shown @@ -290,19 +313,21 @@ StartProfileSaveForm: before starting to save a profile settings form EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!) - $action: action object being shown -StartEmailFormData: just before showing text entry fields on email settings page -- $action: action object being shown +StartEmailFormData: just before showing form input fields on email settings page +- $action: Action object being shown +- $scoped: Profile for whom settings are being configured -EndEmailFormData: just after showing text entry fields on email settings page +EndEmailFormData: just after showing form input fields on email settings page - $action: action object being shown +- $scoped: Profile for whom settings are being configured StartEmailSaveForm: before starting to save a email settings form - $action: action object being shown -- &$user: user being saved +- $scoped: Profile user having their email settings saved EndEmailSaveForm: after saving a email settings form (after commit) - $action: action object being shown -- &$user: user being saved +- $scoped: Profile user having their email settings saved StartRegistrationFormData: just before showing text entry fields on registration page - $action: action object being shown @@ -590,12 +615,12 @@ EndCheckPassword: After checking a username/password pair - $authenticatedUser: User object if credentials match a user, else null. StartChangePassword: Before changing a password -- $user: user +- Profile $target: The profile of the User that is changing password - $oldpassword: the user's old password - $newpassword: the desired new password EndChangePassword: After changing a password -- $user: user +- Profile $target: The profile of the User that just changed its password StartHashPassword: Generate a hashed version of the password (like a salted crypt) - &$hashed: Hashed version of the password, later put in the database @@ -609,10 +634,10 @@ EndSetUser: After setting the currently logged in user - $user: user StartSetApiUser: Before setting the current API user -- $user: user +- &$user: user, can be set during event handling (return false to stop processing) EndSetApiUser: After setting the current API user -- $user: user +- $user: user, only called if this is an actual user StartHasRole: Before determing if the a profile has a given role - $profile: profile in question @@ -952,12 +977,12 @@ EndRevokeRole: when a role has been revoked StartAtomPubNewActivity: When a new activity comes in through Atom Pub API - &$activity: received activity -- $user: user publishing the entry +- $profile: profile of the user publishing the entry - &$notice: notice created; initially null, can be set EndAtomPubNewActivity: When a new activity comes in through Atom Pub API - $activity: received activity -- $user: user publishing the entry +- $profile: profile of the user publishing the entry - $notice: notice that was created AdminPanelCheck: When checking whether the current user can access a given admin panel @@ -1426,6 +1451,9 @@ StartResizeImageFile: Hook to resize an image and output it to a file. No matchi - $outpath: string with output filepath - $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h'). +FillImageFileMetadata: Get more metadata about the ImageFile if it is perhaps not a real local file +- $imagefile ImageFile object which we're getting metadata for (such as animated status, width/height etc.) + StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews). - $out: HTMLOutputter class to use for outputting HTML. - $file: 'File' object which we're going to show representation for. @@ -1445,3 +1473,27 @@ StartNotifyMentioned: During notice distribution, we send notifications (email, EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned. - $stored: Notice object that is being distributed. - $mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice. + +StartHomeStubNavItems: Go back Home nav items. Default includes just one item 'home' +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- &$items: Referenced array of items in the nav (add if desired) + +EndHomeStubNavItems: +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $items: array of menu items + +StartSubMenu: Before outputting a submenu (including enclosing tags) to HTML +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $menu: The Menu object outputted as a submenu. +- $label: Localized text which represents the menu item. + +EndSubMenu: After outputting a submenu (including enclosing tags) to HTML +- $out: HTMLOutputter used to output (usually an Action, but not always!) +- $menu: The Menu object outputted as a submenu. +- $label: Localized text which represents the menu item. + +StartDocNav: Before outputting the docs Nav +- $nav: The DoclNav widget + +EndDocNav: After outputting the docs Nav +- $nav: The DoclNav widget