EVENTS.txt 35.9 KB
Newer Older
1
InitializePlugin: a chance to initialize a plugin in a complete environment
2 3 4

CleanupPlugin: a chance to cleanup a plugin at the end of a program

5 6 7 8 9 10 11 12 13 14 15
StartPrimaryNav: Showing the primary nav menu
- $action: the current action

EndPrimaryNav: At the end of the primary nav menu
- $action: the current action

StartSecondaryNav: Showing the secondary nav menu
- $action: the current action

EndSecondaryNav: At the end of the secondary nav menu
- $action: the current action
16

17 18 19 20 21 22
StartShowStyles: Showing Style links; good place to add UA style resets
- $action: the current action

EndShowStyles: End showing Style links; good place to add custom styles
- $action: the current action

23
StartShowStatusNetStyles: Showing StatusNet Style links
24 25
- $action: the current action

26
EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
27 28
- $action: the current action

29 30 31 32
StartShowLaconicaStyles: backwards compatibility; deprecated
- $action: the current action

EndShowLaconicaStyles: backwards compatibility; deprecated
33 34
- $action: the current action

35
StartShowUAStyles: Showing custom User-Agent style links
36 37
- $action: the current action

38
EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
39 40
- $action: the current action

41 42 43 44 45 46 47 48 49 50 51 52 53
StartShowScripts: Showing JavaScript links
- $action: the current action

EndShowScripts: End showing JavaScript links; good place to add custom
		links like Google Analytics
- $action: the current action

StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
- $action: the current action

EndShowJQueryScripts: End showing JQuery script links
- $action: the current action

54
StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
55 56
- $action: the current action

57
EndShowStatusNetScripts: End showing StatusNet script links
58 59
- $action: the current action

60
StartShowLaconicaScripts: backwards compatibility; deprecated
61 62
- $action: the current action

63
EndShowLaconicaScripts: backwards compatibility; deprecated
64 65
- $action: the current action

66 67 68 69 70
StartShowSections: Start the list of sections in the sidebar
- $action: the current action

EndShowSections: End the list of sections in the sidebar
- $action: the current action
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

StartShowHeader: Showing before the header container
- $action: the current action

EndShowHeader: Showing after the header container
- $action: the current action

StartShowFooter: Showing before the footer container
- $action: the current action

EndShowFooter: Showing after the footer container
- $action: the current action

StartShowContentBlock: Showing before the content container
- $action: the current action

EndShowContentBlock: Showing after the content container
- $action: the current action

90 91 92 93 94 95
StartShowAside: Showing before the Aside container
- $action: the current action

EndShowAside: Showing after the Aside container
- $action: the current action

96 97 98 99 100 101
StartShowNoticeFormData: Showing before the notice form data
- $action: the current action

EndShowNoticeFormData: Showing after the notice form data
- $action: the current action

102 103 104 105 106 107
StartNoticeSave: before inserting a notice (good place for content filters)
- $notice: notice being saved (no ID or URI)

EndNoticeSave: after inserting a notice and related code
- $notice: notice that was saved (with ID and URI)

108 109 110 111 112 113
StartShowLocalNavBlock: Showing the local nav menu
- $action: the current action

EndShowLocalNavBlock: At the end of the local nav menu
- $action: the current action

114
StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
115 116 117 118 119
- $action: the current action

EndShowHTML: Showing after the html element
- $action: the current action

120
StartPublicGroupNav: Showing the public group nav menu
121
- $menu: the menu widget; use $menu->action for output
122 123

EndPublicGroupNav: At the end of the public group nav menu
124
- $menu: the menu widget; use $menu->action for output
125

126
StartSubGroupNav: Showing the subscriptions group nav menu
127
- $menu: the menu widget; use $menu->action for output
128 129

EndSubGroupNav: At the end of the subscriptions group nav menu
130
- $menu: the menu widget; use $menu->action for output
131

132 133 134
StartInitializeRouter: Before the router instance has been initialized; good place to add routes
- $m: the Net_URL_Mapper that has just been set up

