1 InitializePlugin: a chance to initialize a plugin in a complete environment
3 CleanupPlugin: a chance to cleanup a plugin at the end of a program
5 StartPrimaryNav: Showing the primary nav menu
6 - $action: the current action
8 EndPrimaryNav: At the end of the primary nav menu
9 - $action: the current action
11 StartSecondaryNav: Showing the secondary nav menu
12 - $action: the current action
14 EndSecondaryNav: At the end of the secondary nav menu
15 - $action: the current action
17 StartShowStyles: Showing Style links; good place to add UA style resets
18 - $action: the current action
20 EndShowStyles: End showing Style links; good place to add custom styles
21 - $action: the current action
23 StartShowStylesheets: Showing stylesheet links
24 - $action: the current action
26 EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
27 - $action: the current action
29 StartShowUAStyles: Showing custom User-Agent style links
30 - $action: the current action
32 EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
33 - $action: the current action
35 StartShowScripts: Showing JavaScript links
36 - $action: the current action
38 EndShowScripts: End showing JavaScript links; good place to add custom
39 links like Google Analytics
40 - $action: the current action
42 StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
43 - $action: the current action
45 EndShowJQueryScripts: End showing JQuery script links
46 - $action: the current action
48 StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
49 - $action: the current action
51 EndShowStatusNetScripts: End showing StatusNet script links
52 - $action: the current action
54 StartShowSections: Start the list of sections in the sidebar
55 - $action: the current action
57 EndShowSections: End the list of sections in the sidebar
58 - $action: the current action
60 StartShowHeader: Showing before the header container
61 - $action: the current action
63 EndShowHeader: Showing after the header container
64 - $action: the current action
66 StartShowFooter: Showing before the footer container
67 - $action: the current action
69 EndShowFooter: Showing after the footer container
70 - $action: the current action
72 StartShowContentBlock: Showing before the content container
73 - $action: the current action
75 EndShowContentBlock: Showing after the content container
76 - $action: the current action
78 StartShowAside: Showing before the Aside container
79 - $action: the current action
81 EndShowAside: Showing after the Aside container
82 - $action: the current action
84 StartShowNoticeFormData: Showing before the notice form data
85 - $action: the current action
87 EndShowNoticeFormData: Showing after the notice form data
88 - $action: the current action
90 StartNoticeSave: before inserting a notice (good place for content filters)
91 - $notice: notice being saved (no ID or URI)
93 EndNoticeSave: after inserting a notice and related code
94 - $notice: notice that was saved (with ID and URI)
96 StartShowLocalNavBlock: Showing the local nav menu
97 - $action: the current action
99 EndShowLocalNavBlock: At the end of the local nav menu
100 - $action: the current action
102 StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
103 - $action: the current action
105 EndShowHTML: Showing after the html element
106 - $action: the current action
108 StartPublicGroupNav: Showing the public group nav menu
109 - $menu: the menu widget; use $menu->action for output
111 EndPublicGroupNav: At the end of the public group nav menu
112 - $menu: the menu widget; use $menu->action for output
114 StartSubGroupNav: Showing the subscriptions group nav menu
115 - $menu: the menu widget; use $menu->action for output
117 EndSubGroupNav: At the end of the subscriptions group nav menu
118 - $menu: the menu widget; use $menu->action for output
120 StartInitializeRouter: Before the router instance has been initialized; good place to add routes
121 - $m: the Net_URL_Mapper that has just been set up
123 RouterInitialized: After the router instance has been initialized
124 - $m: the Net_URL_Mapper that has just been set up
126 StartLogout: Before logging out
127 - $action: the logout action
129 EndLogout: After logging out
130 - $action: the logout action
132 ArgsInitialize: After the argument array has been initialized
133 - $args: associative array of arguments, can be modified
135 StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
136 - $action: the current action
138 EndAddressData: At the end of <address>
139 - $action: the current action
141 StartShowSiteNotice: Before showing site notice
142 - $action: the current action
144 EndShowSiteNotice: After showing site notice
145 - $action: the current action
147 StartLoginGroupNav: Before showing the login and register navigation menu
148 - $action: the current action
150 EndLoginGroupNav: After showing the login and register navigation menu
151 - $action: the current action
153 StartAccountSettingsNav: Before showing the account settings menu
154 - $action: the current action
156 EndAccountSettingsNav: After showing the account settings menu
157 - $action: the current action
159 StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
160 - $widget: AccountSettingsNav instance being shown
162 EndAccountSettingsProfileMenuItem: After showing the Profile menu item
163 - $widget: AccountSettingsNav instance being shown
165 StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
166 - $widget: AccountSettingsNav instance being shown
168 EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
169 - $widget: AccountSettingsNav instance being shown
171 StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
172 - $widget: AccountSettingsNav instance being shown
174 EndAccountSettingsPasswordMenuItem: After showing the Password menu item
175 - $widget: AccountSettingsNav instance being shown
177 StartAccountSettingsEmailMenuItem: Before showing the Email menu item
178 - $widget: AccountSettingsNav instance being shown
180 EndAccountSettingsEmailMenuItem: After showing the Email menu item
181 - $widget: AccountSettingsNav instance being shown
183 StartAccountSettingsDesignMenuItem: Before showing the Design menu item
184 - $widget: AccountSettingsNav instance being shown
186 EndAccountSettingsDesignMenuItem: After showing the Design menu item
187 - $widget: AccountSettingsNav instance being shown
189 StartAccountSettingsOtherMenuItem: Before showing the Other menu item
190 - $widget: AccountSettingsNav instance being shown
192 EndAccountSettingsOtherMenuItem: After showing the Other menu item
193 - $widget: AccountSettingsNav instance being shown
195 Autoload: When trying to autoload a class
196 - $cls: the class being sought. A plugin might require_once the file for the class.
198 SensitiveAction: determines if an action is 'sensitive' and should use SSL
199 - $action: name of the action, like 'login'
200 - $sensitive: flag for whether this is a sensitive action
202 LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
203 - $action: name of the action, like 'register'
204 - $login: flag for whether this is a login action
206 StartShowHead: called before showing the <head> element and children
207 - $action: action object being show
209 EndShowHead: called after showing the <head> element (and </head>)
210 - $action: action object being shown
212 StartShowBody: called before showing the <body> element and children
213 - $action: action object being shown
215 EndShowBody: called after showing the <body> element (and </body>)
216 - $action: action object being shown
218 StartPersonalGroupNav: beginning of personal group nav menu
219 - $menu: Menu list object being shown
220 - $target: Profile for whom it is shown
221 - $scoped: Profile of currently logged in user (or null)
223 EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
224 - $action: action object being shown
226 StartGroupGroupNav: Showing the group nav menu
227 - $action: the current action
229 EndGroupGroupNav: At the end of the group nav menu
230 - $action: the current action
232 StartEndHTML: just before the </html> tag
233 - $action: action object being shown
235 EndEndHTML: just after the </html> tag
236 - $action: action object being shown
238 FinalAction: After prepare() (and possible handle) in Action class.
239 - $status: result of "prepare" call on action
240 - $action: Action that is currently running
242 StartShowDesign: just before showing a site, user, or group design
243 - $action: action object being shown
245 EndShowDesign: just after showing a site, user, or group design
246 - $action: action object being shown
248 StartShowExportData: just before showing the <div> with export data (feeds)
249 - $action: action object being shown
251 EndShowExportData: just after showing the <div> with export data (feeds)
252 - $action: action object being shown
254 StartShowNoticeItem: just before showing the notice item
255 - $item: The NoticeListItem object being shown
257 EndShowNoticeItem: just after showing the notice item
258 - $item: the NoticeListItem object being shown
260 StartShowNoticeInfo: just before showing notice info
261 - $item: The NoticeListItem object being shown
263 EndShowNoticeInfo: just after showing notice info
264 - $item: The NoticeListItem object being shown
266 StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
267 - $item: the NoticeListItem object being shown
269 EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
270 - $item: the NoticeListItem object being shown
272 StartShowPageNotice: just before showing the page notice (instructions or error)
273 - $action: action object being shown
275 EndShowPageNotice: just after showing the page notice (instructions or error)
276 - $action: action object being shown
278 StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
279 - $action: action object being shown
281 StartProfileFormData: just before showing text entry fields on profile settings page
282 - $action: action object being shown
284 EndProfileFormData: just after showing text entry fields on profile settings page
285 - $action: action object being shown
287 StartProfileSaveForm: before starting to save a profile settings form
288 - $action: action object being shown
290 EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
291 - $action: action object being shown
293 StartEmailFormData: just before showing text entry fields on email settings page
294 - $action: action object being shown
296 EndEmailFormData: just after showing text entry fields on email settings page
297 - $action: action object being shown
299 StartEmailSaveForm: before starting to save a email settings form
300 - $action: action object being shown
301 - &$user: user being saved
303 EndEmailSaveForm: after saving a email settings form (after commit)
304 - $action: action object being shown
305 - &$user: user being saved
307 StartRegistrationFormData: just before showing text entry fields on registration page
308 - $action: action object being shown
310 EndRegistrationFormData: just after showing text entry fields on registration page
311 - $action: action object being shown
313 StartRegistrationTry: before validating and saving a new user
314 - $action: action object being shown
316 EndRegistrationTry: after saving a new user (note: no profile or user object!)
317 - $action: action object being shown
319 StartAvatarFormData: before displaying avatar form
320 - $action: action object being shown
322 EndAvatarFormData: after displaying avatar form
323 - $action: action object being shown
325 StartAvatarSaveForm: before saving the avatar
326 - $action: action object being shown
328 EndAvatarSaveForm: after saving the avatar
329 - $action: action object being shown
331 StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
332 - $qm: empty queue manager to set
334 RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
335 - $action: action object being shown
336 - $user: current user
338 StartLoadDoc: before loading a help doc (hook this to show your own documentation)
339 - $title: title of the document
340 - $output: HTML output to show
342 EndLoadDoc: after loading a help doc (hook this to modify other documentation)
343 - $title: title of the document
344 - $output: HTML output to show
346 StartApiRss: after the rss <channel> element is started
347 - $action: action object being shown
349 StartApiAtom: after the <feed> element is started
350 - $action: action object being shown
352 StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
353 - $notice: the notice being added
354 - &$transports: modifiable list of transports (as strings) to queue for
356 EndEnqueueNotice: after adding a notice to the queues
357 - $notice: the notice being added
358 - $transports: modifiable list of transports to use
360 UnqueueHandleNotice: Handle a notice when no queue manager is available
361 - $notice: the notice to handle
362 - $queue: the "queue" that is being executed
364 GetValidDaemons: Just before determining which daemons to run
365 - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
367 HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
368 - &$notice: notice to handle
370 StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
371 - $action: the current action
372 - &$attrs: attributes for the HTML element
374 EndHtmlElement: Right after outputting the HTML element
375 - $action: the current action
376 - &$attrs: attributes for the HTML element
378 StartShowHeadElements: Right after the <head> tag
379 - $action: the current action
381 EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
382 - $action: the current action
384 CheckSchema: chance to check the schema
386 StartProfileRemoteSubscribe: Before showing the link to remote subscription
387 - $userprofile: UserProfile widget
388 - &$profile: the profile being shown
390 EndProfileRemoteSubscribe: After showing the link to remote subscription
391 - $userprofile: UserProfile widget
392 - &$profile: the profile being shown
394 StartGroupSubscribe: Before showing the link to remote subscription
395 - $action: the current action
396 - $group: the group being shown
398 EndGroupSubscribe: After showing the link to remote subscription
399 - $action: the current action
400 - $group: the group being shown
402 StartProfilePageProfileSection: Starting to show the section of the
403 profile page with the actual profile data;
404 hook to prevent showing the profile (e.g.)
405 - $userprofile: UserProfile widget
406 - &$profile: the profile being shown
408 StartProfilePageProfileElements: inside the section, before the first
409 element; prepend elements here
410 - $userprofile: UserProfile widget
411 - &$profile: the profile being shown
413 EndProfilePageProfileElements: inside the section, after the last element;
415 - $userprofile: UserProfile widget
416 - &$profile: the profile being shown
418 EndProfilePageProfileSection: After showing the section of the profile
419 page with the profile elements
420 - $userprofile: UserProfile widget
421 - &$profile: the profile being shown
423 StartProfilePageActionsSection: Starting to show the section of the
424 profile page with action links; hook
425 to hide them (for example)
426 - $userprofile: UserProfile widget
427 - &$profile: the profile being shown
429 StartProfilePageActionsElements: inside the list, before the first
430 element; prepend elements here
431 - $userprofile: UserProfile widget
432 - &$profile: the profile being shown
434 EndProfilePageActionsElements: inside the list, after the last element;
436 - $userprofile: UserProfile widget
437 - &$profile: the profile being shown
439 EndProfilePageActionsSection: After showing the section of the profile
440 page with the entity actions
441 - $userprofile: UserProfile widget
442 - &$profile: the profile being shown
444 StartProfilePageAvatar: before showing the avatar on the profile page
445 - $userprofile: UserProfile widget
446 - &$profile: the profile being shown
448 EndProfilePageAvatar: after showing the avatar on the profile page
449 - $userprofile: UserProfile widget
450 - &$profile: the profile being shown
452 StartProfilePageNickname: before showing the nickname on the profile page
453 - $userprofile: UserProfile widget
454 - &$profile: the profile being shown
456 EndProfilePageNickname: after showing the nickname on the profile page
457 - $userprofile: UserProfile widget
458 - &$profile: the profile being shown
460 StartProfilePageFullName: before showing the fullname on the profile page
461 - $userprofile: UserProfile widget
462 - &$profile: the profile being shown
464 EndProfilePageFullName: after showing the fullname on the profile page
465 - $userprofile: UserProfile widget
466 - &$profile: the profile being shown
468 StartProfilePageLocation: before showing the location on the profile page
469 - $userprofile: UserProfile widget
470 - &$profile: the profile being shown
472 EndProfilePageLocation: after showing the location on the profile page
473 - $userprofile: UserProfile widget
474 - &$profile: the profile being shown
476 StartProfilePageHomepage: before showing the homepage link on the profile page
477 - $userprofile: UserProfile widget
478 - &$profile: the profile being shown
480 EndProfilePageHomepage: after showing the homepage on the profile page
481 - $userprofile: UserProfile widget
482 - &$profile: the profile being shown
484 StartProfilePageBio: before showing the bio on the profile page
485 - $userprofile: UserProfile widget
486 - &$profile: the profile being shown
488 EndProfilePageBio: after showing the bio on the profile page
489 - $userprofile: UserProfile widget
490 - &$profile: the profile being shown
492 StartProfilePageProfileTags: before showing the tags on the profile page
493 - $userprofile: UserProfile widget
494 - &$profile: the profile being shown
496 EndProfilePageProfileTags: after showing the tags on the profile page
497 - $userprofile: UserProfile widget
498 - &$profile: the profile being shown
500 StartProfileList: when starting a list of profiles (before <ul>)
501 - $profilelist: ProfileList widget, with $profile, $action, and $out
503 EndProfileList: when ending a list of profiles (after </ul>)
504 - $profilelist: ProfileList widget
506 StartProfileListItem: when starting to show a profile list item
507 - $item: ProfileListItem widget
509 EndProfileListItem: after showing a profile list item
510 - $item: ProfileListItem widget
512 StartProfileListItemProfile: the profile data part of the item
513 - $item: ProfileListItem widget
515 EndProfileListItemProfile: the profile data part of the item
516 - $item: ProfileListItem widget
518 StartProfileListItemActions: the actions (buttons) for an item
519 - $item: ProfileListItem widget
521 EndProfileListItemActions: the actions (buttons) for an item
522 - $item: ProfileListItem widget
524 StartProfileListItemProfileElements: inside the <div>
525 - $item: ProfileListItem widget
527 EndProfileListItemProfileElements: inside the <div>
528 - $item: ProfileListItem widget
530 StartProfileListItemAvatar: Showing a profile list avatar
531 - $item: ProfileListItem widget
533 EndProfileListItemAvatar: Showing a profile list avatar
534 - $item: ProfileListItem widget
536 StartProfileListItemFullName: Showing the profile list full name
537 - $item: ProfileListItem widget
539 EndProfileListItemFullName: Showing the profile list full name
540 - $item: ProfileListItem widget
542 StartProfileListItemLocation: Showing the profile list location
543 - $item: ProfileListItem widget
545 EndProfileListItemLocation: Showing the profile list location
546 - $item: ProfileListItem widget
548 StartProfileListItemHomepage: Showing the profile list homepage
549 - $item: ProfileListItem widget
551 EndProfileListItemHomepage: Showing the profile list homepage
552 - $item: ProfileListItem widget
554 StartProfileListItemBio: Showing the profile list bio
555 - $item: ProfileListItem widget
557 EndProfileListItemBio: Showing the profile list bio
558 - $item: ProfileListItem widget
560 StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
561 - $item: ProfileListItem widget
563 EndProfileListItemActionElements: Showing profile list actions (append a button here)
564 - $item: ProfileListItem widget
566 StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
567 - $action: the current action
568 - &$xrdsoutputter - XRDSOutputter object to write to
570 EndUserXRDS: End XRDS output (right before the closing XRDS tag)
571 - $action: the current action
572 - &$xrdsoutputter - XRDSOutputter object to write to
574 StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
575 - $action: the current action
576 - &$xrdsoutputter - XRDSOutputter object to write to
578 EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
579 - $action: the current action
580 - &$xrdsoutputter - XRDSOutputter object to write to
582 StartCheckPassword: Check a username/password
583 - $nickname: The nickname to check
584 - $password: The password to check
585 - &$authenticatedUser: set to User object if credentials match a user.
587 EndCheckPassword: After checking a username/password pair
588 - $nickname: The nickname that was checked
589 - $password: The password that was checked
590 - $authenticatedUser: User object if credentials match a user, else null.
592 StartChangePassword: Before changing a password
594 - $oldpassword: the user's old password
595 - $newpassword: the desired new password
597 EndChangePassword: After changing a password
600 StartHashPassword: Generate a hashed version of the password (like a salted crypt)
601 - &$hashed: Hashed version of the password, later put in the database
602 - $password: The password that should be hashed
603 - $profile: Profile that this password and hash belongs to. Can be null.
605 StartSetUser: Before setting the currently logged in user
608 EndSetUser: After setting the currently logged in user
611 StartSetApiUser: Before setting the current API user
614 EndSetApiUser: After setting the current API user
617 StartHasRole: Before determing if the a profile has a given role
618 - $profile: profile in question
619 - $name: name of the role in question
620 - &$has_role: does this profile have the named role?
622 EndHasRole: Before determing if the a profile has a given role
623 - $profile: profile in question
624 - $name: name of the role in question
625 - $has_role: does this profile have the named role?
627 UserDeleteRelated: Specify additional tables to delete entries from when deleting users
629 - &$related: array of DB_DataObject class names to delete entries on matching user_id.
631 GetUrlShorteners: Specify URL shorteners that are available for use
632 - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
634 StartShortenUrl: About to shorten a URL
635 - $url: url to be shortened
636 - $shortenerName: name of the requested shortener
637 - &$shortenedUrl: short version of the url
639 EndShortenUrl: After a URL has been shortened
640 - $url: url to be shortened
641 - $shortenerName: name of the requested shortener
642 - $shortenedUrl: short version of the url
644 StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
650 EndCssLinkElement: After a <link rel="stylesheet"..> element is written
656 StartStyleElement: Before a <style...> element is written
662 EndStyleElement: After a <style...> element is written
668 StartScriptElement: Before a <script...> element is written
673 EndScriptElement: After a <script...> element is written
678 StartInlineScriptElement: Before a <script...> element is written
683 EndInlineScriptElement: After a <script...> element is written
688 StartLog: Before writing to the logs
693 EndLog: After writing to the logs
698 StartBlockProfile: when we're about to block
699 - $user: the person doing the block
700 - $profile: the person getting blocked, can be remote
702 EndBlockProfile: when a block has succeeded
703 - $user: the person doing the block
704 - $profile: the person blocked, can be remote
706 StartUnblockProfile: when we're about to unblock
707 - $user: the person doing the unblock
708 - $profile: the person getting unblocked, can be remote
710 EndUnblockProfile: when an unblock has succeeded
711 - $user: the person doing the unblock
712 - $profile: the person unblocked, can be remote
714 StartSubscribe: when a subscription is starting
715 - $profile: Profile that is subscribing
716 - $other: Profile that is being subscribed to
718 EndSubscribe: when a subscription is finished
719 - $profile: Profile that is subscribing
720 - $other: Profile that is being subscribed to
722 StartUnsubscribe: when an unsubscribe is starting
723 - $profile: Profile that is unsubscribing
724 - $other: Profile that is being unsubscribed from
726 EndUnsubscribe: when an unsubscribe is done
727 - $profile: Profile that is unsubscribing
728 - $other: Profile that is being unsubscribed from
730 StartJoinGroup: when a user is joining a group
731 - $group: the group being joined
732 - $profile: the local or remote user joining
734 EndJoinGroup: when a user finishes joining a group
735 - $group: the group being joined
736 - $profile: the local or remote user joining
738 StartLeaveGroup: when a user is leaving a group
739 - $group: the group being left
740 - $profile: the local or remote user leaving
742 EndLeaveGroup: when a user has left a group
743 - $group: the group being left
744 - $profile: the local or remote user leaving
746 StartShowContentLicense: Showing the default license for content
747 - $action: the current action
749 EndShowContentLicense: Showing the default license for content
750 - $action: the current action
752 GetImTransports: Get IM transports that are available
753 - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
755 NormalizeImScreenname: Normalize an IM screenname
756 - $transport: transport the screenname is on
757 - &$screenname: screenname to be normalized
759 ValidateImScreenname: Validate an IM screenname
760 - $transport: transport the screenname is on
761 - $screenname: screenname to be validated
762 - $valid: is the screenname valid?
764 SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
765 - $transport: transport the screenname exists on
766 - $screenname: screenname being confirmed
767 - $code: confirmation code for confirmation URL
768 - $user: user requesting the confirmation
770 StartUserRegister: When a new user is being registered
771 - $profile: Profile object with new profile data (no ID yet)
773 EndUserRegister: When a new user has been registered
774 - $profile: Profile object with new profile data
776 StartRobotsTxt: Before outputting the robots.txt page
777 - &$action: RobotstxtAction being shown
779 EndRobotsTxt: After the default robots.txt page (good place for customization)
780 - &$action: RobotstxtAction being shown
782 StartGetProfileUri: When determining the canonical URI for a given profile
783 - $profile: the current profile
786 EndGetProfileUri: After determining the canonical URI for a given profile
787 - $profile: the current profile
790 StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
791 - $profile: Profile of user we want to get acct: URI for
792 - &$acct: string with the resulting acct: uri
794 EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
795 - $profile: Profile of user we want to get acct: URI for
796 - &$acct: string with the resulting acct: uri
798 StartFindMentions: start finding mentions in a block of text
799 - $sender: sender profile
800 - $text: plain text version of the notice
801 - &$mentions: mentions found so far. Array of arrays; each array
802 has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
803 'title' (title of the link), 'position' (position of the text to
804 replace), 'text' (text to replace)
806 EndFindMentions: end finding mentions in a block of text
807 - $sender: sender profile
808 - $text: plain text version of the notice
809 - &$mentions: mentions found so far. Array of arrays; each array
810 has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
811 'title' (title of the link), 'position' (position of the text to
812 replace), 'text' (text to replace)
814 StartShowSubscriptionsContent: before showing the subscriptions content
815 - $action: the current action
817 EndShowSubscriptionsContent: after showing the subscriptions content
818 - $action: the current action
820 StartShowUserGroupsContent: before showing the user groups content
821 - $action: the current action
823 EndShowUserGroupsContent: after showing the user groups content
824 - $action: the current action
826 StartShowAllContent: before showing the all (you and friends) content
827 - $action: the current action
829 EndShowAllContent: after showing the all (you and friends) content
830 - $action: the current action
832 StartShowSubscriptionsMiniList: at the start of subscriptions mini list
833 - $action: the current action
835 EndShowSubscriptionsMiniList: at the end of subscriptions mini list
836 - $action: the current action
838 StartShowGroupsMiniList: at the start of groups mini list
839 - $action: the current action
841 EndShowGroupsMiniList: at the end of groups mini list
842 - $action: the current action
844 StartDeleteUserForm: starting the data in the form for deleting a user
845 - $action: action being shown
846 - $user: user being deleted
848 EndDeleteUserForm: Ending the data in the form for deleting a user
849 - $action: action being shown
850 - $user: user being deleted
852 StartDeleteUser: handling the post for deleting a user
853 - $action: action being shown
854 - $user: user being deleted
856 EndDeleteUser: handling the post for deleting a user
857 - $action: action being shown
858 - $user: user being deleted
860 StartNoticeAsActivity: before converting a notice to an activity
861 - $notice: notice being converted
862 - &$activity: initially empty activity
864 EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
865 - $notice: notice being converted
866 - &$activity: activity, now more-or-less full
868 StartNoticeSaveWeb: before saving a notice through the Web interface
869 - $action: action being executed (instance of NewNoticeAction)
870 - &$authorId: integer ID of the author
871 - &$text: text of the notice
872 - &$options: additional options (location, replies, etc.)
874 EndNoticeSaveWeb: after saving a notice through the Web interface
875 - $action: action being executed (instance of NewNoticeAction)
876 - $notice: notice that was saved
878 StartRssEntryArray: at the start of copying a notice to an array
879 - $notice: the notice being copied
880 - &$entry: the entry (empty at beginning)
882 EndRssEntryArray: at the end of copying a notice to an array
883 - $notice: the notice being copied
884 - &$entry: the entry, with all the fields filled up
886 NoticeDeleteRelated: at the beginning of deleting related fields to a notice
887 - $notice: notice being deleted
889 FileDeleteRelated: at the beginning of deleting related fields to a File
890 - $notice: File being deleted
892 StartShowHeadTitle: when beginning to show the <title> element
893 - $action: action being shown
895 EndShowHeadTitle: when done showing the <title>
896 - $action: action being shown
898 StartShowPageTitle: when beginning to show the page title <h1>
899 - $action: action being shown
901 EndShowPageTitle: when done showing the page title <h1>
902 - $action: action being shown
904 StartDeleteOwnNotice: when a user starts to delete their own notice
905 - $user: the user doing the delete
906 - $notice: the notice being deleted
908 EndDeleteOwnNotice: when a user has deleted their own notice
909 - $user: the user doing the delete
910 - $notice: the notice being deleted
912 StartShowFeedLinkList: before showing the feed list in the sidebar
913 - $action: action being executed
914 - $feeds: list of feeds to show
916 EndShowFeedLinkList: after showing the feed list in the sidebar
917 - $action: action being executed
918 - $feeds: list of feeds shown
920 StartShowFeedLink: before showing an individual feed item
921 - $action: action being executed
922 - $feed: feed to show
924 EndShowFeedLink: after showing an individual feed
925 - $action: action being executed
926 - $feed: feed to show
928 StartShowNoticeForm: before showing the notice form (before <form>)
929 - $action: action being executed
931 EndShowNoticeForm: after showing the notice form (after <form>)
932 - $action: action being executed
934 StartShowEntryForms: microapp entry form tab data
935 - &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
937 StartGrantRole: when a role is being assigned
938 - $profile: profile that will have the role
939 - $role: string name of the role
941 EndGrantRole: when a role has been successfully assigned
942 - $profile: profile that will have the role
943 - $role: string name of the role
945 StartRevokeRole: when a role is being revoked
946 - $profile: profile that will lose the role
947 - $role: string name of the role
949 EndRevokeRole: when a role has been revoked
950 - $profile: profile that lost the role
951 - $role: string name of the role
953 StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
954 - &$activity: received activity
955 - $user: user publishing the entry
956 - &$notice: notice created; initially null, can be set
958 EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
959 - $activity: received activity
960 - $user: user publishing the entry
961 - $notice: notice that was created
963 AdminPanelCheck: When checking whether the current user can access a given admin panel
964 - $name: Name of the admin panel
965 - &$isOK: Boolean whether the user is allowed to use the panel
967 StartAdminPanelNav: Before displaying the first item in the list of admin panels
968 - $nav The AdminPanelNav widget
970 EndAdminPanelNav: After displaying the last item in the list of admin panels
971 - $nav The AdminPanelNav widget
973 StartActivityObjectFromNotice: When converting a notice to an activity:object
974 - $notice: The notice being converted
975 - &$object: The resulting object. Fill this and return false to override defaults.
977 EndActivityObjectFromNotice: After converting a notice to an activity:object
978 - $notice: The notice being converted
979 - &$object: The resulting object. Can be edited
981 StartActivityObjectFromProfile: When converting a profile to an activity:object
982 - $profile: The profile being converted
983 - &$object: The (empty) object. Fill it up and return false to override defaults.
985 EndActivityObjectFromProfile: After converting a profile to an activity:object
986 - $profile: The profile being converted
987 - &$object: The finished object. Can be tweaked
989 StartActivityObjectFromGroup: When converting a group to an activity:object
990 - $group: The group being converted
991 - &$object: The (empty) object. Fill and return false to override.
993 EndActivityObjectFromGroup: After converting a group to an activity:object
994 - $group: The group being converted
995 - &$object: The finished object. Tweak as needed.
997 StartImportActivity: when we start to import an activity
998 - $user: User to make the author import
999 - $author: Author of the feed; good for comparisons
1000 - $activity: The current activity
1001 - $trusted: How "trusted" the process is
1002 - &$done: Return value; whether to continue
1004 EndImportActivity: when we finish importing an activity
1005 - $user: User to make the author import
1006 - $author: Author of the feed; good for comparisons
1007 - $activity: The current activity
1008 - $trusted: How "trusted" the process is
1010 StartProfileSettingsActions: when we're showing account-management action list
1011 - $action: Action being shown (use for output)
1013 EndProfileSettingsActions: when we're showing account-management action list
1014 - $action: Action being shown (use for output)
1016 StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
1017 - $nli: The notice list item being shown
1019 EndOpenNoticeListItemElement: After the opening <li> of a notice list element
1020 - $nli: The notice list item being shown
1022 StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
1023 - $nli: The notice list item being shown
1025 EndCloseNoticeListItemElement: After the closing </li> of a notice list element
1026 - $nli: The notice list item being shown
1028 StartGroupEditFormData: Beginning the group edit form entries
1029 - $form: The form widget being shown
1031 EndGroupEditFormData: Ending the group edit form entries
1032 - $form: The form widget being shown
1034 StartGroupSave: After initializing but before saving a group
1035 - &$group: group about to be saved
1037 EndGroupSave: After saving a group, aliases, and first member
1038 - $group: group that was saved
1040 StartInterpretCommand: Before running a command
1041 - $cmd: First word in the string, 'foo' in 'foo argument'
1042 - $arg: Argument, if any, like 'argument' in 'foo argument'
1043 - $user: User who issued the command
1044 - &$result: Resulting command; you can set this!
1046 EndInterpretCommand: Before running a command
1047 - $cmd: First word in the string, 'foo' in 'foo argument'
1048 - $arg: Argument, if any, like 'argument' in 'foo argument'
1049 - $user: User who issued the command
1050 - $result: Resulting command
1052 StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
1053 - $action: action being executed (for output and params)
1054 - $group: group for the page
1056 EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
1057 - $action: action being executed (for output and params)
1058 - $group: group for the page
1060 StartGroupProfileElements: Start showing stuff about the group on its profile page
1061 - $action: action being executed (for output and params)
1062 - $group: group for the page
1064 EndGroupProfileElements: Start showing stuff about the group on its profile page
1065 - $action: action being executed (for output and params)
1066 - $group: group for the page
1068 StartShowProfileTagContent: When showing a people tag page
1069 - $action: action being executed (for output and params)
1071 EndShowProfileTagContent: After showing the contents of a people tag page
1072 - $action: action being executed (for output and params)
1074 StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
1075 - $action: action being executed (for output and params)
1077 EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
1078 - $action: action being executed (for output and params)
1080 StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
1081 - $action: action being executed (for output and params)
1083 EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
1084 - $action: action being executed (for output and params)
1086 StartTagProfileAction: When starting to show profile tagging page
1087 - $action: action being executed (for output and params)
1088 - $profile: profile being tagged
1090 EndTagProfileAction: After showing profile tagging page
1091 - $action: action being executed (for output and params)
1092 - $profile: profile being tagged
1094 StartProfileCompletionSearch: When starting a profile search for autocompletion
1095 - $action: action being executed (for output and params)
1096 - &$profile: result Profile objects
1097 - $search_engine: the search engine
1099 EndProfileCompletionSearch: After search results for profile autocompletion have been found
1100 - $action: profilec completion action
1101 - &$profile: current result Profile objects
1102 - $search_engine: The search engine object
1104 StartShowTagProfileForm: When showing people tagging form
1105 - $action: action being executed (for output and params)
1106 - $profile: profile being tagged
1108 EndShowTagProfileForm: After showing people tagging form
1109 - $action: action being executed (for output and params)
1110 - $profile: profile being tagged
1112 StartSavePeopletags: When starting to save people tags
1113 - $action: action being executed (for output and params)
1114 - $tagstring: string input, a list of tags
1116 EndSavePeopletags: After saving people tags
1117 - $action: action being executed (for output and params)
1118 - $tagstring: string input, a list of tags
1120 StartProfiletagGetUri: when generating the Uri for a people tag
1121 - $profile_list: the people tag, a Profile_list object
1124 EndProfiletagGetUri: after generating the uri for a people tag
1125 - $profile_list: the people tag, a Profile_list object
1128 StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
1129 - $profile_list: the people tag, a Profile_list object
1132 EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
1133 - $profile_list: the people tag, a Profile_list object
1136 StartProfiletagPermalink: when generating the permalink url for a people tag
1137 - $profile_list: the people tag, a Profile_list object
1140 EndProfiletagPermalink: after generating the permalink url for a people tag
1141 - $profile_list: the people tag, a Profile_list object
1144 StartTagProfile: when tagging a profile
1145 - $tagger: profile tagging
1146 - $tagged: profile being tagged
1149 EndTagProfile: after tagging a profile
1150 - $newtag: the newly created Profile_tag object
1152 StartUntagProfile: when deleting a people tag
1153 - $ptag: the Profile_tag object being deleted
1155 EndUntagProfile: after deleting a people tag
1156 - $orig: a copy of the deleted Profile_tag object
1158 StartSubscribePeopletag: when subscribing to a people tag
1159 - $peopletag: Profile_list object being subscribed to
1160 - $profile: subscriber's profile
1162 EndSubscribePeopletag: after subscribing to a people tag
1163 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1164 - $profile: subscriber's profile
1166 StartUnsubscribePeopletag: when unsubscribing to a people tag
1167 - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
1168 - $profile: subscriber's profile
1170 EndUnsubscribePeopletag: after unsubscribing to a people tag
1171 - $peopletag: Profile_list object being subscribed to
1172 - $profile: subscriber's profile
1174 StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
1175 - $profile_list: the people tag, a Profile_list object
1176 - &$object: activity object
1178 EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
1179 - $profile_list: the people tag, a Profile_list object
1180 - &$object: activity object
1182 StartPeopletagGroupNav: Showing the people tag nav menu
1183 - $menu: the menu widget; use $menu->action for output
1185 EndPeopletagGroupNav: after showing the people tag nav menu
1186 - $menu: the menu widget; use $menu->action for output
1188 StartShowPeopletagItem: when showing a people tag
1189 - $widget: PeopletagListItem widget
1191 EndShowPeopletagItem: after showing a people tag
1192 - $widget: PeopletagListItem widget
1194 StartSubscribePeopletagForm: when showing people tag subscription form
1195 - $action: action being executed (for output and params)
1196 - $peopletag: people tag being subscribed to
1198 EndSubscribePeopletagForm: after showing the people tag subscription form
1199 - $action: action being executed (for output and params)
1200 - $peopletag: people tag being subscribed to
1202 StartShowPeopletags: when showing a textual list of people tags
1203 - $widget: PeopletagsWidget; use $widget->out for output
1204 - $tagger: profile of the tagger
1205 - $tagged: profile tagged
1207 EndShowPeopletags: after showing a textual list of people tags
1208 - $widget: PeopletagsWidget; use $widget->out for output
1209 - $tagger: profile of the tagger
1210 - $tagged: profile tagged
1212 StartProfileListItemTags: when showing people tags in a profile list item widget
1213 - $widget: ProfileListItem widget
1215 EndProfileListItemTags: after showing people tags in a profile list item widget
1216 - $widget: ProfileListItem widget
1218 StartActivityObjectOutputAtom: Called at start of Atom XML output generation for ActivityObject chunks, just inside the <activity:object>. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
1219 - $obj: ActivityObject
1220 - $out: XMLOutputter to append custom output
1222 EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
1223 - $obj: ActivityObject
1224 - $out: XMLOutputter to append custom output
1226 StartActivityObjectOutputJson: Called at start of JSON output generation for ActivityObject chunks: the array has not yet been filled out. Cancel the event to take over its output completely (you're responsible for calling the matching End event if so)
1227 - $obj ActivityObject
1228 - &$out: array to be serialized; you're free to modify it
1230 EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
1231 - $obj ActivityObject
1232 - &$out: array to be serialized; you're free to modify it
1234 StartNoticeWhoGets: Called at start of inbox delivery prep; plugins can schedule notices to go to particular profiles that would otherwise not have reached them. Canceling will take over the entire addressing operation. Be aware that output can be cached or used several times, so should remain idempotent.
1236 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1238 EndNoticeWhoGets: Called at end of inbox delivery prep; plugins can filter out profiles from receiving inbox delivery here. Be aware that output can be cached or used several times, so should remain idempotent.
1240 - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
1242 StartDefaultLocalNav: When showing the default local nav
1244 - $user: current user
1246 EndDefaultLocalNav: When showing the default local nav
1248 - $user: current user
1250 StartShowAccountProfileBlock: When showing the profile block for an account
1251 - $out: XMLOutputter to append custom output
1252 - $profile: the profile being shown
1254 EndShowAccountProfileBlock: After showing the profile block for an account
1255 - $out: XMLOutputter to append custom output
1256 - $profile: the profile being shown
1258 StartShowGroupProfileBlock: When showing the profile block for a group
1259 - $out: XMLOutputter to append custom output
1260 - $profile: the profile being shown
1262 EndShowGroupProfileBlock: After showing the profile block for a group
1263 - $out: XMLOutputter to append custom output
1264 - $group: the group being shown
1266 StartShowConversation: start the listing of a conversation
1267 - $action: Action object (used mainly as HTMLOutputter)
1268 - $conv: Conversation object, has functions to retrieve relevant notices
1269 - $scoped: Profile for scoping (null if not logged in)
1271 EndShowConversation: after the listing of a conversation
1272 - $action: Action object (used mainly as HTMLOutputter)
1273 - $conv: Conversation object, has functions to retrieve relevant notices
1274 - $scoped: Profile for scoping (null if not logged in)
1276 StartShowThreadedNoticeTail: when showing the replies etc. to a notice
1277 - $nli: parent noticelistitem
1278 - $notice: parent notice
1279 - &$children: list of children
1281 EndShowThreadedNoticeTail: when showing the replies etc. to a notice
1282 - $nli: parent noticelistitem
1283 - $notice: parent notice
1284 - $children: list of children
1286 StartShowThreadedNoticeSub: when showing a reply to a notice
1287 - $nli: parent noticelistitem
1288 - $parent: parent notice
1289 - $child: child notice
1291 EndShowThreadedNoticeSub: when showing a reply to a notice
1292 - $nli: parent noticelistitem
1293 - $parent: parent notice
1294 - $child: child notice
1296 StartAddEmailAddress: when adding an email address through the Web UI
1297 - $user: user getting the new address
1298 - $email: email being added
1300 EndAddEmailAddress: done adding an email address through the Web UI
1301 - $user: user getting the new address
1302 - $email: email being added
1304 StartValidateEmailInvite: when validating an email address for invitations
1305 - $user: user doing the invite
1306 - $email: email address
1307 - &$valid: flag for if it's valid; can be modified
1309 EndValidateEmailInvite: after validating an email address for invitations
1310 - $user: user doing the invite
1311 - $email: email address
1312 - &$valid: flag for if it's valid; can be modified
1314 StartLocalURL: before resolving a local url for an action
1315 - &$action: action to find a path for
1316 - &$paramsi: parameters to pass to the action
1317 - &$fragment: any url fragement
1318 - &$addSession: whether to add session variable
1319 - &$url: resulting URL to local resource
1321 EndLocalURL: before resolving a local url for an action
1322 - &$action: action to find a path for
1323 - &$paramsi: parameters to pass to the action
1324 - &$fragment: any url fragement
1325 - &$addSession: whether to add session variable
1326 - &$url: resulting URL to local resource
1328 StartProfileGetAvatar: When getting an avatar for a profile
1330 - $size: size of the avatar
1333 EndProfileGetAvatar: After getting an avatar for a profile
1335 - $size: size of the avatar
1338 StartRegisterSuccess: Before showing the registration success message
1339 - $action: the registration action
1341 StartRegisterSuccess: After showing the registration success message
1342 - $action: the registration action
1344 StartDocFileForTitle: Before searching for a doc or mail template
1345 - $title: Title we're looking for
1346 - &$paths: Paths we're searching
1347 - &$filename: Filename so far (set this if you want)
1349 EndDocFileForTitle: After searching for a doc or mail template
1350 - $title: Title we looked for
1351 - $paths: Paths we searched
1352 - &$filename: Filename so far (set this if you want)
1354 StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
1355 - &$tables: list of table names
1356 - &$rwdb: read-write database URI
1358 EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
1359 - $tables: list of table names
1360 - $rwdb: read-write database URI
1362 StartShowInviteForm: Right before displaying the invitations form
1363 - $action: invitation action
1365 EndShowInviteForm: After displaying the invitations form
1366 - $action: invitation action
1368 StartSendInvitations: Right before sending invitations
1369 - $action: invitation action
1371 EndSendInvitations: Right after sending invitations
1372 - $action: invitation action
1374 StartShowInvitationSuccess: Right before showing invitations success msg
1375 - $action: invitation action
1377 EndShowInvitationSuccess: After showing invitations success msg
1378 - $action: invitation action
1380 StartUpgrade: when starting a site upgrade
1382 EndUpgrade: when ending a site upgrade; good place to do your own upgrades
1384 HaveIMPlugin: is there an IM plugin loaded?
1385 - &$haveIMPlugin: set me to true if you're loaded!
1387 StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
1388 - $nli: NoticeListItem being shown
1390 EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
1391 - $nli: NoticeListItem being shown
1393 StartNoticeInScope: Before checking if a notice should be visible to a user
1394 - $notice: The notice to check
1395 - $profile: The profile to check for scope
1396 - &$bResult: The boolean result; fill this in if you want to skip
1398 EndNoticeInScope: After checking if a notice should be visible to a user
1399 - $notice: The notice to check
1400 - $profile: The profile to check for scope
1401 - &$bResult: The boolean result; overwrite this if you so desire
1403 StartNoticeListPrefill: Before pre-filling a list of notices with extra data
1404 - &$notices: Notices to be pre-filled
1405 - $avatarSize: The avatar size for the list
1407 EndNoticeListPrefill: After pre-filling a list of notices with extra data
1408 - &$notices: Notices that were pre-filled
1409 - &$profiles: Profiles that were pre-filled
1410 - $avatarSize: The avatar size for the list
1412 OtherAccountProfiles: Hook to add account profiles to a user account profile block
1413 - $profile: the Profile being shown
1414 - &$others: Modifiable array of profile info arrays. Each one has the following fields:
1415 href: link to the profile
1416 text: text for the profile
1417 image: mini image for the profile
1419 CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
1420 - $file: 'File' object to source the image from
1421 - &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
1422 - $media: MIME media type ('image', 'video', 'audio' etc.)
1424 StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
1425 - $imagefile: ImageFile object we're resizing.
1426 - $outpath: string with output filepath
1427 - $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
1429 StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1430 - $out: HTMLOutputter class to use for outputting HTML.
1431 - $file: 'File' object which we're going to show representation for.
1433 EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
1434 - $out: HTMLOutputter class to use for outputting HTML.
1435 - $file: 'File' object which we're going to show representation for.
1437 ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
1438 - $out: HTMLOutputter class to use for outputting HTML.
1439 - $file: 'File' object which we're going to show representation for.