phpQueryEvents.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  1. <html>
  2. <head>
  3. <title>Docs For Class phpQueryEvents</title>
  4. <link rel="stylesheet" type="text/css" href="../media/style.css">
  5. </head>
  6. <body>
  7. <table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  8. <tr>
  9. <td class="header_top">phpQuery</td>
  10. </tr>
  11. <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
  12. <tr>
  13. <td class="header_menu">
  14. [ <a href="../classtrees_phpQuery.html" class="menu">class tree: phpQuery</a> ]
  15. [ <a href="../elementindex_phpQuery.html" class="menu">index: phpQuery</a> ]
  16. [ <a href="../elementindex.html" class="menu">all elements</a> ]
  17. </td>
  18. </tr>
  19. <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt="" /></td></tr>
  20. </table>
  21. <table width="100%" border="0" cellpadding="0" cellspacing="0">
  22. <tr valign="top">
  23. <td width="200" class="menu">
  24. <div id="todolist">
  25. <p><a href="../todolist.html">Todo List</a></p>
  26. </div>
  27. <b>Packages:</b><br />
  28. <a href="../li_phpQuery.html">phpQuery</a><br />
  29. <br /><br />
  30. <b>Files:</b><br />
  31. <div class="package">
  32. <a href="../phpQuery/_Callback.php.html"> Callback.php
  33. </a><br>
  34. <a href="../phpQuery/_DOMDocumentWrapper.php.html"> DOMDocumentWrapper.php
  35. </a><br>
  36. <a href="../phpQuery/_DOMEvent.php.html"> DOMEvent.php
  37. </a><br>
  38. <a href="../phpQuery/_phpQuery.php.html"> phpQuery.php
  39. </a><br>
  40. <a href="../phpQuery/_phpQueryEvents.php.html"> phpQueryEvents.php
  41. </a><br>
  42. <a href="../phpQuery/_phpQueryObject.php.html"> phpQueryObject.php
  43. </a><br>
  44. </div><br />
  45. <b>Classes:</b><br />
  46. <div class="package">
  47. <a href="../phpQuery/Callback.html">Callback</a><br />
  48. <a href="../phpQuery/CallbackParam.html">CallbackParam</a><br />
  49. <a href="../phpQuery/CallbackReference.html">CallbackReference</a><br />
  50. <a href="../phpQuery/DOMDocumentWrapper.html">DOMDocumentWrapper</a><br />
  51. <a href="../phpQuery/DOMEvent.html">DOMEvent</a><br />
  52. <a href="../phpQuery/phpQuery.html">phpQuery</a><br />
  53. <a href="../phpQuery/phpQueryEvents.html">phpQueryEvents</a><br />
  54. <a href="../phpQuery/phpQueryObject.html">phpQueryObject</a><br />
  55. <a href="../phpQuery/phpQueryPlugins.html">phpQueryPlugins</a><br />
  56. </div>
  57. </td>
  58. <td>
  59. <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">
  60. <h1>Class: phpQueryEvents</h1>
  61. Source Location: /phpQueryEvents.php<br /><br />
  62. <table width="100%" border="0">
  63. <tr><td valign="top">
  64. <h3><a href="#class_details">Class Overview</a></h3>
  65. <pre></pre><br />
  66. <div class="description">Event handling class.</div><br /><br />
  67. <h4>Author(s):</h4>
  68. <ul>
  69. <li>Tobiasz Cudnik</li>
  70. </ul>
  71. </td>
  72. <td valign="top">
  73. <h3><a href="#class_methods">Methods</a></h3>
  74. <ul>
  75. <li><a href="../phpQuery/phpQueryEvents.html#methodadd">add</a></li>
  76. <li><a href="../phpQuery/phpQueryEvents.html#methodgetNode">getNode</a></li>
  77. <li><a href="../phpQuery/phpQueryEvents.html#methodissetGlobal">issetGlobal</a></li>
  78. <li><a href="../phpQuery/phpQueryEvents.html#methodremove">remove</a></li>
  79. <li><a href="../phpQuery/phpQueryEvents.html#methodsetNode">setNode</a></li>
  80. <li><a href="../phpQuery/phpQueryEvents.html#methodtrigger">trigger</a></li>
  81. </ul>
  82. </td>
  83. </tr></table>
  84. <hr />
  85. <table width="100%" border="0"><tr>
  86. </tr></table>
  87. <hr />
  88. <a name="class_details"></a>
  89. <h3>Class Details</h3>
  90. <div class="tags">
  91. [line 9]<br />
  92. Event handling class.<br /><br /><br /><br />
  93. <h4>Tags:</h4>
  94. <div class="tags">
  95. <table border="0" cellspacing="0" cellpadding="0">
  96. <tr>
  97. <td><b>author:</b>&nbsp;&nbsp;</td><td>Tobiasz Cudnik</td>
  98. </tr>
  99. <tr>
  100. <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
  101. </tr>
  102. </table>
  103. </div>
  104. </div><br /><br />
  105. <div class="top">[ <a href="#top">Top</a> ]</div><br />
  106. <hr />
  107. <a name="class_methods"></a>
  108. <h3>Class Methods</h3>
  109. <div class="tags">
  110. <hr />
  111. <a name="methodadd"></a>
  112. <h3>static method add <span class="smalllinenumber">[line 96]</span></h3>
  113. <div class="function">
  114. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  115. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  116. <code>static void add(
  117. DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string
  118. $document,
  119. $node, unknown_type
  120. $type, unknown_type
  121. $data, [unknown_type
  122. $callback = null])</code>
  123. </td></tr></table>
  124. </td></tr></table><br />
  125. Binds a handler to one or more events (like click) for each matched element.<br /><br /><p>Can also bind custom events.</p><br /><br /><br />
  126. <h4>Tags:</h4>
  127. <div class="tags">
  128. <table border="0" cellspacing="0" cellpadding="0">
  129. <tr>
  130. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>support binding to global events</td>
  131. </tr>
  132. <tr>
  133. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>support '!' (exclusive) events</td>
  134. </tr>
  135. <tr>
  136. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>support more than event in $type (space-separated)</td>
  137. </tr>
  138. <tr>
  139. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  140. </tr>
  141. </table>
  142. </div>
  143. <br /><br />
  144. <h4>Parameters:</h4>
  145. <div class="tags">
  146. <table border="0" cellspacing="0" cellpadding="0">
  147. <tr>
  148. <td class="type">DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string&nbsp;&nbsp;</td>
  149. <td><b>$document</b>&nbsp;&nbsp;</td>
  150. <td></td>
  151. </tr>
  152. <tr>
  153. <td class="type">unknown_type&nbsp;&nbsp;</td>
  154. <td><b>$type</b>&nbsp;&nbsp;</td>
  155. <td></td>
  156. </tr>
  157. <tr>
  158. <td class="type">unknown_type&nbsp;&nbsp;</td>
  159. <td><b>$data</b>&nbsp;&nbsp;</td>
  160. <td>Optional</td>
  161. </tr>
  162. <tr>
  163. <td class="type">unknown_type&nbsp;&nbsp;</td>
  164. <td><b>$callback</b>&nbsp;&nbsp;</td>
  165. <td></td>
  166. </tr>
  167. <tr>
  168. <td class="type">&nbsp;&nbsp;</td>
  169. <td><b>$node</b>&nbsp;&nbsp;</td>
  170. <td></td>
  171. </tr>
  172. </table>
  173. </div><br />
  174. <div class="top">[ <a href="#top">Top</a> ]</div>
  175. </div>
  176. <hr />
  177. <a name="methodgetNode"></a>
  178. <h3>static method getNode <span class="smalllinenumber">[line 136]</span></h3>
  179. <div class="function">
  180. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  181. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  182. <code>static void getNode(
  183. $documentID,
  184. $node)</code>
  185. </td></tr></table>
  186. </td></tr></table><br />
  187. <br /><br />
  188. <h4>Tags:</h4>
  189. <div class="tags">
  190. <table border="0" cellspacing="0" cellpadding="0">
  191. <tr>
  192. <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  193. </tr>
  194. </table>
  195. </div>
  196. <br /><br />
  197. <h4>Parameters:</h4>
  198. <div class="tags">
  199. <table border="0" cellspacing="0" cellpadding="0">
  200. <tr>
  201. <td class="type">&nbsp;&nbsp;</td>
  202. <td><b>$documentID</b>&nbsp;&nbsp;</td>
  203. <td></td>
  204. </tr>
  205. <tr>
  206. <td class="type">&nbsp;&nbsp;</td>
  207. <td><b>$node</b>&nbsp;&nbsp;</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><br />
  212. <div class="top">[ <a href="#top">Top</a> ]</div>
  213. </div>
  214. <hr />
  215. <a name="methodissetGlobal"></a>
  216. <h3>static method issetGlobal <span class="smalllinenumber">[line 148]</span></h3>
  217. <div class="function">
  218. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  219. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  220. <code>static void issetGlobal(
  221. $documentID,
  222. $type)</code>
  223. </td></tr></table>
  224. </td></tr></table><br />
  225. <br /><br />
  226. <h4>Tags:</h4>
  227. <div class="tags">
  228. <table border="0" cellspacing="0" cellpadding="0">
  229. <tr>
  230. <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  231. </tr>
  232. </table>
  233. </div>
  234. <br /><br />
  235. <h4>Parameters:</h4>
  236. <div class="tags">
  237. <table border="0" cellspacing="0" cellpadding="0">
  238. <tr>
  239. <td class="type">&nbsp;&nbsp;</td>
  240. <td><b>$documentID</b>&nbsp;&nbsp;</td>
  241. <td></td>
  242. </tr>
  243. <tr>
  244. <td class="type">&nbsp;&nbsp;</td>
  245. <td><b>$type</b>&nbsp;&nbsp;</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><br />
  250. <div class="top">[ <a href="#top">Top</a> ]</div>
  251. </div>
  252. <hr />
  253. <a name="methodremove"></a>
  254. <h3>static method remove <span class="smalllinenumber">[line 123]</span></h3>
  255. <div class="function">
  256. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  257. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  258. <code>static void remove(
  259. DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string
  260. $document,
  261. $node, [unknown_type
  262. $type = null], [unknown_type
  263. $callback = null])</code>
  264. </td></tr></table>
  265. </td></tr></table><br />
  266. Enter description here...<br /><br /><br /><br />
  267. <h4>Tags:</h4>
  268. <div class="tags">
  269. <table border="0" cellspacing="0" cellpadding="0">
  270. <tr>
  271. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>support more than event in $type (space-separated)</td>
  272. </tr>
  273. <tr>
  274. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>namespace events</td>
  275. </tr>
  276. <tr>
  277. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  278. </tr>
  279. </table>
  280. </div>
  281. <br /><br />
  282. <h4>Parameters:</h4>
  283. <div class="tags">
  284. <table border="0" cellspacing="0" cellpadding="0">
  285. <tr>
  286. <td class="type">DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string&nbsp;&nbsp;</td>
  287. <td><b>$document</b>&nbsp;&nbsp;</td>
  288. <td></td>
  289. </tr>
  290. <tr>
  291. <td class="type">unknown_type&nbsp;&nbsp;</td>
  292. <td><b>$type</b>&nbsp;&nbsp;</td>
  293. <td></td>
  294. </tr>
  295. <tr>
  296. <td class="type">unknown_type&nbsp;&nbsp;</td>
  297. <td><b>$callback</b>&nbsp;&nbsp;</td>
  298. <td></td>
  299. </tr>
  300. <tr>
  301. <td class="type">&nbsp;&nbsp;</td>
  302. <td><b>$node</b>&nbsp;&nbsp;</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </div><br />
  307. <div class="top">[ <a href="#top">Top</a> ]</div>
  308. </div>
  309. <hr />
  310. <a name="methodsetNode"></a>
  311. <h3>static method setNode <span class="smalllinenumber">[line 142]</span></h3>
  312. <div class="function">
  313. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  314. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  315. <code>static void setNode(
  316. $documentID,
  317. $node)</code>
  318. </td></tr></table>
  319. </td></tr></table><br />
  320. <br /><br />
  321. <h4>Tags:</h4>
  322. <div class="tags">
  323. <table border="0" cellspacing="0" cellpadding="0">
  324. <tr>
  325. <td><b>access:</b>&nbsp;&nbsp;</td><td>protected</td>
  326. </tr>
  327. </table>
  328. </div>
  329. <br /><br />
  330. <h4>Parameters:</h4>
  331. <div class="tags">
  332. <table border="0" cellspacing="0" cellpadding="0">
  333. <tr>
  334. <td class="type">&nbsp;&nbsp;</td>
  335. <td><b>$documentID</b>&nbsp;&nbsp;</td>
  336. <td></td>
  337. </tr>
  338. <tr>
  339. <td class="type">&nbsp;&nbsp;</td>
  340. <td><b>$node</b>&nbsp;&nbsp;</td>
  341. <td></td>
  342. </tr>
  343. </table>
  344. </div><br />
  345. <div class="top">[ <a href="#top">Top</a> ]</div>
  346. </div>
  347. <hr />
  348. <a name="methodtrigger"></a>
  349. <h3>static method trigger <span class="smalllinenumber">[line 21]</span></h3>
  350. <div class="function">
  351. <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
  352. <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
  353. <code>static void trigger(
  354. DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string
  355. $document, unknown_type
  356. $type, [unknown_type
  357. $data = array()], [
  358. $node = null])</code>
  359. </td></tr></table>
  360. </td></tr></table><br />
  361. Trigger a type of event on every matched element.<br /><br /><br /><br />
  362. <h4>Tags:</h4>
  363. <div class="tags">
  364. <table border="0" cellspacing="0" cellpadding="0">
  365. <tr>
  366. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>support more than event in $type (space-separated)</td>
  367. </tr>
  368. <tr>
  369. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>exclusive events (with !)</td>
  370. </tr>
  371. <tr>
  372. <td><b>TODO:</b>&nbsp;&nbsp;</td><td>global events (test)</td>
  373. </tr>
  374. <tr>
  375. <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  376. </tr>
  377. </table>
  378. </div>
  379. <br /><br />
  380. <h4>Parameters:</h4>
  381. <div class="tags">
  382. <table border="0" cellspacing="0" cellpadding="0">
  383. <tr>
  384. <td class="type">DOMNode|<a href="../phpQuery/phpQueryObject.html">phpQueryObject</a>|string&nbsp;&nbsp;</td>
  385. <td><b>$document</b>&nbsp;&nbsp;</td>
  386. <td></td>
  387. </tr>
  388. <tr>
  389. <td class="type">unknown_type&nbsp;&nbsp;</td>
  390. <td><b>$type</b>&nbsp;&nbsp;</td>
  391. <td></td>
  392. </tr>
  393. <tr>
  394. <td class="type">unknown_type&nbsp;&nbsp;</td>
  395. <td><b>$data</b>&nbsp;&nbsp;</td>
  396. <td></td>
  397. </tr>
  398. <tr>
  399. <td class="type">&nbsp;&nbsp;</td>
  400. <td><b>$node</b>&nbsp;&nbsp;</td>
  401. <td></td>
  402. </tr>
  403. </table>
  404. </div><br />
  405. <div class="top">[ <a href="#top">Top</a> ]</div>
  406. </div>
  407. </div><br />
  408. <div class="credit">
  409. <hr />
  410. Documentation generated on Tue, 18 Nov 2008 19:39:26 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
  411. </div>
  412. </td></tr></table>
  413. </td>
  414. </tr>
  415. </table>
  416. </body>
  417. </html>