135 136 137
RouterInitialized: After the router instance has been initialized
- $m: the Net_URL_Mapper that has just been set up

138 139 140 141 142 143
StartLogout: Before logging out
- $action: the logout action

EndLogout: After logging out
- $action: the logout action

144
ArgsInitialize: After the argument array has been initialized
145
- $args: associative array of arguments, can be modified
146 147 148 149 150 151

StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
- $action: the current action

EndAddressData: At the end of <address>
- $action: the current action
152

153 154 155 156 157 158
StartShowSiteNotice: Before showing site notice
- $action: the current action

EndShowSiteNotice: After showing site notice
- $action: the current action

159 160 161 162 163
StartLoginGroupNav: Before showing the login and register navigation menu
- $action: the current action

EndLoginGroupNav: After showing the login and register navigation menu
- $action: the current action
164 165 166 167 168 169

StartAccountSettingsNav: Before showing the account settings menu
- $action: the current action

EndAccountSettingsNav: After showing the account settings menu
- $action: the current action
170

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsProfileMenuItem: After showing the Profile menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsPasswordMenuItem: After showing the Password menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsEmailMenuItem: Before showing the Email menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsEmailMenuItem: After showing the Email menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsDesignMenuItem: Before showing the Design menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsDesignMenuItem: After showing the Design menu item
- $widget: AccountSettingsNav instance being shown

StartAccountSettingsOtherMenuItem: Before showing the Other menu item
- $widget: AccountSettingsNav instance being shown

EndAccountSettingsOtherMenuItem: After showing the Other menu item
- $widget: AccountSettingsNav instance being shown

207 208
Autoload: When trying to autoload a class
- $cls: the class being sought. A plugin might require_once the file for the class.
209 210 211 212 213

SensitiveAction: determines if an action is 'sensitive' and should use SSL
- $action: name of the action, like 'login'
- $sensitive: flag for whether this is a sensitive action

214 215 216
LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
- $action: name of the action, like 'register'
- $login: flag for whether this is a login action
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235

StartShowHead: called before showing the <head> element and children
- $action: action object being show

EndShowHead: called after showing the <head> element (and </head>)
- $action: action object being shown

StartShowBody: called before showing the <body> element and children
- $action: action object being shown

EndShowBody: called after showing the <body> element (and </body>)
- $action: action object being shown

StartPersonalGroupNav: beginning of personal group nav menu
- $action: action object being shown

EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
- $action: action object being shown

236 237 238 239 240 241
StartGroupGroupNav: Showing the group nav menu
- $action: the current action

EndGroupGroupNav: At the end of the group nav menu
- $action: the current action

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
StartEndHTML: just before the </html> tag
- $action: action object being shown

EndEndHTML: just after the </html> tag
- $action: action object being shown

StartShowDesign: just before showing a site, user, or group design
- $action: action object being shown

EndShowDesign: just after showing a site, user, or group design
- $action: action object being shown

StartShowExportData: just before showing the <div> with export data (feeds)
- $action: action object being shown

EndShowExportData: just after showing the <div> with export data (feeds)
- $action: action object being shown

260
StartShowNoticeItem: just before showing the notice item
261
- $item: The NoticeListItem object being shown
262 263

EndShowNoticeItem: just after showing the notice item
264
- $item: the NoticeListItem object being shown
265 266 267 268 269 270

StartShowNoticeInfo: just before showing notice info
- $item: The NoticeListItem object being shown

EndShowNoticeInfo: just after showing notice info
- $item: The NoticeListItem object being shown
271 272 273 274 275 276 277 278 279 280 281 282

StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
- $item: the NoticeListItem object being shown

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
283

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
StartShowPageNotice: just before showing the page notice (instructions or error)
- $action: action object being shown

EndShowPageNotice: just after showing the page notice (instructions or error)
- $action: action object being shown

StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
- $action: action object being shown

StartProfileFormData: just before showing text entry fields on profile settings page
- $action: action object being shown

EndProfileFormData: just after showing text entry fields on profile settings page
- $action: action object being shown

