element - $action: action being shown @@ -1456,6 +1423,11 @@ CreateFileImageThumbnailSource: Hook to create image thumbnail source from a Fil - &$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. @@ -1467,3 +1439,11 @@ EndShowAttachmentRepresentation: Executed after Attachment representation, despi 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=255869afda41845dd1cd1654358d443f37aaf599;hb=40b2ce60ee3fe1281362294269b4c18c6a55c2ae;hp=6e32042453895261b9537884224bdb604c21e62a;hpb=1a811883556086b9a754d07b0dc996d3000dcbf1;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 6e32042453..255869afda 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 @@ -267,12 +269,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 +290,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 @@ -799,40 +797,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 +888,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 @@ -1456,6 +1423,11 @@ CreateFileImageThumbnailSource: Hook to create image thumbnail source from a Fil - &$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. @@ -1467,3 +1439,11 @@ EndShowAttachmentRepresentation: Executed after Attachment representation, despi 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.