The official, canonical postActiv repository. http://www.postactiv.com

EVENTS.txt 55KB

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