StartProfileSaveForm: before starting to save a profile settings form
- $action: action object being shown

EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
- $action: action object being shown

305 306 307 308 309 310 311 312 313 314 315 316 317 318
StartEmailFormData: just before showing text entry fields on email settings page
- $action: action object being shown

EndEmailFormData: just after showing text entry fields on email settings page
- $action: action object being shown

StartEmailSaveForm: before starting to save a email settings form
- $action: action object being shown
- &$user: user being saved

EndEmailSaveForm: after saving a email settings form (after commit)
- $action: action object being shown
- &$user: user being saved

319 320 321 322 323 324 325 326 327 328 329 330
StartRegistrationFormData: just before showing text entry fields on registration page
- $action: action object being shown

EndRegistrationFormData: just after showing text entry fields on registration page
- $action: action object being shown

StartRegistrationTry: before validating and saving a new user
- $action: action object being shown

EndRegistrationTry: after saving a new user (note: no profile or user object!)
- $action: action object being shown

331 332 333 334 335 336 337 338 339 340 341 342
StartAvatarFormData: before displaying avatar form
- $action: action object being shown

EndAvatarFormData: after displaying avatar form
- $action: action object being shown

StartAvatarSaveForm: before saving the avatar
- $action: action object being shown

EndAvatarSaveForm: after saving the avatar
- $action: action object being shown

343 344
StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
- $qm: empty queue manager to set
345 346 347 348

RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
- $action: action object being shown
- $user: current user
349 350 351 352 353 354 355 356

StartLoadDoc: before loading a help doc (hook this to show your own documentation)
- $title: title of the document
- $output: HTML output to show

EndLoadDoc: after loading a help doc (hook this to modify other documentation)
- $title: title of the document
- $output: HTML output to show
357 358 359 360 361 362 363

StartApiRss: after the rss <channel> element is started
- $action: action object being shown

StartApiAtom: after the <feed> element is started
- $action: action object being shown

364 365 366 367 368 369 370
StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
- $notice: the notice being added
- &$transports: modifiable list of transports (as strings) to queue for

EndEnqueueNotice: after adding a notice to the queues
- $notice: the notice being added
- $transports: modifiable list of transports to use
371 372 373

UnqueueHandleNotice: Handle a notice when no queue manager is available
- $notice: the notice to handle
374 375 376 377
- $queue: the "queue" that is being executed

GetValidDaemons: Just before determining which daemons to run
- &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
378 379 380

HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
- &$notice: notice to handle
381

382 383 384 385 386 387 388 389
StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
- $action: the current action
- &$attrs: attributes for the HTML element

EndHtmlElement: Right after outputting the HTML element
- $action: the current action
- &$attrs: attributes for the HTML element

390 391 392 393 394
StartShowHeadElements: Right after the <head> tag
- $action: the current action

EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
- $action: the current action
Evan Prodromou's avatar
Evan Prodromou committed
395 396

CheckSchema: chance to check the schema
397

398 399 400 401 402 403 404 405
StartProfileRemoteSubscribe: Before showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown

EndProfileRemoteSubscribe: After showing the link to remote subscription
- $userprofile: UserProfile widget
- &$profile: the profile being shown

406 407 408 409 410 411 412 413
StartGroupSubscribe: Before showing the link to remote subscription
- $action: the current action
- $group: the group being shown

EndGroupSubscribe: After showing the link to remote subscription
- $action: the current action
- $group: the group being shown

414
StartProfilePageProfileSection: Starting to show the section of the
415 416
                              profile page with the actual profile data;
                              hook to prevent showing the profile (e.g.)
417
- $userprofile: UserProfile widget
418 419
- &$profile: the profile being shown

420
StartProfilePageProfileElements: inside the section, before the first
421
                               element; prepend elements here
422
- $userprofile: UserProfile widget
423 424
- &$profile: the profile being shown

425
EndProfilePageProfileElements: inside the section, after the last element;
426
                             append elements here
427
- $userprofile: UserProfile widget
428 429
- &$profile: the profile being shown

