EVENTS.txt

   1 InitializePlugin: a chance to initialize a plugin in a complete environment
   2
   3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
   4
   5 StartPrimaryNav: Showing the primary nav menu
   6 - $action: the current action
   7
   8 EndPrimaryNav: At the end of the primary nav menu
   9 - $action: the current action
  10
  11 StartSecondaryNav: Showing the secondary nav menu
  12 - $action: the current action
  13
  14 EndSecondaryNav: At the end of the secondary nav menu
  15 - $action: the current action
  16
  17 StartShowStyles: Showing Style links; good place to add UA style resets
  18 - $action: the current action
  19
  20 EndShowStyles: End showing Style links; good place to add custom styles
  21 - $action: the current action
  22
  23 StartShowStatusNetStyles: Showing StatusNet Style links
  24 - $action: the current action
  25
  26 EndShowStatusNetStyles: End showing StatusNet Style links;  good place to add handheld or JavaScript dependant styles
  27 - $action: the current action
  28
  29 StartShowLaconicaStyles: backwards compatibility; deprecated
  30 - $action: the current action
  31
  32 EndShowLaconicaStyles: backwards compatibility; deprecated
  33 - $action: the current action
  34
  35 StartShowUAStyles: Showing custom User-Agent style links
  36 - $action: the current action
  37
  38 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  39 - $action: the current action
  40
  41 StartShowScripts: Showing JavaScript links
  42 - $action: the current action
  43
  44 EndShowScripts: End showing JavaScript links; good place to add custom
  45                 links like Google Analytics
  46 - $action: the current action
  47
  48 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  49 - $action: the current action
  50
  51 EndShowJQueryScripts: End showing JQuery script links
  52 - $action: the current action
  53
  54 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  55 - $action: the current action
  56
  57 EndShowStatusNetScripts: End showing StatusNet script links
  58 - $action: the current action
  59
  60 StartShowLaconicaScripts: backwards compatibility; deprecated
  61 - $action: the current action
  62
  63 EndShowLaconicaScripts: backwards compatibility; deprecated
  64 - $action: the current action
  65
  66 StartShowSections: Start the list of sections in the sidebar
  67 - $action: the current action
  68
  69 EndShowSections: End the list of sections in the sidebar
  70 - $action: the current action
  71
  72 StartShowHeader: Showing before the header container
  73 - $action: the current action
  74
  75 EndShowHeader: Showing after the header container
  76 - $action: the current action
  77
  78 StartShowFooter: Showing before the footer container
  79 - $action: the current action
  80
  81 EndShowFooter: Showing after the footer container
  82 - $action: the current action
  83
  84 StartShowContentBlock: Showing before the content container
  85 - $action: the current action
  86
  87 EndShowContentBlock: Showing after the content container
  88 - $action: the current action
  89
  90 StartShowAside: Showing before the Aside container
  91 - $action: the current action
  92
  93 EndShowAside: Showing after the Aside container
  94 - $action: the current action
  95
  96 StartShowNoticeFormData: Showing before the notice form data
  97 - $action: the current action
  98
  99 EndShowNoticeFormData: Showing after the notice form data
 100 - $action: the current action
 101
 102 StartNoticeSave: before inserting a notice (good place for content filters)
 103 - $notice: notice being saved (no ID or URI)
 104
 105 EndNoticeSave: after inserting a notice and related code
 106 - $notice: notice that was saved (with ID and URI)
 107
 108 StartShowLocalNavBlock: Showing the local nav menu
 109 - $action: the current action
 110
 111 EndShowLocalNavBlock: At the end of the local nav menu
 112 - $action: the current action
 113
 114 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
 115 - $action: the current action
 116
 117 EndShowHTML: Showing after the html element
 118 - $action: the current action
 119
 120 StartPublicGroupNav: Showing the public group nav menu
 121 - $action: the current action
 122
 123 EndPublicGroupNav: At the end of the public group nav menu
 124 - $action: the current action
 125
 126 StartSubGroupNav: Showing the subscriptions group nav menu
 127 - $action: the current action
 128
 129 EndSubGroupNav: At the end of the subscriptions group nav menu
 130 - $action: the current action
 131
 132 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
 133 - $m: the Net_URL_Mapper that has just been set up
 134
 135 RouterInitialized: After the router instance has been initialized
 136 - $m: the Net_URL_Mapper that has just been set up
 137
 138 StartLogout: Before logging out
 139 - $action: the logout action
 140
 141 EndLogout: After logging out
 142 - $action: the logout action
 143
 144 ArgsInitialize: After the argument array has been initialized
 145 - $args: associative array of arguments, can be modified
 146
 147 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
 148 - $action: the current action
 149
 150 EndAddressData: At the end of <address>
 151 - $action: the current action
 152
 153 StartShowSiteNotice: Before showing site notice
 154 - $action: the current action
 155
 156 EndShowSiteNotice: After showing site notice
 157 - $action: the current action
 158
 159 StartLoginGroupNav: Before showing the login and register navigation menu
 160 - $action: the current action
 161
 162 EndLoginGroupNav: After showing the login and register navigation menu
 163 - $action: the current action
 164
 165 StartAccountSettingsNav: Before showing the account settings menu
 166 - $action: the current action
 167
 168 EndAccountSettingsNav: After showing the account settings menu
 169 - $action: the current action
 170
 171 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
 172 - $widget: AccountSettingsNav instance being shown
 173
 174 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
 175 - $widget: AccountSettingsNav instance being shown
 176
 177 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
 178 - $widget: AccountSettingsNav instance being shown
 179
 180 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
 181 - $widget: AccountSettingsNav instance being shown
 182
 183 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
 184 - $widget: AccountSettingsNav instance being shown
 185
 186 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
 187 - $widget: AccountSettingsNav instance being shown
 188
 189 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
 190 - $widget: AccountSettingsNav instance being shown
 191
 192 EndAccountSettingsEmailMenuItem: After showing the Email menu item
 193 - $widget: AccountSettingsNav instance being shown
 194
 195 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
 196 - $widget: AccountSettingsNav instance being shown
 197
 198 EndAccountSettingsDesignMenuItem: After showing the Design menu item
 199 - $widget: AccountSettingsNav instance being shown
 200
 201 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
 202 - $widget: AccountSettingsNav instance being shown
 203
 204 EndAccountSettingsOtherMenuItem: After showing the Other menu item
 205 - $widget: AccountSettingsNav instance being shown
 206
 207 Autoload: When trying to autoload a class
 208 - $cls: the class being sought. A plugin might require_once the file for the class.
 209
 210 SensitiveAction: determines if an action is 'sensitive' and should use SSL
 211 - $action: name of the action, like 'login'
 212 - $sensitive: flag for whether this is a sensitive action
 213
 214 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
 215 - $action: name of the action, like 'register'
 216 - $login: flag for whether this is a login action
 217
 218 StartShowHead: called before showing the <head> element and children
 219 - $action: action object being show
 220
 221 EndShowHead: called after showing the <head> element (and </head>)
 222 - $action: action object being shown
 223
 224 StartShowBody: called before showing the <body> element and children
 225 - $action: action object being shown
 226
 227 EndShowBody: called after showing the <body> element (and </body>)
 228 - $action: action object being shown
 229
 230 StartPersonalGroupNav: beginning of personal group nav menu
 231 - $action: action object being shown
 232
 233 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
 234 - $action: action object being shown
 235
 236 StartGroupGroupNav: Showing the group nav menu
 237 - $action: the current action
 238
 239 EndGroupGroupNav: At the end of the group nav menu
 240 - $action: the current action
 241
 242 StartEndHTML: just before the </html> tag
 243 - $action: action object being shown
 244
 245 EndEndHTML: just after the </html> tag
 246 - $action: action object being shown
 247
 248 StartShowDesign: just before showing a site, user, or group design
 249 - $action: action object being shown
 250
 251 EndShowDesign: just after showing a site, user, or group design
 252 - $action: action object being shown
 253
 254 StartShowExportData: just before showing the <div> with export data (feeds)
 255 - $action: action object being shown
 256
 257 EndShowExportData: just after showing the <div> with export data (feeds)
 258 - $action: action object being shown
 259
 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 StartShowNoticeInfo: just before showing notice info
 267 - $item: The NoticeListItem object being shown
 268
 269 EndShowNoticeInfo: just after showing notice info
 270 - $item: The NoticeListItem object being shown
 271
 272 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
 273 - $item: the NoticeListItem object being shown
 274
 275 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
 276 - $item: the NoticeListItem object being shown
 277
 278 StartShowFaveForm: just before showing the fave form
 279 - $item: the NoticeListItem object being shown
 280
 281 EndShowFaveForm: just after showing the fave form
 282 - $item: the NoticeListItem object being shown
 283
 284 StartShowPageNotice: just before showing the page notice (instructions or error)
 285 - $action: action object being shown
 286
 287 EndShowPageNotice: just after showing the page notice (instructions or error)
 288 - $action: action object being shown
 289
 290 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
 291 - $action: action object being shown
 292
 293 StartProfileFormData: just before showing text entry fields on profile settings page
 294 - $action: action object being shown
 295
 296 EndProfileFormData: just after showing text entry fields on profile settings page
 297 - $action: action object being shown
 298
 299 StartProfileSaveForm: before starting to save a profile settings form
 300 - $action: action object being shown
 301
 302 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
 303 - $action: action object being shown
 304
 305 StartRegistrationFormData: just before showing text entry fields on registration page
 306 - $action: action object being shown
 307
 308 EndRegistrationFormData: just after showing text entry fields on registration page
 309 - $action: action object being shown
 310
 311 StartRegistrationTry: before validating and saving a new user
 312 - $action: action object being shown
 313
 314 EndRegistrationTry: after saving a new user (note: no profile or user object!)
 315 - $action: action object being shown
 316
 317 StartAvatarFormData: before displaying avatar form
 318 - $action: action object being shown
 319
 320 EndAvatarFormData: after displaying avatar form
 321 - $action: action object being shown
 322
 323 StartAvatarSaveForm: before saving the avatar
 324 - $action: action object being shown
 325
 326 EndAvatarSaveForm: after saving the avatar
 327 - $action: action object being shown
 328
 329 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
 330 - $qm: empty queue manager to set
 331
 332 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
 333 - $action: action object being shown
 334 - $user: current user
 335
 336 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
 337 - $title: title of the document
 338 - $output: HTML output to show
 339
 340 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
 341 - $title: title of the document
 342 - $output: HTML output to show
 343
 344 StartApiRss: after the rss <channel> element is started
 345 - $action: action object being shown
 346
 347 StartApiAtom: after the <feed> element is started
 348 - $action: action object being shown
 349
 350 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
 351 - $notice: the notice being added
 352 - &$transports: modifiable list of transports (as strings) to queue for
 353
 354 EndEnqueueNotice: after adding a notice to the queues
 355 - $notice: the notice being added
 356 - $transports: modifiable list of transports to use
 357
 358 UnqueueHandleNotice: Handle a notice when no queue manager is available
 359 - $notice: the notice to handle
 360 - $queue: the "queue" that is being executed
 361
 362 GetValidDaemons: Just before determining which daemons to run
 363 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
 364
 365 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
 366 - &$notice: notice to handle
 367
 368 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
 369 - $action: the current action
 370 - &$attrs: attributes for the HTML element
 371
 372 EndHtmlElement: Right after outputting the HTML element
 373 - $action: the current action
 374 - &$attrs: attributes for the HTML element
 375
 376 StartShowHeadElements: Right after the <head> tag
 377 - $action: the current action
 378
 379 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
 380 - $action: the current action
 381
 382 CheckSchema: chance to check the schema
 383
 384 StartProfileRemoteSubscribe: Before showing the link to remote subscription
 385 - $userprofile: UserProfile widget
 386 - &$profile: the profile being shown
 387
 388 EndProfileRemoteSubscribe: After showing the link to remote subscription
 389 - $userprofile: UserProfile widget
 390 - &$profile: the profile being shown
 391
 392 StartGroupSubscribe: Before showing the link to remote subscription
 393 - $action: the current action
 394 - $group: the group being shown
 395
 396 EndGroupSubscribe: After showing the link to remote subscription
 397 - $action: the current action
 398 - $group: the group being shown
 399
 400 StartProfilePageProfileSection: Starting to show the section of the
 401                               profile page with the actual profile data;
 402                               hook to prevent showing the profile (e.g.)
 403 - $userprofile: UserProfile widget
 404 - &$profile: the profile being shown
 405
 406 StartProfilePageProfileElements: inside the section, before the first
 407                                element; prepend elements here
 408 - $userprofile: UserProfile widget
 409 - &$profile: the profile being shown
 410
 411 EndProfilePageProfileElements: inside the section, after the last element;
 412                              append elements here
 413 - $userprofile: UserProfile widget
 414 - &$profile: the profile being shown
 415
 416 EndProfilePageProfileSection: After showing the section of the profile
 417                             page with the profile elements
 418 - $userprofile: UserProfile widget
 419 - &$profile: the profile being shown
 420
 421 StartProfilePageActionsSection: Starting to show the section of the
 422                                     profile page with action links; hook
 423                                     to hide them (for example)
 424 - $userprofile: UserProfile widget
 425 - &$profile: the profile being shown
 426
 427 StartProfilePageActionsElements: inside the list, before the first
 428                                      element; prepend elements here
 429 - $userprofile: UserProfile widget
 430 - &$profile: the profile being shown
 431
 432 EndProfilePageActionsElements: inside the list, after the last element;
 433                                    append elements here
 434 - $userprofile: UserProfile widget
 435 - &$profile: the profile being shown
 436
 437 EndProfilePageActionsSection: After showing the section of the profile
 438                                   page with the entity actions
 439 - $userprofile: UserProfile widget
 440 - &$profile: the profile being shown
 441
 442 StartProfilePageAvatar: before showing the avatar on the profile page
 443 - $userprofile: UserProfile widget
 444 - &$profile: the profile being shown
 445
 446 EndProfilePageAvatar: after showing the avatar on the profile page
 447 - $userprofile: UserProfile widget
 448 - &$profile: the profile being shown
 449
 450 StartProfilePageNickname: before showing the nickname on the profile page
 451 - $userprofile: UserProfile widget
 452 - &$profile: the profile being shown
 453
 454 EndProfilePageNickname: after showing the nickname on the profile page
 455 - $userprofile: UserProfile widget
 456 - &$profile: the profile being shown
 457
 458 StartProfilePageFullName: before showing the fullname on the profile page
 459 - $userprofile: UserProfile widget
 460 - &$profile: the profile being shown
 461
 462 EndProfilePageFullName: after showing the fullname on the profile page
 463 - $userprofile: UserProfile widget
 464 - &$profile: the profile being shown
 465
 466 StartProfilePageLocation: before showing the location on the profile page
 467 - $userprofile: UserProfile widget
 468 - &$profile: the profile being shown
 469
 470 EndProfilePageLocation: after showing the location on the profile page
 471 - $userprofile: UserProfile widget
 472 - &$profile: the profile being shown
 473
 474 StartProfilePageHomepage: before showing the homepage link on the profile page
 475 - $userprofile: UserProfile widget
 476 - &$profile: the profile being shown
 477
 478 EndProfilePageHomepage: after showing the homepage on the profile page
 479 - $userprofile: UserProfile widget
 480 - &$profile: the profile being shown
 481
 482 StartProfilePageBio: before showing the bio on the profile page
 483 - $userprofile: UserProfile widget
 484 - &$profile: the profile being shown
 485
 486 EndProfilePageBio: after showing the bio on the profile page
 487 - $userprofile: UserProfile widget
 488 - &$profile: the profile being shown
 489
 490 StartProfilePageProfileTags: before showing the tags on the profile page
 491 - $userprofile: UserProfile widget
 492 - &$profile: the profile being shown
 493
 494 EndProfilePageProfileTags: after showing the tags on the profile page
 495 - $userprofile: UserProfile widget
 496 - &$profile: the profile being shown
 497
 498 StartProfileList: when starting a list of profiles (before <ul>)
 499 - $profilelist: ProfileList widget, with $profile, $action, and $out
 500
 501 EndProfileList: when ending a list of profiles (after </ul>)
 502 - $profilelist: ProfileList widget
 503
 504 StartProfileListItem: when starting to show a profile list item
 505 - $item: ProfileListItem widget
 506
 507 EndProfileListItem: after showing a profile list item
 508 - $item: ProfileListItem widget
 509
 510 StartProfileListItemProfile: the profile data part of the item
 511 - $item: ProfileListItem widget
 512
 513 EndProfileListItemProfile: the profile data part of the item
 514 - $item: ProfileListItem widget
 515
 516 StartProfileListItemActions: the actions (buttons) for an item
 517 - $item: ProfileListItem widget
 518
 519 EndProfileListItemActions: the actions (buttons) for an item
 520 - $item: ProfileListItem widget
 521
 522 StartProfileListItemProfileElements: inside the <div>
 523 - $item: ProfileListItem widget
 524
 525 EndProfileListItemProfileElements: inside the <div>
 526 - $item: ProfileListItem widget
 527
 528 StartProfileListItemAvatar: Showing a profile list avatar
 529 - $item: ProfileListItem widget
 530
 531 EndProfileListItemAvatar: Showing a profile list avatar
 532 - $item: ProfileListItem widget
 533
 534 StartProfileListItemFullName: Showing the profile list full name
 535 - $item: ProfileListItem widget
 536
 537 EndProfileListItemFullName: Showing the profile list full name
 538 - $item: ProfileListItem widget
 539
 540 StartProfileListItemLocation: Showing the profile list location
 541 - $item: ProfileListItem widget
 542
 543 EndProfileListItemLocation: Showing the profile list location
 544 - $item: ProfileListItem widget
 545
 546 StartProfileListItemHomepage: Showing the profile list homepage
 547 - $item: ProfileListItem widget
 548
 549 EndProfileListItemHomepage: Showing the profile list homepage
 550 - $item: ProfileListItem widget
 551
 552 StartProfileListItemBio: Showing the profile list bio
 553 - $item: ProfileListItem widget
 554
 555 EndProfileListItemBio: Showing the profile list bio
 556 - $item: ProfileListItem widget
 557
 558 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
 559 - $item: ProfileListItem widget
 560
 561 EndProfileListItemActionElements: Showing profile list actions (append a button here)
 562 - $item: ProfileListItem widget
 563
 564 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
 565 - $action: the current action
 566 - &$xrdsoutputter - XRDSOutputter object to write to
 567
 568 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
 569 - $action: the current action
 570 - &$xrdsoutputter - XRDSOutputter object to write to
 571
 572 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
 573 - $action: the current action
 574 - &$xrdsoutputter - XRDSOutputter object to write to
 575
 576 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
 577 - $action: the current action
 578 - &$xrdsoutputter - XRDSOutputter object to write to
 579
 580 StartCheckPassword: Check a username/password
 581 - $nickname: The nickname to check
 582 - $password: The password to check
 583 - &$authenticatedUser: set to User object if credentials match a user.
 584
 585 EndCheckPassword: After checking a username/password pair
 586 - $nickname: The nickname that was checked
 587 - $password: The password that was checked
 588 - $authenticatedUser: User object if credentials match a user, else null.
 589
 590 StartChangePassword: Before changing a password
 591 - $user: user
 592 - $oldpassword: the user's old password
 593 - $newpassword: the desired new password
 594
 595 EndChangePassword: After changing a password
 596 - $user: user
 597
 598 StartSetUser: Before setting the currently logged in user
 599 - $user: user
 600
 601 EndSetUser: After setting the currently logged in user
 602 - $user: user
 603
 604 StartSetApiUser: Before setting the current API user
 605 - $user: user
 606
 607 EndSetApiUser: After setting the current API user
 608 - $user: user
 609
 610 StartHasRole: Before determing if the a profile has a given role
 611 - $profile: profile in question
 612 - $name: name of the role in question
 613 - &$has_role: does this profile have the named role?
 614
 615 EndHasRole: Before determing if the a profile has a given role
 616 - $profile: profile in question
 617 - $name: name of the role in question
 618 - $has_role: does this profile have the named role?
 619
 620 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
 621 - $user: User object
 622 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
 623
 624 GetUrlShorteners: Specify URL shorteners that are available for use
 625 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
 626
 627 StartShortenUrl: About to shorten a URL
 628 - $url: url to be shortened
 629 - $shortenerName: name of the requested shortener
 630 - &$shortenedUrl: short version of the url
 631
 632 EndShortenUrl: After a URL has been shortened
 633 - $url: url to be shortened
 634 - $shortenerName: name of the requested shortener
 635 - $shortenedUrl: short version of the url
 636
 637 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
 638 - $action
 639 - &$src
 640 - &$theme
 641 - &$media
 642
 643 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
 644 - $action
 645 - $src
 646 - $theme
 647 - $media
 648
 649 StartStyleElement: Before a <style...> element is written
 650 - $action
 651 - &$code
 652 - &$type
 653 - &$media
 654
 655 EndStyleElement: After a <style...> element is written
 656 - $action
 657 - $code
 658 - $type
 659 - $media
 660
 661 StartScriptElement: Before a <script...> element is written
 662 - $action
 663 - &$src
 664 - &$type
 665
 666 EndScriptElement: After a <script...> element is written
 667 - $action
 668 - $src
 669 - $type
 670
 671 StartInlineScriptElement: Before a <script...> element is written
 672 - $action
 673 - &$code
 674 - &$type
 675
 676 EndInlineScriptElement: After a <script...> element is written
 677 - $action
 678 - $code
 679 - $type
 680
 681 StartLog: Before writing to the logs
 682 - &$priority
 683 - &$msg
 684 - &$filename
 685
 686 EndLog: After writing to the logs
 687 - $priority
 688 - $msg
 689 - $filename
 690
 691 StartBlockProfile: when we're about to block
 692 - $user: the person doing the block
 693 - $profile: the person getting blocked, can be remote
 694
 695 EndBlockProfile: when a block has succeeded
 696 - $user: the person doing the block
 697 - $profile: the person blocked, can be remote
 698
 699 StartUnblockProfile: when we're about to unblock
 700 - $user: the person doing the unblock
 701 - $profile: the person getting unblocked, can be remote
 702
 703 EndUnblockProfile: when an unblock has succeeded
 704 - $user: the person doing the unblock
 705 - $profile: the person unblocked, can be remote
 706
 707 StartSubscribe: when a subscription is starting
 708 - $user: the person subscribing
 709 - $other: the person being subscribed to
 710
 711 EndSubscribe: when a subscription is finished
 712 - $user: the person subscribing
 713 - $other: the person being subscribed to
 714
 715 StartUnsubscribe: when an unsubscribe is starting
 716 - $user: the person unsubscribing
 717 - $other: the person being unsubscribed from
 718
 719 EndUnsubscribe: when an unsubscribe is done
 720 - $user: the person unsubscribing
 721 - $other: the person being unsubscribed to
 722
 723 StartJoinGroup: when a user is joining a group
 724 - $group: the group being joined
 725 - $user: the user joining
 726
 727 EndJoinGroup: when a user finishes joining a group
 728 - $group: the group being joined
 729 - $user: the user joining
 730
 731 StartLeaveGroup: when a user is leaving a group
 732 - $group: the group being left
 733 - $user: the user leaving
 734
 735 EndLeaveGroup: when a user has left a group
 736 - $group: the group being left
 737 - $user: the user leaving
 738
 739 StartShowContentLicense: Showing the default license for content
 740 - $action: the current action
 741
 742 EndShowContentLicense: Showing the default license for content
 743 - $action: the current action
 744
 745 StartUserRegister: When a new user is being registered
 746 - &$profile: new profile data (no ID)
 747 - &$user: new user account (no ID or URI)
 748
 749 EndUserRegister: When a new user has been registered
 750 - &$profile: new profile data
 751 - &$user: new user account
 752
 753 StartRobotsTxt: Before outputting the robots.txt page
 754 - &$action: RobotstxtAction being shown
 755
 756 EndRobotsTxt: After the default robots.txt page (good place for customization)
 757 - &$action: RobotstxtAction being shown
 758
 759 StartGetProfileUri: When determining the canonical URI for a given profile
 760 - $profile: the current profile
 761 - &$uri: the URI
 762
 763 EndGetProfileUri: After determining the canonical URI for a given profile
 764 - $profile: the current profile
 765 - &$uri: the URI
 766
 767 StartFavorNotice: Saving a notice as a favorite
 768 - $profile: profile of the person faving (can be remote!)
 769 - $notice: notice being faved
 770 - &$fave: Favor object; null to start off with, but feel free to override.
 771
 772 EndFavorNotice: After saving a notice as a favorite
 773 - $profile: profile of the person faving (can be remote!)
 774 - $notice: notice being faved
 775
 776 StartDisfavorNotice: Saving a notice as a favorite
 777 - $profile: profile of the person faving (can be remote!)
 778 - $notice: notice being faved
 779 - &$result: result of the disfavoring (if you override)
 780
 781 EndDisfavorNotice: After saving a notice as a favorite
 782 - $profile: profile of the person faving (can be remote!)
 783 - $notice: notice being faved
 784
 785 StartFavorNoticeForm: starting the data in the form for favoring a notice
 786 - $FavorForm: the favor form being shown
 787 - $notice: notice being favored
 788
 789 EndFavorNoticeForm: Ending the data in the form for favoring a notice
 790 - $FavorForm: the favor form being shown
 791 - $notice: notice being favored
 792
 793 StartDisFavorNoticeForm: starting the data in the form for disfavoring a notice
 794 - $DisfavorForm: the disfavor form being shown
 795 - $notice: notice being difavored
 796
 797 EndDisFavorNoticeForm: Ending the data in the form for disfavoring a notice
 798 - $DisfavorForm: the disfavor form being shown
 799 - $notice: notice being disfavored
 800
 801 StartFindMentions: start finding mentions in a block of text
 802 - $sender: sender profile
 803 - $text: plain text version of the notice
 804 - &$mentions: mentions found so far. Array of arrays; each array
 805   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 806   'title' (title of the link), 'position' (position of the text to
 807   replace), 'text' (text to replace)
 808
 809 EndFindMentions: end finding mentions in a block of text
 810 - $sender: sender profile
 811 - $text: plain text version of the notice
 812 - &$mentions: mentions found so far. Array of arrays; each array
 813   has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
 814   'title' (title of the link), 'position' (position of the text to
 815   replace), 'text' (text to replace)
 816
 817 StartShowSubscriptionsContent: before showing the subscriptions content
 818 - $action: the current action
 819
 820 EndShowSubscriptionsContent: after showing the subscriptions content
 821 - $action: the current action
 822
 823 StartShowUserGroupsContent: before showing the user groups content
 824 - $action: the current action
 825
 826 EndShowUserGroupsContent: after showing the user groups content
 827 - $action: the current action
 828
 829 StartShowAllContent: before showing the all (you and friends) content
 830 - $action: the current action
 831
 832 EndShowAllContent: after showing the all (you and friends) content
 833 - $action: the current action
 834
 835 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
 836 - $action: the current action
 837
 838 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
 839 - $action: the current action
 840
 841 StartShowGroupsMiniList: at the start of groups mini list
 842 - $action: the current action
 843
 844 EndShowGroupsMiniList: at the end of groups mini list
 845 - $action: the current action
 846
 847 StartDeleteUserForm: starting the data in the form for deleting a user
 848 - $action: action being shown
 849 - $user: user being deleted
 850
 851 EndDeleteUserForm: Ending the data in the form for deleting a user
 852 - $action: action being shown
 853 - $user: user being deleted
 854
 855 StartDeleteUser: handling the post for deleting a user
 856 - $action: action being shown
 857 - $user: user being deleted
 858
 859 EndDeleteUser: handling the post for deleting a user
 860 - $action: action being shown
 861 - $user: user being deleted
 862
 863 StartActivityStart: starting the output for a notice activity <event>
 864 - &$notice: notice being output
 865 - &$xs: XMLStringer for output
 866 - &$attrs: <entry> attributes (mostly namespace declarations, if any)
 867
 868 EndActivityStart: end the opening tag for an activity <event>
 869 - &$notice: notice being output
 870 - &$xs: XMLStringer for output
 871 - $attrs: <entry> attributes (mostly namespace declarations, if any)
 872
 873 StartActivitySource: before outputting the <source> element for a notice activity
 874 - &$notice: notice being output
 875 - &$xs: XMLStringer for output
 876
 877 EndActivitySource: after outputting the <source> element for a notice activity
 878 - &$notice: notice being output
 879 - &$xs: XMLStringer for output
 880
 881 StartActivityTitle: before outputting notice activity title
 882 - &$notice: notice being output
 883 - &$xs: XMLStringer for output
 884 - &$title: title of the notice, mutable
 885
 886 EndActivityTitle: after outputting notice activity title
 887 - $notice: notice being output
 888 - &$xs: XMLStringer for output
 889 - $title: title of the notice
 890
 891 StartActivityAuthor: before outputting atom author
 892 - &$notice: notice being output
 893 - &$xs: XMLStringer for output
 894 - &$atomAuthor: string for XML representing atom author
 895
 896 EndActivityAuthor: after outputting atom author
 897 - &$notice: notice being output
 898 - &$xs: XMLStringer for output
 899 - &$atomAuthor: string for XML representing atom author
 900
 901 StartActivityActor: before outputting activity actor element for a notice activity entry
 902 - &$notice: notice being output
 903 - &$xs: XMLStringer for output
 904 - &$actor: string for XML representing activity actor
 905
 906 EndActivityActor: after outputting activity actor element for a notice activity entry
 907 - &$notice: notice being output
 908 - &$xs: XMLStringer for output
 909 - &$actor: string for XML representing activity actor
 910
 911 StartActivityLink: before outputting activity HTML link element for a notice activity entry
 912 - &$notice: notice being output
 913 - &$xs: XMLStringer for output
 914 - &$url: URL for activity HTML link element for a notice activity entry
 915
 916 EndActivityLink: before outputting activity HTML link element for a notice activity entry
 917 - &$notice: notice being output
 918 - &$xs: XMLStringer for output
 919 - $url:  URL for activity HTML link element for a notice activity entry
 920
 921 StartActivityId: before outputting atom:id element for a notice activity entry
 922 - &$notice: notice being output
 923 - &$xs: XMLStringer for output
 924 - &$id: atom:id (notice URI by default)
 925
 926 EndActivityId: after outputting atom:id element for a notice activity entry
 927 - &$notice: notice being output
 928 - &$xs: XMLStringer for output
 929 - $id:  atom:id (notice URI by default)
 930
 931 StartActivityPublished: before outputting atom:published element for a notice activity entry
 932 - &$notice: notice being output
 933 - &$xs: XMLStringer for output
 934 - &$published: atom:published value (notice created by default)
 935
 936 EndActivityPublished: before outputting atom:published element for a notice activity entry
 937 - &$notice: notice being output
 938 - &$xs: XMLStringer for output
 939 - $published:  atom:published value (notice created by default)
 940
 941 StartActivityUpdated: before outputting atom:updated element for a notice activity entry
 942 - &$notice: notice being output
 943 - &$xs: XMLStringer for output
 944 - &$updated: atom:updated value (same as atom:published by default)
 945
 946 EndActivityUpdated: after outputting atom:updated element for a notice activity entry
 947 - &$notice: notice being output
 948 - &$xs: XMLStringer for output
 949 - $updated: atom:updated value (same as atom:published by default)
 950
 951 StartActivityContent: before outputting atom:content element for a notice activity entry
 952 - &$notice: notice being output
 953 - &$xs: XMLStringer for output
 954 - &$content: atom:content value (notice rendered HTML by default)
 955
 956 EndActivityContent: after outputting atom:content element for a notice activity entry
 957 - &$notice: notice being output
 958 - &$xs: XMLStringer for output
 959 - $content: atom:content value (notice rendered HTML by default)
 960
 961 StartActivityVerb: before outputting activity:verb element for a notice activity entry
 962 - &$notice: notice being output
 963 - &$xs: XMLStringer for output
 964 - &$verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 965
 966 EndActivityVerb: after outputting activity:verb element for a notice activity entry
 967 - &$notice: notice being output
 968 - &$xs: XMLStringer for output
 969 - $verb: activity:verb URI ('http://activitystrea.ms/schema/1.0/post' by default)
 970
 971 StartActivityDefaultObjectType: before outputting activity:object-type element for a notice activity entry
 972 - &$notice: notice being output
 973 - &$xs: XMLStringer for output
 974 - &$type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 975
 976 EndActivityDefaultObjectType: after outputting activity:verb element for a notice activity entry
 977 - &$notice: notice being output
 978 - &$xs: XMLStringer for output
 979 - $type: activity:object-type URI for default object ('http://activitystrea.ms/schema/1.0/note' by default)
 980
 981 StartActivityObjects: before outputting activity:object elements for a notice activity entry
 982 - &$notice: notice being output
 983 - &$xs: XMLStringer for output
 984 - &$objects: array of ActivityObject objects to output (empty by default)
 985
 986 EndActivityObjects: after outputting activity:object elements for a notice activity entry
 987 - &$notice: notice being output
 988 - &$xs: XMLStringer for output
 989 - $objects: array of ActivityObject objects to output (empty by default)
 990
 991 StartActivityNoticeInfo: before outputting statusnet:notice-info element for a notice activity entry
 992 - &$notice: notice being output
 993 - &$xs: XMLStringer for output
 994 - &$noticeInfoAttr: array of attributes for notice info element
 995
 996 EndActivityNoticeInfo: after outputting statusnet:notice-info element for a notice activity entry
 997 - &$notice: notice being output
 998 - &$xs: XMLStringer for output
 999 - $noticeInfoAttr: array of attributes for notice info element
