EVENTS.txt 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466
  1. InitializePlugin: a chance to initialize a plugin in a complete environment
  2. CleanupPlugin: a chance to cleanup a plugin at the end of a program
  3. StartPrimaryNav: Showing the primary nav menu
  4. - $action: the current action
  5. EndPrimaryNav: At the end of the primary nav menu
  6. - $action: the current action
  7. StartSecondaryNav: Showing the secondary nav menu
  8. - $action: the current action
  9. EndSecondaryNav: At the end of the secondary nav menu
  10. - $action: the current action
  11. StartShowStyles: Showing Style links; good place to add UA style resets
  12. - $action: the current action
  13. EndShowStyles: End showing Style links; good place to add custom styles
  14. - $action: the current action
  15. StartShowStylesheets: Showing stylesheet links
  16. - $action: the current action
  17. EndShowStylesheets: End showing stylesheet links; good place to add handheld or JavaScript dependant styles
  18. - $action: the current action
  19. StartShowUAStyles: Showing custom User-Agent style links
  20. - $action: the current action
  21. EndShowUAStyles: End showing custom User-Agent links; good place to add user-agent (e.g., filter, -webkit, -moz) specific styles
  22. - $action: the current action
  23. StartShowScripts: Showing JavaScript links
  24. - $action: the current action
  25. EndShowScripts: End showing JavaScript links; good place to add custom
  26. links like Google Analytics
  27. - $action: the current action
  28. StartShowJQueryScripts: Showing JQuery script links (use this to link to e.g. Google mirrors)
  29. - $action: the current action
  30. EndShowJQueryScripts: End showing JQuery script links
  31. - $action: the current action
  32. StartShowStatusNetScripts: Showing StatusNet script links (use this to link to a CDN or something)
  33. - $action: the current action
  34. EndShowStatusNetScripts: End showing StatusNet script links
  35. - $action: the current action
  36. StartShowSections: Start the list of sections in the sidebar
  37. - $action: the current action
  38. EndShowSections: End the list of sections in the sidebar
  39. - $action: the current action
  40. StartShowHeader: Showing before the header container
  41. - $action: the current action
  42. EndShowHeader: Showing after the header container
  43. - $action: the current action
  44. StartShowFooter: Showing before the footer container
  45. - $action: the current action
  46. EndShowFooter: Showing after the footer container
  47. - $action: the current action
  48. StartShowContentBlock: Showing before the content container
  49. - $action: the current action
  50. EndShowContentBlock: Showing after the content container
  51. - $action: the current action
  52. StartShowAside: Showing before the Aside container
  53. - $action: the current action
  54. EndShowAside: Showing after the Aside container
  55. - $action: the current action
  56. StartShowNoticeFormData: Showing before the notice form data
  57. - $action: the current action
  58. EndShowNoticeFormData: Showing after the notice form data
  59. - $action: the current action
  60. StartNoticeSave: before inserting a notice (good place for content filters)
  61. - $notice: notice being saved (no ID or URI)
  62. EndNoticeSave: after inserting a notice and related code
  63. - $notice: notice that was saved (with ID and URI)
  64. StartShowLocalNavBlock: Showing the local nav menu
  65. - $action: the current action
  66. EndShowLocalNavBlock: At the end of the local nav menu
  67. - $action: the current action
  68. StartShowHTML: Chance to set document headers (e.g., content type, charset, language), DOCTYPE and html element properties
  69. - $action: the current action
  70. EndShowHTML: Showing after the html element
  71. - $action: the current action
  72. StartPublicGroupNav: Showing the public group nav menu
  73. - $menu: the menu widget; use $menu->action for output
  74. EndPublicGroupNav: At the end of the public group nav menu
  75. - $menu: the menu widget; use $menu->action for output
  76. StartSubGroupNav: Showing the subscriptions group nav menu
  77. - $menu: the menu widget; use $menu->action for output
  78. EndSubGroupNav: At the end of the subscriptions group nav menu
  79. - $menu: the menu widget; use $menu->action for output
  80. StartInitializeRouter: Before the router instance has been initialized; good place to add routes
  81. - $m: the Net_URL_Mapper that has just been set up
  82. RouterInitialized: After the router instance has been initialized
  83. - $m: the Net_URL_Mapper that has just been set up
  84. StartLogout: Before logging out
  85. - $action: the logout action
  86. EndLogout: After logging out
  87. - $action: the logout action
  88. ArgsInitialize: After the argument array has been initialized
  89. - $args: associative array of arguments, can be modified
  90. StartAddressData: Allows the site owner to provide additional information about themselves for contact (e.g., tagline, email, location)
  91. - $action: the current action
  92. EndAddressData: At the end of <address>
  93. - $action: the current action
  94. StartShowSiteNotice: Before showing site notice
  95. - $action: the current action
  96. EndShowSiteNotice: After showing site notice
  97. - $action: the current action
  98. StartLoginGroupNav: Before showing the login and register navigation menu
  99. - $action: the current action
  100. EndLoginGroupNav: After showing the login and register navigation menu
  101. - $action: the current action
  102. StartAccountSettingsNav: Before showing the account settings menu
  103. - $action: the current action
  104. EndAccountSettingsNav: After showing the account settings menu
  105. - $action: the current action
  106. StartAccountSettingsProfileMenuItem: Before showing the Profile menu item
  107. - $widget: AccountSettingsNav instance being shown
  108. EndAccountSettingsProfileMenuItem: After showing the Profile menu item
  109. - $widget: AccountSettingsNav instance being shown
  110. StartAccountSettingsAvatarMenuItem: Before showing the Avatar menu item
  111. - $widget: AccountSettingsNav instance being shown
  112. EndAccountSettingsAvatarMenuItem: After showing the Avatar menu item
  113. - $widget: AccountSettingsNav instance being shown
  114. StartAccountSettingsPasswordMenuItem: Before showing the Password menu item
  115. - $widget: AccountSettingsNav instance being shown
  116. EndAccountSettingsPasswordMenuItem: After showing the Password menu item
  117. - $widget: AccountSettingsNav instance being shown
  118. StartAccountSettingsEmailMenuItem: Before showing the Email menu item
  119. - $widget: AccountSettingsNav instance being shown
  120. EndAccountSettingsEmailMenuItem: After showing the Email menu item
  121. - $widget: AccountSettingsNav instance being shown
  122. StartAccountSettingsDesignMenuItem: Before showing the Design menu item
  123. - $widget: AccountSettingsNav instance being shown
  124. EndAccountSettingsDesignMenuItem: After showing the Design menu item
  125. - $widget: AccountSettingsNav instance being shown
  126. StartAccountSettingsOtherMenuItem: Before showing the Other menu item
  127. - $widget: AccountSettingsNav instance being shown
  128. EndAccountSettingsOtherMenuItem: After showing the Other menu item
  129. - $widget: AccountSettingsNav instance being shown
  130. Autoload: When trying to autoload a class
  131. - $cls: the class being sought. A plugin might require_once the file for the class.
  132. SensitiveAction: determines if an action is 'sensitive' and should use SSL
  133. - $action: name of the action, like 'login'
  134. - $sensitive: flag for whether this is a sensitive action
  135. LoginAction: determines if an action is a 'login' action (OK for public view in private mode)
  136. - $action: name of the action, like 'register'
  137. - $login: flag for whether this is a login action
  138. StartShowHead: called before showing the <head> element and children
  139. - $action: action object being show
  140. EndShowHead: called after showing the <head> element (and </head>)
  141. - $action: action object being shown
  142. StartShowBody: called before showing the <body> element and children
  143. - $action: action object being shown
  144. EndShowBody: called after showing the <body> element (and </body>)
  145. - $action: action object being shown
  146. StartPersonalGroupNav: beginning of personal group nav menu
  147. - $menu: Menu list object being shown
  148. - $target: Profile for whom it is shown
  149. - $scoped: Profile of currently logged in user (or null)
  150. EndPersonalGroupNav: end of personal group nav menu (good place to add a menu item)
  151. - $action: action object being shown
  152. StartGroupGroupNav: Showing the group nav menu
  153. - $action: the current action
  154. EndGroupGroupNav: At the end of the group nav menu
  155. - $action: the current action
  156. StartEndHTML: just before the </html> tag
  157. - $action: action object being shown
  158. EndEndHTML: just after the </html> tag
  159. - $action: action object being shown
  160. FinalAction: After prepare() (and possible handle) in Action class.
  161. - $status: result of "prepare" call on action
  162. - $action: Action that is currently running
  163. StartShowDesign: just before showing a site, user, or group design
  164. - $action: action object being shown
  165. EndShowDesign: just after showing a site, user, or group design
  166. - $action: action object being shown
  167. StartShowExportData: just before showing the <div> with export data (feeds)
  168. - $action: action object being shown
  169. EndShowExportData: just after showing the <div> with export data (feeds)
  170. - $action: action object being shown
  171. StartShowNoticeItem: just before showing the notice item
  172. - $item: The NoticeListItem object being shown
  173. EndShowNoticeItem: just after showing the notice item
  174. - $item: the NoticeListItem object being shown
  175. StartShowNoticeItemNotice: just before outputting the "top" notice part of a NoticeListItem to HTML
  176. - $item: The NoticeListItem object being shown
  177. EndShowNoticeItemNotice: just after outputting the "top" notice part of a NoticeListItem to HTML
  178. - $item: The NoticeListItem object being shown
  179. StartShowNoticeContent: just before outputting the content part of a Notice
  180. - $stored: The Notice object
  181. - $out: HTMLOutputter for writing to
  182. - $scoped: optional Profile object for permission scoping
  183. EndShowNoticeContent: just after outputting the content part of a Notice, plugins must call this manually
  184. - $stored: The Notice object
  185. - $out: HTMLOutputter for writing to
  186. - $scoped: optional Profile object for permission scoping
  187. StartShowNoticeInfo: just before showing notice info
  188. - $item: The NoticeListItem object being shown
  189. EndShowNoticeInfo: just after showing notice info
  190. - $item: The NoticeListItem object being shown
  191. StartShowNoticeOptions: just before showing notice options like fave, repeat, etc.
  192. - $item: the NoticeListItem object being shown
  193. EndShowNoticeOptions: just after showing notice options like fave, repeat, etc.
  194. - $item: the NoticeListItem object being shown
  195. StartShowPageNotice: just before showing the page notice (instructions or error)
  196. - $action: action object being shown
  197. EndShowPageNotice: just after showing the page notice (instructions or error)
  198. - $action: action object being shown
  199. StartShowPageTitle: just before showing the main h1 title of a page (only for registration)
  200. - $action: action object being shown
  201. StartProfileFormData: just before showing text entry fields on profile settings page
  202. - $action: action object being shown
  203. EndProfileFormData: just after showing text entry fields on profile settings page
  204. - $action: action object being shown
  205. StartProfileSaveForm: before starting to save a profile settings form
  206. - $action: action object being shown
  207. EndProfileSaveForm: after saving a profile settings form (after commit, no profile or user object!)
  208. - $action: action object being shown
  209. StartEmailFormData: just before showing form input fields on email settings page
  210. - $action: Action object being shown
  211. - $scoped: Profile for whom settings are being configured
  212. EndEmailFormData: just after showing form input fields on email settings page
  213. - $action: action object being shown
  214. - $scoped: Profile for whom settings are being configured
  215. StartEmailSaveForm: before starting to save a email settings form
  216. - $action: action object being shown
  217. - $scoped: Profile user having their email settings saved
  218. EndEmailSaveForm: after saving a email settings form (after commit)
  219. - $action: action object being shown
  220. - $scoped: Profile user having their email settings saved
  221. StartRegistrationFormData: just before showing text entry fields on registration page
  222. - $action: action object being shown
  223. EndRegistrationFormData: just after showing text entry fields on registration page
  224. - $action: action object being shown
  225. StartRegistrationTry: before validating and saving a new user
  226. - $action: action object being shown
  227. EndRegistrationTry: after saving a new user (note: no profile or user object!)
  228. - $action: action object being shown
  229. StartAvatarFormData: before displaying avatar form
  230. - $action: action object being shown
  231. EndAvatarFormData: after displaying avatar form
  232. - $action: action object being shown
  233. StartAvatarSaveForm: before saving the avatar
  234. - $action: action object being shown
  235. EndAvatarSaveForm: after saving the avatar
  236. - $action: action object being shown
  237. StartNewQueueManager: before trying to start a new queue manager; good for plugins implementing new queue manager classes
  238. - $qm: empty queue manager to set
  239. RedirectToLogin: event when we force a redirect to login (like when going to a settings page on a remembered login)
  240. - $action: action object being shown
  241. - $user: current user
  242. StartLoadDoc: before loading a help doc (hook this to show your own documentation)
  243. - $title: title of the document
  244. - $output: HTML output to show
  245. EndLoadDoc: after loading a help doc (hook this to modify other documentation)
  246. - $title: title of the document
  247. - $output: HTML output to show
  248. StartApiRss: after the rss <channel> element is started
  249. - $action: action object being shown
  250. StartApiAtom: after the <feed> element is started
  251. - $action: action object being shown
  252. StartEnqueueNotice: about to add a notice to the queues (good place to add a new transport)
  253. - $notice: the notice being added
  254. - &$transports: modifiable list of transports (as strings) to queue for
  255. EndEnqueueNotice: after adding a notice to the queues
  256. - $notice: the notice being added
  257. - $transports: modifiable list of transports to use
  258. UnqueueHandleNotice: Handle a notice when no queue manager is available
  259. - $notice: the notice to handle
  260. - $queue: the "queue" that is being executed
  261. GetValidDaemons: Just before determining which daemons to run
  262. - &$daemons: modifiable list of daemon scripts to run, filenames relative to scripts/
  263. HandleQueuedNotice: Handle a queued notice at queue time (or immediately if no queue)
  264. - &$notice: notice to handle
  265. StartHtmlElement: Reight before outputting the HTML element - allows plugins to add namespaces
  266. - $action: the current action
  267. - &$attrs: attributes for the HTML element
  268. EndHtmlElement: Right after outputting the HTML element
  269. - $action: the current action
  270. - &$attrs: attributes for the HTML element
  271. StartShowHeadElements: Right after the <head> tag
  272. - $action: the current action
  273. EndShowHeadElements: Right before the </head> tag; put <script>s here if you need them in <head>
  274. - $action: the current action
  275. CheckSchema: chance to check the schema
  276. StartProfileRemoteSubscribe: Before showing the link to remote subscription
  277. - $userprofile: UserProfile widget
  278. - &$profile: the profile being shown
  279. EndProfileRemoteSubscribe: After showing the link to remote subscription
  280. - $userprofile: UserProfile widget
  281. - &$profile: the profile being shown
  282. StartGroupSubscribe: Before showing the link to remote subscription
  283. - $action: the current action
  284. - $group: the group being shown
  285. EndGroupSubscribe: After showing the link to remote subscription
  286. - $action: the current action
  287. - $group: the group being shown
  288. StartProfilePageProfileSection: Starting to show the section of the
  289. profile page with the actual profile data;
  290. hook to prevent showing the profile (e.g.)
  291. - $userprofile: UserProfile widget
  292. - &$profile: the profile being shown
  293. StartProfilePageProfileElements: inside the section, before the first
  294. element; prepend elements here
  295. - $userprofile: UserProfile widget
  296. - &$profile: the profile being shown
  297. EndProfilePageProfileElements: inside the section, after the last element;
  298. append elements here
  299. - $userprofile: UserProfile widget
  300. - &$profile: the profile being shown
  301. EndProfilePageProfileSection: After showing the section of the profile
  302. page with the profile elements
  303. - $userprofile: UserProfile widget
  304. - &$profile: the profile being shown
  305. StartProfilePageActionsSection: Starting to show the section of the
  306. profile page with action links; hook
  307. to hide them (for example)
  308. - $userprofile: UserProfile widget
  309. - &$profile: the profile being shown
  310. StartProfilePageActionsElements: inside the list, before the first
  311. element; prepend elements here
  312. - $userprofile: UserProfile widget
  313. - &$profile: the profile being shown
  314. EndProfilePageActionsElements: inside the list, after the last element;
  315. append elements here
  316. - $userprofile: UserProfile widget
  317. - &$profile: the profile being shown
  318. EndProfilePageActionsSection: After showing the section of the profile
  319. page with the entity actions
  320. - $userprofile: UserProfile widget
  321. - &$profile: the profile being shown
  322. StartProfilePageAvatar: before showing the avatar on the profile page
  323. - $userprofile: UserProfile widget
  324. - &$profile: the profile being shown
  325. EndProfilePageAvatar: after showing the avatar on the profile page
  326. - $userprofile: UserProfile widget
  327. - &$profile: the profile being shown
  328. StartProfilePageNickname: before showing the nickname on the profile page
  329. - $userprofile: UserProfile widget
  330. - &$profile: the profile being shown
  331. EndProfilePageNickname: after showing the nickname on the profile page
  332. - $userprofile: UserProfile widget
  333. - &$profile: the profile being shown
  334. StartProfilePageFullName: before showing the fullname on the profile page
  335. - $userprofile: UserProfile widget
  336. - &$profile: the profile being shown
  337. EndProfilePageFullName: after showing the fullname on the profile page
  338. - $userprofile: UserProfile widget
  339. - &$profile: the profile being shown
  340. StartProfilePageLocation: before showing the location on the profile page
  341. - $userprofile: UserProfile widget
  342. - &$profile: the profile being shown
  343. EndProfilePageLocation: after showing the location on the profile page
  344. - $userprofile: UserProfile widget
  345. - &$profile: the profile being shown
  346. StartProfilePageHomepage: before showing the homepage link on the profile page
  347. - $userprofile: UserProfile widget
  348. - &$profile: the profile being shown
  349. EndProfilePageHomepage: after showing the homepage on the profile page
  350. - $userprofile: UserProfile widget
  351. - &$profile: the profile being shown
  352. StartProfilePageBio: before showing the bio on the profile page
  353. - $userprofile: UserProfile widget
  354. - &$profile: the profile being shown
  355. EndProfilePageBio: after showing the bio on the profile page
  356. - $userprofile: UserProfile widget
  357. - &$profile: the profile being shown
  358. StartProfilePageProfileTags: before showing the tags on the profile page
  359. - $userprofile: UserProfile widget
  360. - &$profile: the profile being shown
  361. EndProfilePageProfileTags: after showing the tags on the profile page
  362. - $userprofile: UserProfile widget
  363. - &$profile: the profile being shown
  364. StartProfileList: when starting a list of profiles (before <ul>)
  365. - $profilelist: ProfileList widget, with $profile, $action, and $out
  366. EndProfileList: when ending a list of profiles (after </ul>)
  367. - $profilelist: ProfileList widget
  368. StartProfileListItem: when starting to show a profile list item
  369. - $item: ProfileListItem widget
  370. EndProfileListItem: after showing a profile list item
  371. - $item: ProfileListItem widget
  372. StartProfileListItemProfile: the profile data part of the item
  373. - $item: ProfileListItem widget
  374. EndProfileListItemProfile: the profile data part of the item
  375. - $item: ProfileListItem widget
  376. StartProfileListItemActions: the actions (buttons) for an item
  377. - $item: ProfileListItem widget
  378. EndProfileListItemActions: the actions (buttons) for an item
  379. - $item: ProfileListItem widget
  380. StartProfileListItemProfileElements: inside the <div>
  381. - $item: ProfileListItem widget
  382. EndProfileListItemProfileElements: inside the <div>
  383. - $item: ProfileListItem widget
  384. StartProfileListItemAvatar: Showing a profile list avatar
  385. - $item: ProfileListItem widget
  386. EndProfileListItemAvatar: Showing a profile list avatar
  387. - $item: ProfileListItem widget
  388. StartProfileListItemFullName: Showing the profile list full name
  389. - $item: ProfileListItem widget
  390. EndProfileListItemFullName: Showing the profile list full name
  391. - $item: ProfileListItem widget
  392. StartProfileListItemLocation: Showing the profile list location
  393. - $item: ProfileListItem widget
  394. EndProfileListItemLocation: Showing the profile list location
  395. - $item: ProfileListItem widget
  396. StartProfileListItemHomepage: Showing the profile list homepage
  397. - $item: ProfileListItem widget
  398. EndProfileListItemHomepage: Showing the profile list homepage
  399. - $item: ProfileListItem widget
  400. StartProfileListItemBio: Showing the profile list bio
  401. - $item: ProfileListItem widget
  402. EndProfileListItemBio: Showing the profile list bio
  403. - $item: ProfileListItem widget
  404. StartProfileListItemActionElements: Showing the profile list actions (prepend a button here, or replace all buttons)
  405. - $item: ProfileListItem widget
  406. EndProfileListItemActionElements: Showing profile list actions (append a button here)
  407. - $item: ProfileListItem widget
  408. StartUserXRDS: Start XRDS output (right after the opening XRDS tag)
  409. - $action: the current action
  410. - &$xrdsoutputter - XRDSOutputter object to write to
  411. EndUserXRDS: End XRDS output (right before the closing XRDS tag)
  412. - $action: the current action
  413. - &$xrdsoutputter - XRDSOutputter object to write to
  414. StartPublicXRDS: Start XRDS output (right after the opening XRDS tag)
  415. - $action: the current action
  416. - &$xrdsoutputter - XRDSOutputter object to write to
  417. EndPublicXRDS: End XRDS output (right before the closing XRDS tag)
  418. - $action: the current action
  419. - &$xrdsoutputter - XRDSOutputter object to write to
  420. StartCheckPassword: Check a username/password
  421. - $nickname: The nickname to check
  422. - $password: The password to check
  423. - &$authenticatedUser: set to User object if credentials match a user.
  424. EndCheckPassword: After checking a username/password pair
  425. - $nickname: The nickname that was checked
  426. - $password: The password that was checked
  427. - $authenticatedUser: User object if credentials match a user, else null.
  428. StartChangePassword: Before changing a password
  429. - $user: user
  430. - $oldpassword: the user's old password
  431. - $newpassword: the desired new password
  432. EndChangePassword: After changing a password
  433. - $user: user
  434. StartHashPassword: Generate a hashed version of the password (like a salted crypt)
  435. - &$hashed: Hashed version of the password, later put in the database
  436. - $password: The password that should be hashed
  437. - $profile: Profile that this password and hash belongs to. Can be null.
  438. StartSetUser: Before setting the currently logged in user
  439. - $user: user
  440. EndSetUser: After setting the currently logged in user
  441. - $user: user
  442. StartSetApiUser: Before setting the current API user
  443. - &$user: user, can be set during event handling (return false to stop processing)
  444. EndSetApiUser: After setting the current API user
  445. - $user: user, only called if this is an actual user
  446. StartHasRole: Before determing if the a profile has a given role
  447. - $profile: profile in question
  448. - $name: name of the role in question
  449. - &$has_role: does this profile have the named role?
  450. EndHasRole: Before determing if the a profile has a given role
  451. - $profile: profile in question
  452. - $name: name of the role in question
  453. - $has_role: does this profile have the named role?
  454. UserDeleteRelated: Specify additional tables to delete entries from when deleting users
  455. - $user: User object
  456. - &$related: array of DB_DataObject class names to delete entries on matching user_id.
  457. GetUrlShorteners: Specify URL shorteners that are available for use
  458. - &$shorteners: append your shortener to this array like so: $shorteners[shortenerName]=array('display'=>display, 'freeService'=>boolean)
  459. StartShortenUrl: About to shorten a URL
  460. - $url: url to be shortened
  461. - $shortenerName: name of the requested shortener
  462. - &$shortenedUrl: short version of the url
  463. EndShortenUrl: After a URL has been shortened
  464. - $url: url to be shortened
  465. - $shortenerName: name of the requested shortener
  466. - $shortenedUrl: short version of the url
  467. StartCssLinkElement: Before a <link rel="stylesheet"..> element is written
  468. - $action
  469. - &$src
  470. - &$theme
  471. - &$media
  472. EndCssLinkElement: After a <link rel="stylesheet"..> element is written
  473. - $action
  474. - $src
  475. - $theme
  476. - $media
  477. StartStyleElement: Before a <style...> element is written
  478. - $action
  479. - &$code
  480. - &$type
  481. - &$media
  482. EndStyleElement: After a <style...> element is written
  483. - $action
  484. - $code
  485. - $type
  486. - $media
  487. StartScriptElement: Before a <script...> element is written
  488. - $action
  489. - &$src
  490. - &$type
  491. EndScriptElement: After a <script...> element is written
  492. - $action
  493. - $src
  494. - $type
  495. StartInlineScriptElement: Before a <script...> element is written
  496. - $action
  497. - &$code
  498. - &$type
  499. EndInlineScriptElement: After a <script...> element is written
  500. - $action
  501. - $code
  502. - $type
  503. StartLog: Before writing to the logs
  504. - &$priority
  505. - &$msg
  506. - &$filename
  507. EndLog: After writing to the logs
  508. - $priority
  509. - $msg
  510. - $filename
  511. StartBlockProfile: when we're about to block
  512. - $user: the person doing the block
  513. - $profile: the person getting blocked, can be remote
  514. EndBlockProfile: when a block has succeeded
  515. - $user: the person doing the block
  516. - $profile: the person blocked, can be remote
  517. StartUnblockProfile: when we're about to unblock
  518. - $user: the person doing the unblock
  519. - $profile: the person getting unblocked, can be remote
  520. EndUnblockProfile: when an unblock has succeeded
  521. - $user: the person doing the unblock
  522. - $profile: the person unblocked, can be remote
  523. StartSubscribe: when a subscription is starting
  524. - $profile: Profile that is subscribing
  525. - $other: Profile that is being subscribed to
  526. EndSubscribe: when a subscription is finished
  527. - $profile: Profile that is subscribing
  528. - $other: Profile that is being subscribed to
  529. StartUnsubscribe: when an unsubscribe is starting
  530. - $profile: Profile that is unsubscribing
  531. - $other: Profile that is being unsubscribed from
  532. EndUnsubscribe: when an unsubscribe is done
  533. - $profile: Profile that is unsubscribing
  534. - $other: Profile that is being unsubscribed from
  535. StartJoinGroup: when a user is joining a group
  536. - $group: the group being joined
  537. - $profile: the local or remote user joining
  538. EndJoinGroup: when a user finishes joining a group
  539. - $group: the group being joined
  540. - $profile: the local or remote user joining
  541. StartLeaveGroup: when a user is leaving a group
  542. - $group: the group being left
  543. - $profile: the local or remote user leaving
  544. EndLeaveGroup: when a user has left a group
  545. - $group: the group being left
  546. - $profile: the local or remote user leaving
  547. StartShowContentLicense: Showing the default license for content
  548. - $action: the current action
  549. EndShowContentLicense: Showing the default license for content
  550. - $action: the current action
  551. GetImTransports: Get IM transports that are available
  552. - &$transports: append your transport to this array like so: $transports[transportName]=array('display'=>display)
  553. NormalizeImScreenname: Normalize an IM screenname
  554. - $transport: transport the screenname is on
  555. - &$screenname: screenname to be normalized
  556. ValidateImScreenname: Validate an IM screenname
  557. - $transport: transport the screenname is on
  558. - $screenname: screenname to be validated
  559. - $valid: is the screenname valid?
  560. SendImConfirmationCode: Send a confirmation code to confirm a user owns an IM screenname
  561. - $transport: transport the screenname exists on
  562. - $screenname: screenname being confirmed
  563. - $code: confirmation code for confirmation URL
  564. - $user: user requesting the confirmation
  565. StartUserRegister: When a new user is being registered
  566. - $profile: Profile object with new profile data (no ID yet)
  567. EndUserRegister: When a new user has been registered
  568. - $profile: Profile object with new profile data
  569. StartRobotsTxt: Before outputting the robots.txt page
  570. - &$action: RobotstxtAction being shown
  571. EndRobotsTxt: After the default robots.txt page (good place for customization)
  572. - &$action: RobotstxtAction being shown
  573. StartGetProfileUri: When determining the canonical URI for a given profile
  574. - $profile: the current profile
  575. - &$uri: the URI
  576. EndGetProfileUri: After determining the canonical URI for a given profile
  577. - $profile: the current profile
  578. - &$uri: the URI
  579. StartGetProfileAcctUri: Get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
  580. - $profile: Profile of user we want to get acct: URI for
  581. - &$acct: string with the resulting acct: uri
  582. EndGetProfileAcctUri: Last attempts to get the acct: URI for a Profile (or throw ProfileNoAcctUriException)
  583. - $profile: Profile of user we want to get acct: URI for
  584. - &$acct: string with the resulting acct: uri
  585. StartFindMentions: start finding mentions in a block of text
  586. - $sender: sender profile
  587. - $text: plain text version of the notice
  588. - &$mentions: mentions found so far. Array of arrays; each array
  589. has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  590. 'title' (title of the link), 'position' (position of the text to
  591. replace), 'text' (text to replace)
  592. EndFindMentions: end finding mentions in a block of text
  593. - $sender: sender profile
  594. - $text: plain text version of the notice
  595. - &$mentions: mentions found so far. Array of arrays; each array
  596. has 'mentioned' (array of mentioned profiles), 'url' (url to link as),
  597. 'title' (title of the link), 'position' (position of the text to
  598. replace), 'text' (text to replace)
  599. StartShowSubscriptionsContent: before showing the subscriptions content
  600. - $action: the current action
  601. EndShowSubscriptionsContent: after showing the subscriptions content
  602. - $action: the current action
  603. StartShowUserGroupsContent: before showing the user groups content
  604. - $action: the current action
  605. EndShowUserGroupsContent: after showing the user groups content
  606. - $action: the current action
  607. StartShowAllContent: before showing the all (you and friends) content
  608. - $action: the current action
  609. EndShowAllContent: after showing the all (you and friends) content
  610. - $action: the current action
  611. StartShowSubscriptionsMiniList: at the start of subscriptions mini list
  612. - $action: the current action
  613. EndShowSubscriptionsMiniList: at the end of subscriptions mini list
  614. - $action: the current action
  615. StartShowGroupsMiniList: at the start of groups mini list
  616. - $action: the current action
  617. EndShowGroupsMiniList: at the end of groups mini list
  618. - $action: the current action
  619. StartDeleteUserForm: starting the data in the form for deleting a user
  620. - $action: action being shown
  621. - $user: user being deleted
  622. EndDeleteUserForm: Ending the data in the form for deleting a user
  623. - $action: action being shown
  624. - $user: user being deleted
  625. StartDeleteUser: handling the post for deleting a user
  626. - $action: action being shown
  627. - $user: user being deleted
  628. EndDeleteUser: handling the post for deleting a user
  629. - $action: action being shown
  630. - $user: user being deleted
  631. StartNoticeAsActivity: before converting a notice to an activity
  632. - $notice: notice being converted
  633. - &$activity: initially empty activity
  634. EndNoticeAsActivity: after converting a notice to an activity (good time to customize!)
  635. - $notice: notice being converted
  636. - &$activity: activity, now more-or-less full
  637. StartNoticeSaveWeb: before saving a notice through the Web interface
  638. - $action: action being executed (instance of NewNoticeAction)
  639. - &$authorId: integer ID of the author
  640. - &$text: text of the notice
  641. - &$options: additional options (location, replies, etc.)
  642. EndNoticeSaveWeb: after saving a notice through the Web interface
  643. - $action: action being executed (instance of NewNoticeAction)
  644. - $notice: notice that was saved
  645. StartRssEntryArray: at the start of copying a notice to an array
  646. - $notice: the notice being copied
  647. - &$entry: the entry (empty at beginning)
  648. EndRssEntryArray: at the end of copying a notice to an array
  649. - $notice: the notice being copied
  650. - &$entry: the entry, with all the fields filled up
  651. NoticeDeleteRelated: at the beginning of deleting related fields to a notice
  652. - $notice: notice being deleted
  653. FileDeleteRelated: at the beginning of deleting related fields to a File
  654. - $notice: File being deleted
  655. StartShowHeadTitle: when beginning to show the <title> element
  656. - $action: action being shown
  657. EndShowHeadTitle: when done showing the <title>
  658. - $action: action being shown
  659. StartShowPageTitle: when beginning to show the page title <h1>
  660. - $action: action being shown
  661. EndShowPageTitle: when done showing the page title <h1>
  662. - $action: action being shown
  663. StartDeleteOwnNotice: when a user starts to delete their own notice
  664. - $user: the user doing the delete
  665. - $notice: the notice being deleted
  666. EndDeleteOwnNotice: when a user has deleted their own notice
  667. - $user: the user doing the delete
  668. - $notice: the notice being deleted
  669. StartShowFeedLinkList: before showing the feed list in the sidebar
  670. - $action: action being executed
  671. - $feeds: list of feeds to show
  672. EndShowFeedLinkList: after showing the feed list in the sidebar
  673. - $action: action being executed
  674. - $feeds: list of feeds shown
  675. StartShowFeedLink: before showing an individual feed item
  676. - $action: action being executed
  677. - $feed: feed to show
  678. EndShowFeedLink: after showing an individual feed
  679. - $action: action being executed
  680. - $feed: feed to show
  681. StartShowNoticeForm: before showing the notice form (before <form>)
  682. - $action: action being executed
  683. EndShowNoticeForm: after showing the notice form (after <form>)
  684. - $action: action being executed
  685. StartShowEntryForms: microapp entry form tab data
  686. - &$tabs: tab assoc array with 'tag' => (title, href to create new entry)
  687. StartGrantRole: when a role is being assigned
  688. - $profile: profile that will have the role
  689. - $role: string name of the role
  690. EndGrantRole: when a role has been successfully assigned
  691. - $profile: profile that will have the role
  692. - $role: string name of the role
  693. StartRevokeRole: when a role is being revoked
  694. - $profile: profile that will lose the role
  695. - $role: string name of the role
  696. EndRevokeRole: when a role has been revoked
  697. - $profile: profile that lost the role
  698. - $role: string name of the role
  699. StartAtomPubNewActivity: When a new activity comes in through Atom Pub API
  700. - &$activity: received activity
  701. - $profile: profile of the user publishing the entry
  702. - &$notice: notice created; initially null, can be set
  703. EndAtomPubNewActivity: When a new activity comes in through Atom Pub API
  704. - $activity: received activity
  705. - $profile: profile of the user publishing the entry
  706. - $notice: notice that was created
  707. AdminPanelCheck: When checking whether the current user can access a given admin panel
  708. - $name: Name of the admin panel
  709. - &$isOK: Boolean whether the user is allowed to use the panel
  710. StartAdminPanelNav: Before displaying the first item in the list of admin panels
  711. - $nav The AdminPanelNav widget
  712. EndAdminPanelNav: After displaying the last item in the list of admin panels
  713. - $nav The AdminPanelNav widget
  714. StartActivityObjectFromNotice: When converting a notice to an activity:object
  715. - $notice: The notice being converted
  716. - &$object: The resulting object. Fill this and return false to override defaults.
  717. EndActivityObjectFromNotice: After converting a notice to an activity:object
  718. - $notice: The notice being converted
  719. - &$object: The resulting object. Can be edited
  720. StartActivityObjectFromProfile: When converting a profile to an activity:object
  721. - $profile: The profile being converted
  722. - &$object: The (empty) object. Fill it up and return false to override defaults.
  723. EndActivityObjectFromProfile: After converting a profile to an activity:object
  724. - $profile: The profile being converted
  725. - &$object: The finished object. Can be tweaked
  726. StartActivityObjectFromGroup: When converting a group to an activity:object
  727. - $group: The group being converted
  728. - &$object: The (empty) object. Fill and return false to override.
  729. EndActivityObjectFromGroup: After converting a group to an activity:object
  730. - $group: The group being converted
  731. - &$object: The finished object. Tweak as needed.
  732. StartImportActivity: when we start to import an activity
  733. - $user: User to make the author import
  734. - $author: Author of the feed; good for comparisons
  735. - $activity: The current activity
  736. - $trusted: How "trusted" the process is
  737. - &$done: Return value; whether to continue
  738. EndImportActivity: when we finish importing an activity
  739. - $user: User to make the author import
  740. - $author: Author of the feed; good for comparisons
  741. - $activity: The current activity
  742. - $trusted: How "trusted" the process is
  743. StartProfileSettingsActions: when we're showing account-management action list
  744. - $action: Action being shown (use for output)
  745. EndProfileSettingsActions: when we're showing account-management action list
  746. - $action: Action being shown (use for output)
  747. StartOpenNoticeListItemElement: Before the opening <li> of a notice list element
  748. - $nli: The notice list item being shown
  749. EndOpenNoticeListItemElement: After the opening <li> of a notice list element
  750. - $nli: The notice list item being shown
  751. StartCloseNoticeListItemElement: Before the closing </li> of a notice list element
  752. - $nli: The notice list item being shown
  753. EndCloseNoticeListItemElement: After the closing </li> of a notice list element
  754. - $nli: The notice list item being shown
  755. StartGroupEditFormData: Beginning the group edit form entries
  756. - $form: The form widget being shown
  757. EndGroupEditFormData: Ending the group edit form entries
  758. - $form: The form widget being shown
  759. StartGroupSave: After initializing but before saving a group
  760. - &$group: group about to be saved
  761. EndGroupSave: After saving a group, aliases, and first member
  762. - $group: group that was saved
  763. StartInterpretCommand: Before running a command
  764. - $cmd: First word in the string, 'foo' in 'foo argument'
  765. - $arg: Argument, if any, like 'argument' in 'foo argument'
  766. - $user: User who issued the command
  767. - &$result: Resulting command; you can set this!
  768. EndInterpretCommand: Before running a command
  769. - $cmd: First word in the string, 'foo' in 'foo argument'
  770. - $arg: Argument, if any, like 'argument' in 'foo argument'
  771. - $user: User who issued the command
  772. - $result: Resulting command
  773. StartGroupActionsList: Start the list of actions on a group profile page (after <ul>, before first <li>)
  774. - $action: action being executed (for output and params)
  775. - $group: group for the page
  776. EndGroupActionsList: End the list of actions on a group profile page (before </ul>, after last </li>)
  777. - $action: action being executed (for output and params)
  778. - $group: group for the page
  779. StartGroupProfileElements: Start showing stuff about the group on its profile page
  780. - $action: action being executed (for output and params)
  781. - $group: group for the page
  782. EndGroupProfileElements: Start showing stuff about the group on its profile page
  783. - $action: action being executed (for output and params)
  784. - $group: group for the page
  785. StartShowProfileTagContent: When showing a people tag page
  786. - $action: action being executed (for output and params)
  787. EndShowProfileTagContent: After showing the contents of a people tag page
  788. - $action: action being executed (for output and params)
  789. StartShowTaggedProfilesMiniList: at the start of mini list of tagged profiles
  790. - $action: action being executed (for output and params)
  791. EndShowTaggedProfilesMiniList: at the end of mini list of tagged profiles
  792. - $action: action being executed (for output and params)
  793. StartShowProfileTagSubscribersMiniList: at the start of mini list of people tag subscribers
  794. - $action: action being executed (for output and params)
  795. EndShowProfileTagSubscribersMiniList: at the end of mini list of people tag subscribers
  796. - $action: action being executed (for output and params)
  797. StartTagProfileAction: When starting to show profile tagging page
  798. - $action: action being executed (for output and params)
  799. - $profile: profile being tagged
  800. EndTagProfileAction: After showing profile tagging page
  801. - $action: action being executed (for output and params)
  802. - $profile: profile being tagged
  803. StartProfileCompletionSearch: When starting a profile search for autocompletion
  804. - $action: action being executed (for output and params)
  805. - &$profile: result Profile objects
  806. - $search_engine: the search engine
  807. EndProfileCompletionSearch: After search results for profile autocompletion have been found
  808. - $action: profilec completion action
  809. - &$profile: current result Profile objects
  810. - $search_engine: The search engine object
  811. StartShowTagProfileForm: When showing people tagging form
  812. - $action: action being executed (for output and params)
  813. - $profile: profile being tagged
  814. EndShowTagProfileForm: After showing people tagging form
  815. - $action: action being executed (for output and params)
  816. - $profile: profile being tagged
  817. StartSavePeopletags: When starting to save people tags
  818. - $action: action being executed (for output and params)
  819. - $tagstring: string input, a list of tags
  820. EndSavePeopletags: After saving people tags
  821. - $action: action being executed (for output and params)
  822. - $tagstring: string input, a list of tags
  823. StartProfiletagGetUri: when generating the Uri for a people tag
  824. - $profile_list: the people tag, a Profile_list object
  825. - &$uri: the URI
  826. EndProfiletagGetUri: after generating the uri for a people tag
  827. - $profile_list: the people tag, a Profile_list object
  828. - &$uri: the URI
  829. StartUserPeopletagHomeUrl: when generating the homepage url for a people tag
  830. - $profile_list: the people tag, a Profile_list object
  831. - &$url: the URL
  832. EndUserPeopletagHomeUrl: after generating the homepage url for a people tag
  833. - $profile_list: the people tag, a Profile_list object
  834. - &$url: the URL
  835. StartProfiletagPermalink: when generating the permalink url for a people tag
  836. - $profile_list: the people tag, a Profile_list object
  837. - &$url: the URL
  838. EndProfiletagPermalink: after generating the permalink url for a people tag
  839. - $profile_list: the people tag, a Profile_list object
  840. - &$url: the URL
  841. StartTagProfile: when tagging a profile
  842. - $tagger: profile tagging
  843. - $tagged: profile being tagged
  844. - $tag: the tag
  845. EndTagProfile: after tagging a profile
  846. - $newtag: the newly created Profile_tag object
  847. StartUntagProfile: when deleting a people tag
  848. - $ptag: the Profile_tag object being deleted
  849. EndUntagProfile: after deleting a people tag
  850. - $orig: a copy of the deleted Profile_tag object
  851. StartSubscribePeopletag: when subscribing to a people tag
  852. - $peopletag: Profile_list object being subscribed to
  853. - $profile: subscriber's profile
  854. EndSubscribePeopletag: after subscribing to a people tag
  855. - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
  856. - $profile: subscriber's profile
  857. StartUnsubscribePeopletag: when unsubscribing to a people tag
  858. - $profile_list: the people tag, a Profile_list object: Profile_list object being subscribed to
  859. - $profile: subscriber's profile
  860. EndUnsubscribePeopletag: after unsubscribing to a people tag
  861. - $peopletag: Profile_list object being subscribed to
  862. - $profile: subscriber's profile
  863. StartActivityObjectFromPeopletag: while starting to create an ActivityObject from a people tag
  864. - $profile_list: the people tag, a Profile_list object
  865. - &$object: activity object
  866. EndActivityObjectFromPeopletag: after making an ActivityObject from a people tag
  867. - $profile_list: the people tag, a Profile_list object
  868. - &$object: activity object
  869. StartPeopletagGroupNav: Showing the people tag nav menu
  870. - $menu: the menu widget; use $menu->action for output
  871. EndPeopletagGroupNav: after showing the people tag nav menu
  872. - $menu: the menu widget; use $menu->action for output
  873. StartShowPeopletagItem: when showing a people tag
  874. - $widget: PeopletagListItem widget
  875. EndShowPeopletagItem: after showing a people tag
  876. - $widget: PeopletagListItem widget
  877. StartSubscribePeopletagForm: when showing people tag subscription form
  878. - $action: action being executed (for output and params)
  879. - $peopletag: people tag being subscribed to
  880. EndSubscribePeopletagForm: after showing the people tag subscription form
  881. - $action: action being executed (for output and params)
  882. - $peopletag: people tag being subscribed to
  883. StartShowPeopletags: when showing a textual list of people tags
  884. - $widget: PeopletagsWidget; use $widget->out for output
  885. - $tagger: profile of the tagger
  886. - $tagged: profile tagged
  887. EndShowPeopletags: after showing a textual list of people tags
  888. - $widget: PeopletagsWidget; use $widget->out for output
  889. - $tagger: profile of the tagger
  890. - $tagged: profile tagged
  891. StartProfileListItemTags: when showing people tags in a profile list item widget
  892. - $widget: ProfileListItem widget
  893. EndProfileListItemTags: after showing people tags in a profile list item widget
  894. - $widget: ProfileListItem widget
  895. 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)
  896. - $obj: ActivityObject
  897. - $out: XMLOutputter to append custom output
  898. EndActivityObjectOutputAtom: Called at end of Atom XML output generation for ActivityObject chunks, just inside the </activity:object>
  899. - $obj: ActivityObject
  900. - $out: XMLOutputter to append custom output
  901. 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)
  902. - $obj ActivityObject
  903. - &$out: array to be serialized; you're free to modify it
  904. EndActivityObjectOutputJson: Called at end of JSON output generation for ActivityObject chunks: the array has not yet been filled out.
  905. - $obj ActivityObject
  906. - &$out: array to be serialized; you're free to modify it
  907. 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.
  908. - $notice Notice
  909. - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
  910. 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.
  911. - $notice Notice
  912. - &$ni: in/out array mapping profile IDs to constants: NOTICE_INBOX_SOURCE_SUB etc
  913. StartDefaultLocalNav: When showing the default local nav
  914. - $menu: the menu
  915. - $user: current user
  916. EndDefaultLocalNav: When showing the default local nav
  917. - $menu: the menu
  918. - $user: current user
  919. StartShowAccountProfileBlock: When showing the profile block for an account
  920. - $out: XMLOutputter to append custom output
  921. - $profile: the profile being shown
  922. EndShowAccountProfileBlock: After showing the profile block for an account
  923. - $out: XMLOutputter to append custom output
  924. - $profile: the profile being shown
  925. StartShowGroupProfileBlock: When showing the profile block for a group
  926. - $out: XMLOutputter to append custom output
  927. - $profile: the profile being shown
  928. EndShowGroupProfileBlock: After showing the profile block for a group
  929. - $out: XMLOutputter to append custom output
  930. - $group: the group being shown
  931. StartShowConversation: start the listing of a conversation
  932. - $action: Action object (used mainly as HTMLOutputter)
  933. - $conv: Conversation object, has functions to retrieve relevant notices
  934. - $scoped: Profile for scoping (null if not logged in)
  935. EndShowConversation: after the listing of a conversation
  936. - $action: Action object (used mainly as HTMLOutputter)
  937. - $conv: Conversation object, has functions to retrieve relevant notices
  938. - $scoped: Profile for scoping (null if not logged in)
  939. StartShowThreadedNoticeTail: when showing the replies etc. to a notice
  940. - $nli: parent noticelistitem
  941. - $notice: parent notice
  942. - &$children: list of children
  943. EndShowThreadedNoticeTail: when showing the replies etc. to a notice
  944. - $nli: parent noticelistitem
  945. - $notice: parent notice
  946. - $children: list of children
  947. StartShowThreadedNoticeSub: when showing a reply to a notice
  948. - $nli: parent noticelistitem
  949. - $parent: parent notice
  950. - $child: child notice
  951. EndShowThreadedNoticeSub: when showing a reply to a notice
  952. - $nli: parent noticelistitem
  953. - $parent: parent notice
  954. - $child: child notice
  955. StartAddEmailAddress: when adding an email address through the Web UI
  956. - $user: user getting the new address
  957. - $email: email being added
  958. EndAddEmailAddress: done adding an email address through the Web UI
  959. - $user: user getting the new address
  960. - $email: email being added
  961. StartValidateEmailInvite: when validating an email address for invitations
  962. - $user: user doing the invite
  963. - $email: email address
  964. - &$valid: flag for if it's valid; can be modified
  965. EndValidateEmailInvite: after validating an email address for invitations
  966. - $user: user doing the invite
  967. - $email: email address
  968. - &$valid: flag for if it's valid; can be modified
  969. StartLocalURL: before resolving a local url for an action
  970. - &$action: action to find a path for
  971. - &$paramsi: parameters to pass to the action
  972. - &$fragment: any url fragement
  973. - &$addSession: whether to add session variable
  974. - &$url: resulting URL to local resource
  975. EndLocalURL: before resolving a local url for an action
  976. - &$action: action to find a path for
  977. - &$paramsi: parameters to pass to the action
  978. - &$fragment: any url fragement
  979. - &$addSession: whether to add session variable
  980. - &$url: resulting URL to local resource
  981. StartProfileGetAvatar: When getting an avatar for a profile
  982. - $profile: profile
  983. - $size: size of the avatar
  984. - &$avatar: avatar
  985. EndProfileGetAvatar: After getting an avatar for a profile
  986. - $profile: profile
  987. - $size: size of the avatar
  988. - &$avatar: avatar
  989. StartRegisterSuccess: Before showing the registration success message
  990. - $action: the registration action
  991. StartRegisterSuccess: After showing the registration success message
  992. - $action: the registration action
  993. StartDocFileForTitle: Before searching for a doc or mail template
  994. - $title: Title we're looking for
  995. - &$paths: Paths we're searching
  996. - &$filename: Filename so far (set this if you want)
  997. EndDocFileForTitle: After searching for a doc or mail template
  998. - $title: Title we looked for
  999. - $paths: Paths we searched
  1000. - &$filename: Filename so far (set this if you want)
  1001. StartReadWriteTables: when noting which tables must be read-write, even on read-only actions
  1002. - &$tables: list of table names
  1003. - &$rwdb: read-write database URI
  1004. EndReadWriteTables: after noting which tables must be read-write, even on read-only actions
  1005. - $tables: list of table names
  1006. - $rwdb: read-write database URI
  1007. StartShowInviteForm: Right before displaying the invitations form
  1008. - $action: invitation action
  1009. EndShowInviteForm: After displaying the invitations form
  1010. - $action: invitation action
  1011. StartSendInvitations: Right before sending invitations
  1012. - $action: invitation action
  1013. EndSendInvitations: Right after sending invitations
  1014. - $action: invitation action
  1015. StartShowInvitationSuccess: Right before showing invitations success msg
  1016. - $action: invitation action
  1017. EndShowInvitationSuccess: After showing invitations success msg
  1018. - $action: invitation action
  1019. StartUpgrade: when starting a site upgrade
  1020. EndUpgrade: when ending a site upgrade; good place to do your own upgrades
  1021. HaveIMPlugin: is there an IM plugin loaded?
  1022. - &$haveIMPlugin: set me to true if you're loaded!
  1023. StartShowNoticeOptionItems: Before showing first controls in a notice list item; inside the div
  1024. - $nli: NoticeListItem being shown
  1025. EndShowNoticeOptionItems: After showing last controls in a notice list item; inside the div
  1026. - $nli: NoticeListItem being shown
  1027. StartNoticeInScope: Before checking if a notice should be visible to a user
  1028. - $notice: The notice to check
  1029. - $profile: The profile to check for scope
  1030. - &$bResult: The boolean result; fill this in if you want to skip
  1031. EndNoticeInScope: After checking if a notice should be visible to a user
  1032. - $notice: The notice to check
  1033. - $profile: The profile to check for scope
  1034. - &$bResult: The boolean result; overwrite this if you so desire
  1035. StartNoticeListPrefill: Before pre-filling a list of notices with extra data
  1036. - &$notices: Notices to be pre-filled
  1037. - $avatarSize: The avatar size for the list
  1038. EndNoticeListPrefill: After pre-filling a list of notices with extra data
  1039. - &$notices: Notices that were pre-filled
  1040. - &$profiles: Profiles that were pre-filled
  1041. - $avatarSize: The avatar size for the list
  1042. OtherAccountProfiles: Hook to add account profiles to a user account profile block
  1043. - $profile: the Profile being shown
  1044. - &$others: Modifiable array of profile info arrays. Each one has the following fields:
  1045. href: link to the profile
  1046. text: text for the profile
  1047. image: mini image for the profile
  1048. CreateFileImageThumbnailSource: Hook to create image thumbnail source from a File
  1049. - $file: 'File' object to source the image from
  1050. - &$imgPath: Path to image file which can be used as source for our thumbnail algorithm.
  1051. - $media: MIME media type ('image', 'video', 'audio' etc.)
  1052. StartResizeImageFile: Hook to resize an image and output it to a file. No matching End event yet.
  1053. - $imagefile: ImageFile object we're resizing.
  1054. - $outpath: string with output filepath
  1055. - $box: array with size ('width', 'height') and boundary box('x', 'y', 'w', 'h').
  1056. StartShowAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
  1057. - $out: HTMLOutputter class to use for outputting HTML.
  1058. - $file: 'File' object which we're going to show representation for.
  1059. EndShowAttachmentRepresentation: Executed after Attachment representation, despite perhaps being unsupported media.
  1060. - $out: HTMLOutputter class to use for outputting HTML.
  1061. - $file: 'File' object which we're going to show representation for.
  1062. ShowUnsupportedAttachmentRepresentation: Attachment representation, full file (or in rare cases thumbnails/previews).
  1063. - $out: HTMLOutputter class to use for outputting HTML.
  1064. - $file: 'File' object which we're going to show representation for.
  1065. StartNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
  1066. - $stored: Notice object that is being distributed.
  1067. - &$mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.
  1068. EndNotifyMentioned: During notice distribution, we send notifications (email, im...) to the profiles who were somehow mentioned.
  1069. - $stored: Notice object that is being distributed.
  1070. - $mentioned_ids: Array of profile IDs (not just for local users) who got mentioned by the notice.