430
EndProfilePageProfileSection: After showing the section of the profile
431
                            page with the profile elements
432
- $userprofile: UserProfile widget
433 434
- &$profile: the profile being shown

435
StartProfilePageActionsSection: Starting to show the section of the
436 437
                                    profile page with action links; hook
                                    to hide them (for example)
438
- $userprofile: UserProfile widget
439 440
- &$profile: the profile being shown

441
StartProfilePageActionsElements: inside the list, before the first
442
                                     element; prepend elements here
443
- $userprofile: UserProfile widget
444 445
- &$profile: the profile being shown

446
EndProfilePageActionsElements: inside the list, after the last element;
447
                                   append elements here
448
- $userprofile: UserProfile widget
449 450
- &$profile: the profile being shown

451
EndProfilePageActionsSection: After showing the section of the profile
452
                                  page with the entity actions
453
- $userprofile: UserProfile widget
454
- &$profile: the profile being shown
455 456

StartProfilePageAvatar: before showing the avatar on the profile page
457
- $userprofile: UserProfile widget
458 459 460
- &$profile: the profile being shown

EndProfilePageAvatar: after showing the avatar on the profile page
461
- $userprofile: UserProfile widget
462 463 464
- &$profile: the profile being shown

StartProfilePageNickname: before showing the nickname on the profile page
465
- $userprofile: UserProfile widget
466 467 468
- &$profile: the profile being shown

EndProfilePageNickname: after showing the nickname on the profile page
469
- $userprofile: UserProfile widget
470 471 472
- &$profile: the profile being shown

StartProfilePageFullName: before showing the fullname on the profile page
473
- $userprofile: UserProfile widget
474 475 476
- &$profile: the profile being shown

EndProfilePageFullName: after showing the fullname on the profile page
477
- $userprofile: UserProfile widget
478 479 480
- &$profile: the profile being shown

StartProfilePageLocation: before showing the location on the profile page
481
- $userprofile: UserProfile widget
482 483 484
- &$profile: the profile being shown

EndProfilePageLocation: after showing the location on the profile page
485
- $userprofile: UserProfile widget
486 487 488
- &$profile: the profile being shown

StartProfilePageHomepage: before showing the homepage link on the profile page
489
- $userprofile: UserProfile widget
490 491 492
- &$profile: the profile being shown

EndProfilePageHomepage: after showing the homepage on the profile page
493
- $userprofile: UserProfile widget
494 495 496
- &$profile: the profile being shown

StartProfilePageBio: before showing the bio on the profile page
497
- $userprofile: UserProfile widget
498 499 500
- &$profile: the profile being shown

EndProfilePageBio: after showing the bio on the profile page
501
- $userprofile: UserProfile widget
502 503 504
- &$profile: the profile being shown

StartProfilePageProfileTags: before showing the tags on the profile page
505
- $userprofile: UserProfile widget
506 507 508
- &$profile: the profile being shown

EndProfilePageProfileTags: after showing the tags on the profile page
509
- $userprofile: UserProfile widget
510 511
- &$profile: the profile being shown

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
StartProfileList: when starting a list of profiles (before <ul>)
- $profilelist: ProfileList widget, with $profile, $action, and $out

EndProfileList: when ending a list of profiles (after </ul>)
- $profilelist: ProfileList widget

StartProfileListItem: when starting to show a profile list item
- $item: ProfileListItem widget

EndProfileListItem: after showing a profile list item
- $item: ProfileListItem widget

StartProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

EndProfileListItemProfile: the profile data part of the item
- $item: ProfileListItem widget

StartProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

EndProfileListItemActions: the actions (buttons) for an item
- $item: ProfileListItem widget

StartProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

EndProfileListItemProfileElements: inside the <div>
- $item: ProfileListItem widget

StartProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

EndProfileListItemAvatar: Showing a profile list avatar
- $item: ProfileListItem widget

StartProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

EndProfileListItemFullName: Showing the profile list full name
- $item: ProfileListItem widget

StartProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

EndProfileListItemLocation: Showing the profile list location
- $item: ProfileListItem widget

StartProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

EndProfileListItemHomepage: Showing the profile list homepage
- $item: ProfileListItem widget

StartProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

EndProfileListItemBio: Showing the profile list bio
- $item: ProfileListItem widget

StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
- $item: ProfileListItem widget

EndProfileListItemActionElements: Showing profile list actions (append a button here)
- $item: ProfileListItem widget
577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592

StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndUserXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to

EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
- $action: the current action
- &$xrdsoutputter - XRDSOutputter object to write to
593

594 595 596 597 598 599
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

600
StartCheckPassword: Check a username/password
601 602
- $nickname: The nickname to check
- $password: The password to check
603
- &$authenticatedUser: set to User object if credentials match a user.
604

605 606 607 608
EndCheckPassword: After checking a username/password pair
- $nickname: The nickname that was checked
- $password: The password that was checked
- $authenticatedUser: User object if credentials match a user, else null.
609

610
StartChangePassword: Before changing a password
611
- $user: user
Craig Andrews's avatar
Craig Andrews committed
612 613
- $oldpassword: the user's old password
- $newpassword: the desired new password
614 615

EndChangePassword: After changing a password
616
- $user: user
Craig Andrews's avatar
Craig Andrews committed
617

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
StartSetUser: Before setting the currently logged in user
- $user: user

EndSetUser: After setting the currently logged in user
- $user: user

StartSetApiUser: Before setting the current API user
- $user: user

EndSetApiUser: After setting the current API user
- $user: user

StartHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- &$has_role: does this profile have the named role?

EndHasRole: Before determing if the a profile has a given role
- $profile: profile in question
- $name: name of the role in question
- $has_role: does this profile have the named role?

640 641 642
UserDeleteRelated: Specify additional tables to delete entries from when deleting users
- $user: User object
- &$related: array of DB_DataObject class names to delete entries on matching user_id.
643 644 645 646 647 648 649 650 651 652 653 654 655 656

GetUrlShorteners: Specify URL shorteners that are available for use
- &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)

StartShortenUrl: About to shorten a URL
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- &$shortenedUrl: short version of the url

EndShortenUrl: After a URL has been shortened
- $url: url to be shortened
- $shortenerName: name of the requested shortener
- $shortenedUrl: short version of the url

657 658 659 660 661 662 663 664 665 666 667 668
StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
- $action
- &$src
- &$theme
- &$media

EndCssLinkElement: After a <link rel="stylesheet"..> element is written
- $action
- $src
- $theme
- $media

669 670 671 672 673 674 675 676 677 678 679 680
StartStyleElement: Before a <style...> element is written
- $action
- &$code
- &$type
- &$media

EndStyleElement: After a <style...> element is written
- $action
- $code
- $type
- $media

681 682 683 684 685 686 687 688 689
StartScriptElement: Before a <script...> element is written
- $action
- &$src
- &$type

EndScriptElement: After a <script...> element is written
- $action
- $src
- $type
690 691 692 693 694 695 696 697 698 699

StartInlineScriptElement: Before a <script...> element is written
- $action
- &$code
- &$type

EndInlineScriptElement: After a <script...> element is written
- $action
- $code
- $type
700 701 702 703 704 705 706 707 708 709 710

StartLog: Before writing to the logs
- &$priority
- &$msg
- &$filename

EndLog: After writing to the logs
- $priority
- $msg
- $filename

711 712 713 714 715 716 717
StartBlockProfile: when we're about to block
- $user: the person doing the block
- $profile: the person getting blocked, can be remote

EndBlockProfile: when a block has succeeded
- $user: the person doing the block
- $profile: the person blocked, can be remote
718 719 720 721 722 723 724 725

StartUnblockProfile: when we're about to unblock
- $user: the person doing the unblock
- $profile: the person getting unblocked, can be remote

EndUnblockProfile: when an unblock has succeeded
- $user: the person doing the unblock
- $profile: the person unblocked, can be remote
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757

StartSubscribe: when a subscription is starting
- $user: the person subscribing
- $other: the person being subscribed to