1000
1001 StartActivityInReplyTo: before outputting thr:in-reply-to element for a notice activity entry
1002 - &$notice: notice being output
1003 - &$xs: XMLStringer for output
1004 - &$replyNotice: Notice object the main notice is in-reply-to
1005
1006 EndActivityInReplyTo: after outputting thr:in-reply-to element for a notice activity entry
1007 - &$notice: notice being output
1008 - &$xs: XMLStringer for output
1009 - $replyNotice: Notice object the main notice is in-reply-to
1010
1011 StartActivityConversation: before outputting ostatus:conversation link element for a notice activity entry
1012 - &$notice: notice being output
1013 - &$xs: XMLStringer for output
1014 - &$conv: Conversation object
1015
1016 EndActivityConversation: after outputting ostatus:conversation link element for a notice activity entry
1017 - &$notice: notice being output
1018 - &$xs: XMLStringer for output
1019 - $conv: Conversation object
1020
1021 StartActivityAttentionProfiles: before outputting ostatus:attention link element for people in a notice activity entry
1022 - &$notice: notice being output
1023 - &$xs: XMLStringer for output
1024 - &$replyProfiles: array of profiles of people being replied to
1025
1026 EndActivityAttentionProfiles: after outputting ostatus:attention link element for people in a notice activity entry
1027 - &$notice: notice being output
1028 - &$xs: XMLStringer for output
1029 - $replyProfiles: array of Profile object of people being replied to
1030
1031 StartActivityAttentionGroups: before outputting ostatus:attention link element for groups in a notice activity entry
1032 - &$notice: notice being output
1033 - &$xs: XMLStringer for output
1034 - &$groups: array of Group objects of groups being addressed
1035
1036 EndActivityAttentionGroups: after outputting ostatus:attention link element for groups in a notice activity entry
1037 - &$notice: notice being output
1038 - &$xs: XMLStringer for output
1039 - $groups: array of Group objects of groups being addressed
1040
1041 StartActivityForward: before outputting ostatus:forward link element in a notice activity entry
1042 - &$notice: notice being output
1043 - &$xs: XMLStringer for output
1044 - &$repeat: Notice that was repeated
1045
1046 EndActivityForward: after outputting ostatus:forward link element in a notice activity entry
1047 - &$notice: notice being output
1048 - &$xs: XMLStringer for output
1049 - $repeat: Notice that was repeated
1050
1051 StartActivityCategories: before outputting atom:category elements in a notice activity entry
1052 - &$notice: notice being output
1053 - &$xs: XMLStringer for output
1054 - &$tags: array of strings for tags on the notice (used for categories)
1055
1056 EndActivityCategories: after outputting atom:category elements in a notice activity entry
1057 - &$notice: notice being output
1058 - &$xs: XMLStringer for output
1059 - $tags: array of strings for tags on the notice (used for categories)
1060
1061 StartActivityEnclosures: before outputting enclosure link elements in a notice activity entry
1062 - &$notice: notice being output
1063 - &$xs: XMLStringer for output
1064 - &$enclosures: array of enclosure objects (see File::getEnclosure() for details)
1065
1066 EndActivityEnclosures: after outputting enclosure link elements in a notice activity entry
1067 - &$notice: notice being output
1068 - &$xs: XMLStringer for output
1069 - $enclosures: array of enclosure objects (see File::getEnclosure() for details)
1070
1071 StartActivityGeo: before outputting geo:rss element in a notice activity entry
1072 - &$notice: notice being output
1073 - &$xs: XMLStringer for output
1074 - &$lat: latitude
1075 - &$lon: longitude
1076
1077 EndActivityGeo: after outputting geo:rss element in a notice activity entry
1078 - &$notice: notice being output
1079 - &$xs: XMLStringer for output
1080 - $lat: latitude
1081 - $lon: longitude
1082
1083 StartActivityEnd: before the closing </entry> in a notice activity entry (last chance for data!)
1084 - &$notice: notice being output
1085 - &$xs: XMLStringer for output
1086
1087 EndActivityEnd: after the closing </entry> in a notice activity entry
1088 - &$notice: notice being output
1089 - &$xs: XMLStringer for output
1090
1091 StartNoticeSaveWeb: before saving a notice through the Web interface
1092 - $action: action being executed (instance of NewNoticeAction)
1093 - &$authorId: integer ID of the author
1094 - &$text: text of the notice
1095 - &$options: additional options (location, replies, etc.)
1096
1097 EndNoticeSaveWeb: after saving a notice through the Web interface
1098 - $action: action being executed (instance of NewNoticeAction)
1099 - $notice: notice that was saved
1100
1101 StartRssEntryArray: at the start of copying a notice to an array
1102 - $notice: the notice being copied
1103 - &$entry: the entry (empty at beginning)
1104
1105 EndRssEntryArray: at the end of copying a notice to an array
1106 - $notice: the notice being copied
1107 - &$entry: the entry, with all the fields filled up
1108
1109 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
1110 - $notice: notice being deleted
1111
1112 StartShowHeadTitle: when beginning to show the <title> element
1113 - $action: action being shown
1114
1115 EndShowHeadTitle: when done showing the <title>
1116 - $action: action being shown
1117
1118 StartShowPageTitle: when beginning to show the page title <h1>
1119 - $action: action being shown
1120
1121 EndShowPageTitle: when done showing the page title <h1>
1122 - $action: action being shown
1123
1124 StartDeleteOwnNotice: when a user starts to delete their own notice
1125 - $user: the user doing the delete
1126 - $notice: the notice being deleted
1127
1128 EndDeleteOwnNotice: when a user has deleted their own notice
1129 - $user: the user doing the delete
1130 - $notice: the notice being deleted
1131
1132 StartShowFeedLinkList: before showing the feed list in the sidebar
1133 - $action: action being executed
1134 - $feeds: list of feeds to show
1135
1136 EndShowFeedLinkList: after showing the feed list in the sidebar
1137 - $action: action being executed
1138 - $feeds: list of feeds shown
1139
1140 StartShowFeedLink: before showing an individual feed item
1141 - $action: action being executed
1142 - $feed: feed to show
1143
1144 EndShowFeedLink: after showing an individual feed
1145 - $action: action being executed
1146 - $feed: feed to show
1147
1148 StartShowNoticeForm: before showing the notice form (before <form>)
1149 - $action: action being executed
1150
1151 EndShowNoticeForm: after showing the notice form (after <form>)
1152 - $action: action being executed
1153
1154 StartGrantRole: when a role is being assigned
1155 - $profile: profile that will have the role
1156 - $role: string name of the role
1157
1158 EndGrantRole: when a role has been successfully assigned
1159 - $profile: profile that will have the role
1160 - $role: string name of the role
1161
1162 StartRevokeRole: when a role is being revoked
1163 - $profile: profile that will lose the role
1164 - $role: string name of the role
1165
1166 EndRevokeRole: when a role has been revoked
1167 - $profile: profile that lost the role
1168 - $role: string name of the role