X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=49940e467fbc88d1b5309200c5a5f6a261840494;hb=2ad5aece55fed8fb4242961bcb301ad33ae7ca38;hp=54d06655eecdcbb592ac307579bcd25e547e6e34;hpb=325cb4833db7e3fd396720f12a27b880b63f4173;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 54d06655ee..49940e467f 100644 --- a/EVENTS.txt +++ b/EVENTS.txt @@ -742,19 +742,19 @@ EndUnsubscribe: when an unsubscribe is done StartJoinGroup: when a user is joining a group - $group: the group being joined -- $user: the user joining +- $profile: the local or remote user joining EndJoinGroup: when a user finishes joining a group - $group: the group being joined -- $user: the user joining +- $profile: the local or remote user joining StartLeaveGroup: when a user is leaving a group - $group: the group being left -- $user: the user leaving +- $profile: the local or remote user leaving EndLeaveGroup: when a user has left a group - $group: the group being left -- $user: the user leaving +- $profile: the local or remote user leaving StartShowContentLicense: Showing the default license for content - $action: the current action @@ -1089,13 +1089,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 +1111,161 @@ EndGroupActionsList: End the list of actions on a group profile page (before 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 . 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 +1289,170 @@ 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 + +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