EndSubscribe: when a subscription is finished
- $user: the person subscribing
- $other: the person being subscribed to

StartUnsubscribe: when an unsubscribe is starting
- $user: the person unsubscribing
- $other: the person being unsubscribed from

EndUnsubscribe: when an unsubscribe is done
- $user: the person unsubscribing
- $other: the person being unsubscribed to

StartJoinGroup: when a user is joining a group
- $group: the group being joined
- $user: the user joining

EndJoinGroup: when a user finishes joining a group
- $group: the group being joined
- $user: the user joining

StartLeaveGroup: when a user is leaving a group
- $group: the group being left
- $user: the user leaving

EndLeaveGroup: when a user has left a group
- $group: the group being left
- $user: the user leaving
758 759 760 761 762 763

StartShowContentLicense: Showing the default license for content
- $action: the current action

EndShowContentLicense: Showing the default license for content
- $action: the current action
764 765 766 767 768 769 770 771 772

StartUserRegister: When a new user is being registered
- &$profile: new profile data (no ID)
- &$user: new user account (no ID or URI)

EndUserRegister: When a new user has been registered
- &$profile: new profile data
- &$user: new user account

773 774 775 776 777 778
StartRobotsTxt: Before outputting the robots.txt page
- &$action: RobotstxtAction being shown

EndRobotsTxt: After the default robots.txt page (good place for customization)
- &$action: RobotstxtAction being shown

779 780 781
StartGetProfileUri: When determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
782

783 784 785
EndGetProfileUri: After determining the canonical URI for a given profile
- $profile: the current profile
- &$uri: the URI
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804

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

805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
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

821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
StartFindMentions: start finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
  has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  'title' (title of the link), 'position' (position of the text to
  replace), 'text' (text to replace)

EndFindMentions: end finding mentions in a block of text
- $sender: sender profile
- $text: plain text version of the notice
- &$mentions: mentions found so far. Array of arrays; each array
  has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  'title' (title of the link), 'position' (position of the text to
  replace), 'text' (text to replace)
836 837 838 839 840 841

StartShowSubscriptionsContent: before showing the subscriptions content
- $action: the current action

EndShowSubscriptionsContent: after showing the subscriptions content
- $action: the current action
842

843 844 845 846 847 848
StartShowUserGroupsContent: before showing the user groups content
- $action: the current action

EndShowUserGroupsContent: after showing the user groups content
- $action: the current action

849 850 851 852 853 854
StartShowAllContent: before showing the all (you and friends) content
- $action: the current action

EndShowAllContent: after showing the all (you and friends) content
- $action: the current action

855 856 857 858 859 860
StartShowSubscriptionsMiniList: at the start of subscriptions mini list
- $action: the current action

EndShowSubscriptionsMiniList: at the end of subscriptions mini list
- $action: the current action

861 862 863 864 865 866
StartShowGroupsMiniList: at the start of groups mini list
- $action: the current action

EndShowGroupsMiniList: at the end of groups mini list
- $action: the current action

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
StartDeleteUserForm: starting the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted

EndDeleteUserForm: Ending the data in the form for deleting a user
- $action: action being shown
- $user: user being deleted

StartDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted

EndDeleteUser: handling the post for deleting a user
- $action: action being shown
- $user: user being deleted

883 884 885 886 887 888 889
StartNoticeAsActivity: before converting a notice to an activity
- $notice: notice being converted
- &$activity: initially empty activity

EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
- $notice: notice being converted
- &$activity: activity, now more-or-less full
890 891 892 893 894 895 896 897 898 899 900

StartNoticeSaveWeb: before saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- &$authorId: integer ID of the author
- &$text: text of the notice
- &$options: additional options (location, replies, etc.)

EndNoticeSaveWeb: after saving a notice through the Web interface
- $action: action being executed (instance of NewNoticeAction)
- $notice: notice that was saved

901 902 903 904 905 906 907 908
StartRssEntryArray: at the start of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry (empty at beginning)

