element - $action: action being shown @@ -987,12 +970,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 @@ -1298,6 +1281,16 @@ EndShowGroupProfileBlock: After showing the profile block for a group - $out: XMLOutputter to append custom output - $group: the group being shown +StartShowConversation: start the listing of a conversation +- $action: Action object (used mainly as HTMLOutputter) +- $conv: Conversation object, has functions to retrieve relevant notices +- $scoped: Profile for scoping (null if not logged in) + +EndShowConversation: after the listing of a conversation +- $action: Action object (used mainly as HTMLOutputter) +- $conv: Conversation object, has functions to retrieve relevant notices +- $scoped: Profile for scoping (null if not logged in) + StartShowThreadedNoticeTail: when showing the replies etc. to a notice - $nli: parent noticelistitem - $notice: parent notice @@ -1440,3 +1433,33 @@ OtherAccountProfiles: Hook to add account profiles to a user account profile blo href: link to the profile text: text for the profile image: mini image for the profile + +CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File +- $file: 'File' object to source the image from +- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm. +- $media: MIME media type ('image', 'video', 'audio' etc.) + +StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet. +- $imagefile: ImageFile object we're resizing. +- $outpath: string with output filepath +- $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h'). + +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. + +EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media. +- $out: HTMLOutputter class to use for outputting HTML. +- $file: 'File' object which we're going to show representation for. + +ShowUnsupportedAttachmentRepresentation: 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. + +StartNotifyMentioned: 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. + +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.

X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=8f094d16434a3b86e270806e758ce769e68f2b33;hb=ee23dc8ccfea2fec1c8061b0e7de52cc2aa42864;hp=0a1951d6403fb8b8f0ac8329dd550a547901a174;hpb=1e37f374b38773da2b68cdcc28bbc72c89ea3eb1;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 0a1951d640..8f094d1643 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -216,7 +216,9 @@ EndShowBody: called after showing the element (and ) - $action: action object being shown StartPersonalGroupNav: beginning of personal group nav menu -- $action: action object being shown +- $menu: Menu list object being shown +- $target: Profile for whom it is shown +- $scoped: Profile of currently logged in user (or null) EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item) - $action: action object being shown @@ -255,6 +257,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 @@ -267,12 +285,6 @@ StartShowNoticeOptions: just before showing notice options like fave, repeat, et EndShowNoticeOptions: just after showing notice options like fave, repeat, etc. - $item: the NoticeListItem object being shown -StartShowFaveForm: just before showing the fave form -- $item: the NoticeListItem object being shown - -EndShowFaveForm: just after showing the fave form -- $item: the NoticeListItem object being shown - StartShowPageNotice: just before showing the page notice (instructions or error) - $action: action object being shown @@ -294,19 +306,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 @@ -613,10 +627,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 @@ -799,40 +813,6 @@ EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw - $profile: Profile of user we want to get acct: URI for - &$acct: string with the resulting acct: uri -StartFavorNotice: Saving a notice as a favorite -- $profile: profile of the person faving (can be remote!) -- $notice: notice being faved -- &$fave: Favor object; null to start off with, but feel free to override. - -EndFavorNotice: After saving a notice as a favorite -- $profile: profile of the person faving (can be remote!) -- $notice: notice being faved - -StartDisfavorNotice: Saving a notice as a favorite -- $profile: profile of the person faving (can be remote!) -- $notice: notice being faved -- &$result: result of the disfavoring (if you override) - -EndDisfavorNotice: After saving a notice as a favorite -- $profile: profile of the person faving (can be remote!) -- $notice: notice being faved - -StartFavorNoticeForm: starting the data in the form for favoring a notice -- $FavorForm: the favor form being shown -- $notice: notice being favored - -EndFavorNoticeForm: Ending the data in the form for favoring a notice -- $FavorForm: the favor form being shown -- $notice: notice being favored - -StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice -- $DisfavorForm: the disfavor form being shown -- $notice: notice being difavored - -EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice -- $DisfavorForm: the disfavor form being shown -- $notice: notice being disfavored - StartFindMentions: start finding mentions in a block of text - $sender: sender profile - $text: plain text version of the notice @@ -924,6 +904,9 @@ EndRssEntryArray: at the end of copying a notice to an array NoticeDeleteRelated: at the beginning of deleting related fields to a notice - $notice: notice being deleted +FileDeleteRelated: at the beginning of deleting related fields to a File +- $notice: File being deleted + StartShowHeadTitle: when beginning to show the element - $action: action being shown @@ -987,12 +970,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 @@ -1298,6 +1281,16 @@ EndShowGroupProfileBlock: After showing the profile block for a group - $out: XMLOutputter to append custom output - $group: the group being shown +StartShowConversation: start the listing of a conversation +- $action: Action object (used mainly as HTMLOutputter) +- $conv: Conversation object, has functions to retrieve relevant notices +- $scoped: Profile for scoping (null if not logged in) + +EndShowConversation: after the listing of a conversation +- $action: Action object (used mainly as HTMLOutputter) +- $conv: Conversation object, has functions to retrieve relevant notices +- $scoped: Profile for scoping (null if not logged in) + StartShowThreadedNoticeTail: when showing the replies etc. to a notice - $nli: parent noticelistitem - $notice: parent notice @@ -1440,3 +1433,33 @@ OtherAccountProfiles: Hook to add account profiles to a user account profile blo href: link to the profile text: text for the profile image: mini image for the profile + +CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File +- $file: 'File' object to source the image from +- &$imgPath: Path to image file which can be used as source for our thumbnail algorithm. +- $media: MIME media type ('image', 'video', 'audio' etc.) + +StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet. +- $imagefile: ImageFile object we're resizing. +- $outpath: string with output filepath +- $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h'). + +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. + +EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media. +- $out: HTMLOutputter class to use for outputting HTML. +- $file: 'File' object which we're going to show representation for. + +ShowUnsupportedAttachmentRepresentation: 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. + +StartNotifyMentioned: 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. + +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.