element - $action: action being shown @@ -969,6 +949,9 @@ StartShowNoticeForm: before showing the notice form (before <form>) EndShowNoticeForm: after showing the notice form (after <form>) - $action: action being executed +StartShowEntryForms: microapp entry form tab data +- &$tabs: tab assoc array with 'tag' => (title, href to create new entry) + StartGrantRole: when a role is being assigned - $profile: profile that will have the role - $role: string name of the role @@ -987,30 +970,14 @@ 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 -StartXrdActionAliases: About to set aliases for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -EndXrdActionAliases: Done with aliases for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -StartXrdActionLinks: About to set links for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -EndXrdActionLinks: Done with links for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - AdminPanelCheck: When checking whether the current user can access a given admin panel - $name: Name of the admin panel - &$isOK: Boolean whether the user is allowed to use the panel @@ -1089,13 +1056,13 @@ EndGroupSave: After saving a group, aliases, and first member - $group: group that was saved StartInterpretCommand: Before running a command -- $cmd: First word in the string, 'foo' in 'foo argument' +- $cmd: First word in the string, 'foo' in 'foo argument' - $arg: Argument, if any, like 'argument' in 'foo argument' - $user: User who issued the command - &$result: Resulting command; you can set this! EndInterpretCommand: Before running a command -- $cmd: First word in the string, 'foo' in 'foo argument' +- $cmd: First word in the string, 'foo' in 'foo argument' - $arg: Argument, if any, like 'argument' in 'foo argument' - $user: User who issued the command - $result: Resulting command @@ -1111,11 +1078,161 @@ EndGroupActionsList: End the list of actions on a group profile page (before </u StartGroupProfileElements: Start showing stuff about the group on its profile page - $action: action being executed (for output and params) - $group: group for the page - + EndGroupProfileElements: Start showing stuff about the group on its profile page - $action: action being executed (for output and params) - $group: group for the page +StartShowProfileTagContent: When showing a people tag page +- $action: action being executed (for output and params) + +EndShowProfileTagContent: After showing the contents of a people tag page +- $action: action being executed (for output and params) + +StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles +- $action: action being executed (for output and params) + +EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles +- $action: action being executed (for output and params) + +StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers +- $action: action being executed (for output and params) + +EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers +- $action: action being executed (for output and params) + +StartTagProfileAction: When starting to show profile tagging page +- $action: action being executed (for output and params) +- $profile: profile being tagged + +EndTagProfileAction: After showing profile tagging page +- $action: action being executed (for output and params) +- $profile: profile being tagged + +StartProfileCompletionSearch: When starting a profile search for autocompletion +- $action: action being executed (for output and params) +- &$profile: result Profile objects +- $search_engine: the search engine + +EndProfileCompletionSearch: After search results for profile autocompletion have been found +- $action: profilec completion action +- &$profile: current result Profile objects +- $search_engine: The search engine object + +StartShowTagProfileForm: When showing people tagging form +- $action: action being executed (for output and params) +- $profile: profile being tagged + +EndShowTagProfileForm: After showing people tagging form +- $action: action being executed (for output and params) +- $profile: profile being tagged + +StartSavePeopletags: When starting to save people tags +- $action: action being executed (for output and params) +- $tagstring: string input, a list of tags + +EndSavePeopletags: After saving people tags +- $action: action being executed (for output and params) +- $tagstring: string input, a list of tags + +StartProfiletagGetUri: when generating the Uri for a people tag +- $profile_list: the people tag, a Profile_list object +- &$uri: the URI + +EndProfiletagGetUri: after generating the uri for a people tag +- $profile_list: the people tag, a Profile_list object +- &$uri: the URI + +StartUserPeopletagHomeUrl: when generating the homepage url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +EndUserPeopletagHomeUrl: after generating the homepage url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +StartProfiletagPermalink: when generating the permalink url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +EndProfiletagPermalink: after generating the permalink url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +StartTagProfile: when tagging a profile +- $tagger: profile tagging +- $tagged: profile being tagged +- $tag: the tag + +EndTagProfile: after tagging a profile +- $newtag: the newly created Profile_tag object + +StartUntagProfile: when deleting a people tag +- $ptag: the Profile_tag object being deleted + +EndUntagProfile: after deleting a people tag +- $orig: a copy of the deleted Profile_tag object + +StartSubscribePeopletag: when subscribing to a people tag +- $peopletag: Profile_list object being subscribed to +- $profile: subscriber's profile + +EndSubscribePeopletag: after subscribing to a people tag +- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to +- $profile: subscriber's profile + +StartUnsubscribePeopletag: when unsubscribing to a people tag +- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to +- $profile: subscriber's profile + +EndUnsubscribePeopletag: after unsubscribing to a people tag +- $peopletag: Profile_list object being subscribed to +- $profile: subscriber's profile + +StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag +- $profile_list: the people tag, a Profile_list object +- &$object: activity object + +EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag +- $profile_list: the people tag, a Profile_list object +- &$object: activity object + +StartPeopletagGroupNav: Showing the people tag nav menu +- $menu: the menu widget; use $menu->action for output + +EndPeopletagGroupNav: after showing the people tag nav menu +- $menu: the menu widget; use $menu->action for output + +StartShowPeopletagItem: when showing a people tag +- $widget: PeopletagListItem widget + +EndShowPeopletagItem: after showing a people tag +- $widget: PeopletagListItem widget + +StartSubscribePeopletagForm: when showing people tag subscription form +- $action: action being executed (for output and params) +- $peopletag: people tag being subscribed to + +EndSubscribePeopletagForm: after showing the people tag subscription form +- $action: action being executed (for output and params) +- $peopletag: people tag being subscribed to + +StartShowPeopletags: when showing a textual list of people tags +- $widget: PeopletagsWidget; use $widget->out for output +- $tagger: profile of the tagger +- $tagged: profile tagged + +EndShowPeopletags: after showing a textual list of people tags +- $widget: PeopletagsWidget; use $widget->out for output +- $tagger: profile of the tagger +- $tagged: profile tagged + +StartProfileListItemTags: when showing people tags in a profile list item widget +- $widget: ProfileListItem widget + +EndProfileListItemTags: after showing people tags in a profile list item widget +- $widget: ProfileListItem widget + StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so) - $obj: ActivityObject - $out: XMLOutputter to append custom output @@ -1139,3 +1256,210 @@ StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent. - $notice Notice - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc + +StartDefaultLocalNav: When showing the default local nav +- $menu: the menu +- $user: current user + +EndDefaultLocalNav: When showing the default local nav +- $menu: the menu +- $user: current user + +StartShowAccountProfileBlock: When showing the profile block for an account +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +EndShowAccountProfileBlock: After showing the profile block for an account +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +StartShowGroupProfileBlock: When showing the profile block for a group +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +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 +- &$children: list of children + +EndShowThreadedNoticeTail: when showing the replies etc. to a notice +- $nli: parent noticelistitem +- $notice: parent notice +- $children: list of children + +StartShowThreadedNoticeSub: when showing a reply to a notice +- $nli: parent noticelistitem +- $parent: parent notice +- $child: child notice + +EndShowThreadedNoticeSub: when showing a reply to a notice +- $nli: parent noticelistitem +- $parent: parent notice +- $child: child notice + +StartAddEmailAddress: when adding an email address through the Web UI +- $user: user getting the new address +- $email: email being added + +EndAddEmailAddress: done adding an email address through the Web UI +- $user: user getting the new address +- $email: email being added + +StartValidateEmailInvite: when validating an email address for invitations +- $user: user doing the invite +- $email: email address +- &$valid: flag for if it's valid; can be modified + +EndValidateEmailInvite: after validating an email address for invitations +- $user: user doing the invite +- $email: email address +- &$valid: flag for if it's valid; can be modified + +StartLocalURL: before resolving a local url for an action +- &$action: action to find a path for +- &$paramsi: parameters to pass to the action +- &$fragment: any url fragement +- &$addSession: whether to add session variable +- &$url: resulting URL to local resource + +EndLocalURL: before resolving a local url for an action +- &$action: action to find a path for +- &$paramsi: parameters to pass to the action +- &$fragment: any url fragement +- &$addSession: whether to add session variable +- &$url: resulting URL to local resource + +StartProfileGetAvatar: When getting an avatar for a profile +- $profile: profile +- $size: size of the avatar +- &$avatar: avatar + +EndProfileGetAvatar: After getting an avatar for a profile +- $profile: profile +- $size: size of the avatar +- &$avatar: avatar + +StartRegisterSuccess: Before showing the registration success message +- $action: the registration action + +StartRegisterSuccess: After showing the registration success message +- $action: the registration action + +StartDocFileForTitle: Before searching for a doc or mail template +- $title: Title we're looking for +- &$paths: Paths we're searching +- &$filename: Filename so far (set this if you want) + +EndDocFileForTitle: After searching for a doc or mail template +- $title: Title we looked for +- $paths: Paths we searched +- &$filename: Filename so far (set this if you want) + +StartReadWriteTables: when noting which tables must be read-write, even on read-only actions +- &$tables: list of table names +- &$rwdb: read-write database URI + +EndReadWriteTables: after noting which tables must be read-write, even on read-only actions +- $tables: list of table names +- $rwdb: read-write database URI + +StartShowInviteForm: Right before displaying the invitations form +- $action: invitation action + +EndShowInviteForm: After displaying the invitations form +- $action: invitation action + +StartSendInvitations: Right before sending invitations +- $action: invitation action + +EndSendInvitations: Right after sending invitations +- $action: invitation action + +StartShowInvitationSuccess: Right before showing invitations success msg +- $action: invitation action + +EndShowInvitationSuccess: After showing invitations success msg +- $action: invitation action + +StartUpgrade: when starting a site upgrade + +EndUpgrade: when ending a site upgrade; good place to do your own upgrades + +HaveIMPlugin: is there an IM plugin loaded? +- &$haveIMPlugin: set me to true if you're loaded! + +StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div +- $nli: NoticeListItem being shown + +EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div +- $nli: NoticeListItem being shown + +StartNoticeInScope: Before checking if a notice should be visible to a user +- $notice: The notice to check +- $profile: The profile to check for scope +- &$bResult: The boolean result; fill this in if you want to skip + +EndNoticeInScope: After checking if a notice should be visible to a user +- $notice: The notice to check +- $profile: The profile to check for scope +- &$bResult: The boolean result; overwrite this if you so desire + +StartNoticeListPrefill: Before pre-filling a list of notices with extra data +- &$notices: Notices to be pre-filled +- $avatarSize: The avatar size for the list + +EndNoticeListPrefill: After pre-filling a list of notices with extra data +- &$notices: Notices that were pre-filled +- &$profiles: Profiles that were pre-filled +- $avatarSize: The avatar size for the list + +OtherAccountProfiles: Hook to add account profiles to a user account profile block +- $profile: the Profile being shown +- &$others: Modifiable array of profile info arrays. Each one has the following fields: + 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=197b8afe6fa8a4f033fccb06369018507fabd318;hb=3a41dc4610b30f5043432c223e9c5bb29ae022b4;hp=1494a9c8904361852a16c28d816859710ca98213;hpb=36b331d469b6dcd1101783f21265f7be624bc58f;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 1494a9c890..197b8afe6f 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -20,16 +20,10 @@ StartShowStyles: Showing Style links; good place to add UA style resets EndShowStyles: End showing Style links; good place to add custom styles - $action: the current action -StartShowStatusNetStyles: Showing StatusNet Style links +StartShowStylesheets: Showing stylesheet links - $action: the current action -EndShowStatusNetStyles: End showing StatusNet Style links; good place to add handheld or JavaScript dependant styles -- $action: the current action - -StartShowLaconicaStyles: backwards compatibility; deprecated -- $action: the current action - -EndShowLaconicaStyles: backwards compatibility; deprecated +EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles - $action: the current action StartShowUAStyles: Showing custom User-Agent style links @@ -57,12 +51,6 @@ StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a EndShowStatusNetScripts: End showing StatusNet script links - $action: the current action -StartShowLaconicaScripts: backwards compatibility; deprecated -- $action: the current action - -EndShowLaconicaScripts: backwards compatibility; deprecated -- $action: the current action - StartShowSections: Start the list of sections in the sidebar - $action: the current action @@ -228,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 @@ -245,6 +235,10 @@ StartEndHTML: just before the tag EndEndHTML: just after the tag - $action: action object being shown +FinalAction: After prepare() (and possible handle) in Action class. +- $status: result of "prepare" call on action +- $action: Action that is currently running + StartShowDesign: just before showing a site, user, or group design - $action: action object being shown @@ -263,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 @@ -275,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 @@ -302,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 @@ -591,12 +597,6 @@ EndPublicXRDS: End XRDS output (right before the closing XRDS tag) - $action: the current action - &$xrdsoutputter - XRDSOutputter object to write to -StartHostMetaLinks: Start /.well-known/host-meta links -- &links: array containing the links elements to be written - -EndHostMetaLinks: End /.well-known/host-meta links -- &links: array containing the links elements to be written - StartCheckPassword: Check a username/password - $nickname: The nickname to check - $password: The password to check @@ -615,6 +615,11 @@ StartChangePassword: Before changing a password EndChangePassword: After changing a password - $user: user +StartHashPassword: Generate a hashed version of the password (like a salted crypt) +- &$hashed: Hashed version of the password, later put in the database +- $password: The password that should be hashed +- $profile: Profile that this password and hash belongs to. Can be null. + StartSetUser: Before setting the currently logged in user - $user: user @@ -725,20 +730,20 @@ EndUnblockProfile: when an unblock has succeeded - $profile: the person unblocked, can be remote StartSubscribe: when a subscription is starting -- $user: the person subscribing -- $other: the person being subscribed to +- $profile: Profile that is subscribing +- $other: Profile that is being subscribed to EndSubscribe: when a subscription is finished -- $user: the person subscribing -- $other: the person being subscribed to +- $profile: Profile that is subscribing +- $other: Profile that is being subscribed to StartUnsubscribe: when an unsubscribe is starting -- $user: the person unsubscribing -- $other: the person being unsubscribed from +- $profile: Profile that is unsubscribing +- $other: Profile that is being unsubscribed from EndUnsubscribe: when an unsubscribe is done -- $user: the person unsubscribing -- $other: the person being unsubscribed to +- $profile: Profile that is unsubscribing +- $other: Profile that is being unsubscribed from StartJoinGroup: when a user is joining a group - $group: the group being joined @@ -781,12 +786,10 @@ SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM sc - $user: user requesting the confirmation StartUserRegister: When a new user is being registered -- &$profile: new profile data (no ID) -- &$user: new user account (no ID or URI) +- $profile: Profile object with new profile data (no ID yet) EndUserRegister: When a new user has been registered -- &$profile: new profile data -- &$user: new user account +- $profile: Profile object with new profile data StartRobotsTxt: Before outputting the robots.txt page - &$action: RobotstxtAction being shown @@ -802,39 +805,13 @@ EndGetProfileUri: After determining the canonical URI for a given profile - $profile: the current profile - &$uri: the 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. +StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException) +- $profile: Profile of user we want to get acct: URI for +- &$acct: string with the resulting acct: uri -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 +EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException) +- $profile: Profile of user we want to get acct: URI for +- &$acct: string with the resulting acct: uri StartFindMentions: start finding mentions in a block of text - $sender: sender profile @@ -927,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 @@ -969,6 +949,9 @@ StartShowNoticeForm: before showing the notice form (before <form>) EndShowNoticeForm: after showing the notice form (after <form>) - $action: action being executed +StartShowEntryForms: microapp entry form tab data +- &$tabs: tab assoc array with 'tag' => (title, href to create new entry) + StartGrantRole: when a role is being assigned - $profile: profile that will have the role - $role: string name of the role @@ -987,30 +970,14 @@ 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 -StartXrdActionAliases: About to set aliases for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -EndXrdActionAliases: Done with aliases for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -StartXrdActionLinks: About to set links for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - -EndXrdActionLinks: Done with links for the XRD object for a user -- &$xrd: XRD object being shown -- $user: User being shown - AdminPanelCheck: When checking whether the current user can access a given admin panel - $name: Name of the admin panel - &$isOK: Boolean whether the user is allowed to use the panel @@ -1089,13 +1056,13 @@ EndGroupSave: After saving a group, aliases, and first member - $group: group that was saved StartInterpretCommand: Before running a command -- $cmd: First word in the string, 'foo' in 'foo argument' +- $cmd: First word in the string, 'foo' in 'foo argument' - $arg: Argument, if any, like 'argument' in 'foo argument' - $user: User who issued the command - &$result: Resulting command; you can set this! EndInterpretCommand: Before running a command -- $cmd: First word in the string, 'foo' in 'foo argument' +- $cmd: First word in the string, 'foo' in 'foo argument' - $arg: Argument, if any, like 'argument' in 'foo argument' - $user: User who issued the command - $result: Resulting command @@ -1111,11 +1078,161 @@ EndGroupActionsList: End the list of actions on a group profile page (before </u StartGroupProfileElements: Start showing stuff about the group on its profile page - $action: action being executed (for output and params) - $group: group for the page - + EndGroupProfileElements: Start showing stuff about the group on its profile page - $action: action being executed (for output and params) - $group: group for the page +StartShowProfileTagContent: When showing a people tag page +- $action: action being executed (for output and params) + +EndShowProfileTagContent: After showing the contents of a people tag page +- $action: action being executed (for output and params) + +StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles +- $action: action being executed (for output and params) + +EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles +- $action: action being executed (for output and params) + +StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers +- $action: action being executed (for output and params) + +EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers +- $action: action being executed (for output and params) + +StartTagProfileAction: When starting to show profile tagging page +- $action: action being executed (for output and params) +- $profile: profile being tagged + +EndTagProfileAction: After showing profile tagging page +- $action: action being executed (for output and params) +- $profile: profile being tagged + +StartProfileCompletionSearch: When starting a profile search for autocompletion +- $action: action being executed (for output and params) +- &$profile: result Profile objects +- $search_engine: the search engine + +EndProfileCompletionSearch: After search results for profile autocompletion have been found +- $action: profilec completion action +- &$profile: current result Profile objects +- $search_engine: The search engine object + +StartShowTagProfileForm: When showing people tagging form +- $action: action being executed (for output and params) +- $profile: profile being tagged + +EndShowTagProfileForm: After showing people tagging form +- $action: action being executed (for output and params) +- $profile: profile being tagged + +StartSavePeopletags: When starting to save people tags +- $action: action being executed (for output and params) +- $tagstring: string input, a list of tags + +EndSavePeopletags: After saving people tags +- $action: action being executed (for output and params) +- $tagstring: string input, a list of tags + +StartProfiletagGetUri: when generating the Uri for a people tag +- $profile_list: the people tag, a Profile_list object +- &$uri: the URI + +EndProfiletagGetUri: after generating the uri for a people tag +- $profile_list: the people tag, a Profile_list object +- &$uri: the URI + +StartUserPeopletagHomeUrl: when generating the homepage url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +EndUserPeopletagHomeUrl: after generating the homepage url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +StartProfiletagPermalink: when generating the permalink url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +EndProfiletagPermalink: after generating the permalink url for a people tag +- $profile_list: the people tag, a Profile_list object +- &$url: the URL + +StartTagProfile: when tagging a profile +- $tagger: profile tagging +- $tagged: profile being tagged +- $tag: the tag + +EndTagProfile: after tagging a profile +- $newtag: the newly created Profile_tag object + +StartUntagProfile: when deleting a people tag +- $ptag: the Profile_tag object being deleted + +EndUntagProfile: after deleting a people tag +- $orig: a copy of the deleted Profile_tag object + +StartSubscribePeopletag: when subscribing to a people tag +- $peopletag: Profile_list object being subscribed to +- $profile: subscriber's profile + +EndSubscribePeopletag: after subscribing to a people tag +- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to +- $profile: subscriber's profile + +StartUnsubscribePeopletag: when unsubscribing to a people tag +- $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to +- $profile: subscriber's profile + +EndUnsubscribePeopletag: after unsubscribing to a people tag +- $peopletag: Profile_list object being subscribed to +- $profile: subscriber's profile + +StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag +- $profile_list: the people tag, a Profile_list object +- &$object: activity object + +EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag +- $profile_list: the people tag, a Profile_list object +- &$object: activity object + +StartPeopletagGroupNav: Showing the people tag nav menu +- $menu: the menu widget; use $menu->action for output + +EndPeopletagGroupNav: after showing the people tag nav menu +- $menu: the menu widget; use $menu->action for output + +StartShowPeopletagItem: when showing a people tag +- $widget: PeopletagListItem widget + +EndShowPeopletagItem: after showing a people tag +- $widget: PeopletagListItem widget + +StartSubscribePeopletagForm: when showing people tag subscription form +- $action: action being executed (for output and params) +- $peopletag: people tag being subscribed to + +EndSubscribePeopletagForm: after showing the people tag subscription form +- $action: action being executed (for output and params) +- $peopletag: people tag being subscribed to + +StartShowPeopletags: when showing a textual list of people tags +- $widget: PeopletagsWidget; use $widget->out for output +- $tagger: profile of the tagger +- $tagged: profile tagged + +EndShowPeopletags: after showing a textual list of people tags +- $widget: PeopletagsWidget; use $widget->out for output +- $tagger: profile of the tagger +- $tagged: profile tagged + +StartProfileListItemTags: when showing people tags in a profile list item widget +- $widget: ProfileListItem widget + +EndProfileListItemTags: after showing people tags in a profile list item widget +- $widget: ProfileListItem widget + StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so) - $obj: ActivityObject - $out: XMLOutputter to append custom output @@ -1139,3 +1256,210 @@ StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent. - $notice Notice - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc + +StartDefaultLocalNav: When showing the default local nav +- $menu: the menu +- $user: current user + +EndDefaultLocalNav: When showing the default local nav +- $menu: the menu +- $user: current user + +StartShowAccountProfileBlock: When showing the profile block for an account +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +EndShowAccountProfileBlock: After showing the profile block for an account +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +StartShowGroupProfileBlock: When showing the profile block for a group +- $out: XMLOutputter to append custom output +- $profile: the profile being shown + +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 +- &$children: list of children + +EndShowThreadedNoticeTail: when showing the replies etc. to a notice +- $nli: parent noticelistitem +- $notice: parent notice +- $children: list of children + +StartShowThreadedNoticeSub: when showing a reply to a notice +- $nli: parent noticelistitem +- $parent: parent notice +- $child: child notice + +EndShowThreadedNoticeSub: when showing a reply to a notice +- $nli: parent noticelistitem +- $parent: parent notice +- $child: child notice + +StartAddEmailAddress: when adding an email address through the Web UI +- $user: user getting the new address +- $email: email being added + +EndAddEmailAddress: done adding an email address through the Web UI +- $user: user getting the new address +- $email: email being added + +StartValidateEmailInvite: when validating an email address for invitations +- $user: user doing the invite +- $email: email address +- &$valid: flag for if it's valid; can be modified + +EndValidateEmailInvite: after validating an email address for invitations +- $user: user doing the invite +- $email: email address +- &$valid: flag for if it's valid; can be modified + +StartLocalURL: before resolving a local url for an action +- &$action: action to find a path for +- &$paramsi: parameters to pass to the action +- &$fragment: any url fragement +- &$addSession: whether to add session variable +- &$url: resulting URL to local resource + +EndLocalURL: before resolving a local url for an action +- &$action: action to find a path for +- &$paramsi: parameters to pass to the action +- &$fragment: any url fragement +- &$addSession: whether to add session variable +- &$url: resulting URL to local resource + +StartProfileGetAvatar: When getting an avatar for a profile +- $profile: profile +- $size: size of the avatar +- &$avatar: avatar + +EndProfileGetAvatar: After getting an avatar for a profile +- $profile: profile +- $size: size of the avatar +- &$avatar: avatar + +StartRegisterSuccess: Before showing the registration success message +- $action: the registration action + +StartRegisterSuccess: After showing the registration success message +- $action: the registration action + +StartDocFileForTitle: Before searching for a doc or mail template +- $title: Title we're looking for +- &$paths: Paths we're searching +- &$filename: Filename so far (set this if you want) + +EndDocFileForTitle: After searching for a doc or mail template +- $title: Title we looked for +- $paths: Paths we searched +- &$filename: Filename so far (set this if you want) + +StartReadWriteTables: when noting which tables must be read-write, even on read-only actions +- &$tables: list of table names +- &$rwdb: read-write database URI + +EndReadWriteTables: after noting which tables must be read-write, even on read-only actions +- $tables: list of table names +- $rwdb: read-write database URI + +StartShowInviteForm: Right before displaying the invitations form +- $action: invitation action + +EndShowInviteForm: After displaying the invitations form +- $action: invitation action + +StartSendInvitations: Right before sending invitations +- $action: invitation action + +EndSendInvitations: Right after sending invitations +- $action: invitation action + +StartShowInvitationSuccess: Right before showing invitations success msg +- $action: invitation action + +EndShowInvitationSuccess: After showing invitations success msg +- $action: invitation action + +StartUpgrade: when starting a site upgrade + +EndUpgrade: when ending a site upgrade; good place to do your own upgrades + +HaveIMPlugin: is there an IM plugin loaded? +- &$haveIMPlugin: set me to true if you're loaded! + +StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div +- $nli: NoticeListItem being shown + +EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div +- $nli: NoticeListItem being shown + +StartNoticeInScope: Before checking if a notice should be visible to a user +- $notice: The notice to check +- $profile: The profile to check for scope +- &$bResult: The boolean result; fill this in if you want to skip + +EndNoticeInScope: After checking if a notice should be visible to a user +- $notice: The notice to check +- $profile: The profile to check for scope +- &$bResult: The boolean result; overwrite this if you so desire + +StartNoticeListPrefill: Before pre-filling a list of notices with extra data +- &$notices: Notices to be pre-filled +- $avatarSize: The avatar size for the list + +EndNoticeListPrefill: After pre-filling a list of notices with extra data +- &$notices: Notices that were pre-filled +- &$profiles: Profiles that were pre-filled +- $avatarSize: The avatar size for the list + +OtherAccountProfiles: Hook to add account profiles to a user account profile block +- $profile: the Profile being shown +- &$others: Modifiable array of profile info arrays. Each one has the following fields: + 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.