EndRssEntryArray: at the end of copying a notice to an array
- $notice: the notice being copied
- &$entry: the entry, with all the fields filled up

Evan Prodromou's avatar
Evan Prodromou committed
909 910
NoticeDeleteRelated: at the beginning of deleting related fields to a notice
- $notice: notice being deleted
911 912 913 914 915 916 917 918 919 920 921

StartShowHeadTitle: when beginning to show the <title> element
- $action: action being shown

EndShowHeadTitle: when done showing the <title>
- $action: action being shown

StartShowPageTitle: when beginning to show the page title <h1>
- $action: action being shown

EndShowPageTitle: when done showing the page title <h1>
922 923 924 925 926 927 928 929 930
- $action: action being shown

StartDeleteOwnNotice: when a user starts to delete their own notice
- $user: the user doing the delete
- $notice: the notice being deleted

EndDeleteOwnNotice: when a user has deleted their own notice
- $user: the user doing the delete
- $notice: the notice being deleted
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946

StartShowFeedLinkList: before showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds to show

EndShowFeedLinkList: after showing the feed list in the sidebar
- $action: action being executed
- $feeds: list of feeds shown

StartShowFeedLink: before showing an individual feed item
- $action: action being executed
- $feed: feed to show

EndShowFeedLink: after showing an individual feed
- $action: action being executed
- $feed: feed to show
947 948 949 950 951 952

StartShowNoticeForm: before showing the notice form (before <form>)
- $action: action being executed

EndShowNoticeForm: after showing the notice form (after <form>)
- $action: action being executed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968

StartGrantRole: when a role is being assigned
- $profile: profile that will have the role
- $role: string name of the role

EndGrantRole: when a role has been successfully assigned
- $profile: profile that will have the role
- $role: string name of the role

StartRevokeRole: when a role is being revoked
- $profile: profile that will lose the role
- $role: string name of the role

EndRevokeRole: when a role has been revoked
- $profile: profile that lost the role
- $role: string name of the role
969 970 971

StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
- &$activity: received activity
972
- $user: user publishing the entry
973
- &$notice: notice created; initially null, can be set
974 975 976

EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
- $activity: received activity
977
- $user: user publishing the entry
978 979
- $notice: notice that was created

980 981 982 983 984 985 986
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
987

988 989 990 991 992 993 994
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
995 996 997 998 999 1000 1001 1002 1003 1004

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

StartAdminPanelNav: Before displaying the first item in the list of admin panels
- $nav The AdminPanelNav widget

EndAdminPanelNav: After displaying the last item in the list of admin panels
- $nav The AdminPanelNav widget
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

StartActivityObjectFromNotice: When converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Fill this and return false to override defaults.

EndActivityObjectFromNotice: After converting a notice to an activity:object
- $notice: The notice being converted
- &$object: The resulting object. Can be edited

StartActivityObjectFromProfile: When converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The (empty) object. Fill it up and return false to override defaults.

EndActivityObjectFromProfile: After converting a profile to an activity:object
- $profile: The profile being converted
- &$object: The finished object. Can be tweaked

StartActivityObjectFromGroup: When converting a group to an activity:object
- $group: The group being converted
- &$object: The (empty) object. Fill and return false to override.

EndActivityObjectFromGroup:  After converting a group to an activity:object
- $group:  The group being converted
- &$object: The finished object. Tweak as needed.
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042

StartImportActivity: when we start to import an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is
- &$done: Return value; whether to continue

EndImportActivity: when we finish importing an activity
- $user: User to make the author import
- $author: Author of the feed; good for comparisons
- $activity: The current activity
- $trusted: How "trusted" the process is

1043 1044 1045 1046 1047
StartProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)

EndProfileSettingsActions: when we're showing account-management action list
- $action: Action being shown (use for output)
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059

StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
- $nli: The notice list item being shown

EndOpenNoticeListItemElement: After the opening <li> of a notice list element
- $nli: The notice list item being shown

StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
- $nli: The notice list item being shown

EndCloseNoticeListItemElement: After the closing </li> of a notice list element
- $nli: The notice list item being shown