X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=EVENTS.txt;h=a113bb56a1040b046b075e4a620cf12a364274a3;hb=cd6fa512ac0d382871384a9c7604abd8a7ed0566;hp=08a4273ec907537471284d66f2080d3c09860220;hpb=3022d711e391a5601e1933f581b27355b7abe77c;p=quix0rs-gnu-social.git diff --git a/EVENTS.txt b/EVENTS.txt index 08a4273ec9..a113bb56a1 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 @@ -591,12 +585,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 @@ -725,20 +713,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 +769,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 @@ -995,22 +981,6 @@ EndAtomPubNewActivity: When a new activity comes in through Atom Pub API - $user: 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 +1059,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 +1081,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 @@ -1160,6 +1280,149 @@ StartShowGroupProfileBlock: When showing the profile block for a group - $out: XMLOutputter to append custom output - $profile: the profile being shown -EndShowGroupProfileBlock: After showing showing the profile block for a group +EndShowGroupProfileBlock: After showing the profile block for a group - $out: XMLOutputter to append custom output -- $group: the group being shown \ No newline at end of file +- $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