EventManagerTest.php 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811
  1. <?php
  2. /**
  3. * CakePHP : Rapid Development Framework (http://cakephp.org)
  4. * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  5. *
  6. * Licensed under The MIT License
  7. * For full copyright and license information, please see the LICENSE.txt
  8. * Redistributions of files must retain the above copyright notice.
  9. *
  10. * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
  11. * @link http://cakephp.org CakePHP Project
  12. * @since 2.1.0
  13. * @license http://www.opensource.org/licenses/mit-license.php MIT License
  14. */
  15. namespace Cake\Test\TestCase\Event;
  16. use Cake\Event\Event;
  17. use Cake\Event\EventList;
  18. use Cake\Event\EventListenerInterface;
  19. use Cake\Event\EventManager;
  20. use Cake\TestSuite\TestCase;
  21. /**
  22. * Mock class used to test event dispatching
  23. */
  24. class EventTestListener
  25. {
  26. public $callList = [];
  27. /**
  28. * Test function to be used in event dispatching
  29. *
  30. * @return void
  31. */
  32. public function listenerFunction()
  33. {
  34. $this->callList[] = __FUNCTION__;
  35. }
  36. /**
  37. * Test function to be used in event dispatching
  38. *
  39. * @return void
  40. */
  41. public function secondListenerFunction()
  42. {
  43. $this->callList[] = __FUNCTION__;
  44. }
  45. /**
  46. * Auxiliary function to help in stopPropagation testing
  47. *
  48. * @param \Cake\Event\Event $event
  49. * @return void
  50. */
  51. public function stopListener($event)
  52. {
  53. $event->stopPropagation();
  54. }
  55. }
  56. /**
  57. * Mock used for testing the subscriber objects
  58. */
  59. class CustomTestEventListenerInterface extends EventTestListener implements EventListenerInterface
  60. {
  61. public function implementedEvents()
  62. {
  63. return [
  64. 'fake.event' => 'listenerFunction',
  65. 'another.event' => ['callable' => 'secondListenerFunction'],
  66. 'multiple.handlers' => [
  67. ['callable' => 'listenerFunction'],
  68. ['callable' => 'thirdListenerFunction']
  69. ]
  70. ];
  71. }
  72. /**
  73. * Test function to be used in event dispatching
  74. *
  75. * @return void
  76. */
  77. public function thirdListenerFunction()
  78. {
  79. $this->callList[] = __FUNCTION__;
  80. }
  81. }
  82. /**
  83. * Tests the Cake\Event\EventManager class functionality
  84. */
  85. class EventManagerTest extends TestCase
  86. {
  87. /**
  88. * Tests the attach() method for a single event key in multiple queues
  89. *
  90. * @return void
  91. */
  92. public function testAttachListeners()
  93. {
  94. $manager = new EventManager();
  95. $manager->attach('fakeFunction', 'fake.event');
  96. $expected = [
  97. ['callable' => 'fakeFunction']
  98. ];
  99. $this->assertEquals($expected, $manager->listeners('fake.event'));
  100. $manager->attach('fakeFunction2', 'fake.event');
  101. $expected[] = ['callable' => 'fakeFunction2'];
  102. $this->assertEquals($expected, $manager->listeners('fake.event'));
  103. $manager->attach('inQ5', 'fake.event', ['priority' => 5]);
  104. $manager->attach('inQ1', 'fake.event', ['priority' => 1]);
  105. $manager->attach('otherInQ5', 'fake.event', ['priority' => 5]);
  106. $expected = array_merge(
  107. [
  108. ['callable' => 'inQ1'],
  109. ['callable' => 'inQ5'],
  110. ['callable' => 'otherInQ5']
  111. ],
  112. $expected
  113. );
  114. $this->assertEquals($expected, $manager->listeners('fake.event'));
  115. }
  116. /**
  117. * Tests the attach() method for multiple event key in multiple queues
  118. *
  119. * @return void
  120. */
  121. public function testAttachMultipleEventKeys()
  122. {
  123. $manager = new EventManager();
  124. $manager->attach('fakeFunction', 'fake.event');
  125. $manager->attach('fakeFunction2', 'another.event');
  126. $manager->attach('fakeFunction3', 'another.event', ['priority' => 1]);
  127. $expected = [
  128. ['callable' => 'fakeFunction']
  129. ];
  130. $this->assertEquals($expected, $manager->listeners('fake.event'));
  131. $expected = [
  132. ['callable' => 'fakeFunction3'],
  133. ['callable' => 'fakeFunction2']
  134. ];
  135. $this->assertEquals($expected, $manager->listeners('another.event'));
  136. }
  137. /**
  138. * Tests attached event listeners for matching key pattern
  139. *
  140. * @return void
  141. */
  142. public function testMatchingListeners()
  143. {
  144. $manager = new EventManager();
  145. $manager->attach('fakeFunction1', 'fake.event');
  146. $manager->attach('fakeFunction2', 'real.event');
  147. $manager->attach('fakeFunction3', 'test.event');
  148. $manager->attach('fakeFunction4', 'event.test');
  149. $this->assertArrayHasKey('fake.event', $manager->matchingListeners('fake.event'));
  150. $this->assertArrayHasKey('real.event', $manager->matchingListeners('real.event'));
  151. $this->assertArrayHasKey('test.event', $manager->matchingListeners('test.event'));
  152. $this->assertArrayHasKey('event.test', $manager->matchingListeners('event.test'));
  153. $this->assertArrayHasKey('fake.event', $manager->matchingListeners('fake'));
  154. $this->assertArrayHasKey('real.event', $manager->matchingListeners('real'));
  155. $this->assertArrayHasKey('test.event', $manager->matchingListeners('test'));
  156. $this->assertArrayHasKey('event.test', $manager->matchingListeners('test'));
  157. $this->assertArrayHasKey('fake.event', $manager->matchingListeners('event'));
  158. $this->assertArrayHasKey('real.event', $manager->matchingListeners('event'));
  159. $this->assertArrayHasKey('test.event', $manager->matchingListeners('event'));
  160. $this->assertArrayHasKey('event.test', $manager->matchingListeners('event'));
  161. $this->assertArrayHasKey('fake.event', $manager->matchingListeners('.event'));
  162. $this->assertArrayHasKey('real.event', $manager->matchingListeners('.event'));
  163. $this->assertArrayHasKey('test.event', $manager->matchingListeners('.event'));
  164. $this->assertArrayHasKey('test.event', $manager->matchingListeners('test.'));
  165. $this->assertArrayHasKey('event.test', $manager->matchingListeners('.test'));
  166. $this->assertEmpty($manager->matchingListeners('/test'));
  167. $this->assertEmpty($manager->matchingListeners('test/'));
  168. $this->assertEmpty($manager->matchingListeners('/test/'));
  169. $this->assertEmpty($manager->matchingListeners('test$'));
  170. $this->assertEmpty($manager->matchingListeners('ev.nt'));
  171. $this->assertEmpty($manager->matchingListeners('^test'));
  172. $this->assertEmpty($manager->matchingListeners('^event'));
  173. $this->assertEmpty($manager->matchingListeners('*event'));
  174. $this->assertEmpty($manager->matchingListeners('event*'));
  175. $this->assertEmpty($manager->matchingListeners('foo'));
  176. $expected = ['fake.event', 'real.event', 'test.event', 'event.test'];
  177. $result = $manager->matchingListeners('event');
  178. $this->assertNotEmpty($result);
  179. $this->assertSame($expected, array_keys($result));
  180. $expected = ['fake.event', 'real.event', 'test.event'];
  181. $result = $manager->matchingListeners('.event');
  182. $this->assertNotEmpty($result);
  183. $this->assertSame($expected, array_keys($result));
  184. $expected = ['test.event', 'event.test'];
  185. $result = $manager->matchingListeners('test');
  186. $this->assertNotEmpty($result);
  187. $this->assertSame($expected, array_keys($result));
  188. $expected = ['test.event'];
  189. $result = $manager->matchingListeners('test.');
  190. $this->assertNotEmpty($result);
  191. $this->assertSame($expected, array_keys($result));
  192. $expected = ['event.test'];
  193. $result = $manager->matchingListeners('.test');
  194. $this->assertNotEmpty($result);
  195. $this->assertSame($expected, array_keys($result));
  196. }
  197. /**
  198. * Test the on() method for basic callable types.
  199. *
  200. * @return void
  201. */
  202. public function testOn()
  203. {
  204. $count = 1;
  205. $manager = new EventManager();
  206. $manager->on('my.event', 'myfunc');
  207. $expected = [
  208. ['callable' => 'myfunc']
  209. ];
  210. $this->assertSame($expected, $manager->listeners('my.event'));
  211. $manager->on('my.event', ['priority' => 1], 'func2');
  212. $expected = [
  213. ['callable' => 'func2'],
  214. ['callable' => 'myfunc'],
  215. ];
  216. $this->assertSame($expected, $manager->listeners('my.event'));
  217. $listener = new CustomTestEventListenerInterface();
  218. $manager->on($listener);
  219. $expected = [
  220. ['callable' => [$listener, 'listenerFunction']],
  221. ];
  222. $this->assertEquals($expected, $manager->listeners('fake.event'));
  223. }
  224. /**
  225. * Tests off'ing an event from a event key queue
  226. *
  227. * @return void
  228. */
  229. public function testOff()
  230. {
  231. $manager = new EventManager();
  232. $manager->on('fake.event', ['AClass', 'aMethod']);
  233. $manager->on('another.event', ['AClass', 'anotherMethod']);
  234. $manager->on('another.event', ['priority' => 1], 'fakeFunction');
  235. $manager->off('fake.event', ['AClass', 'aMethod']);
  236. $this->assertEquals([], $manager->listeners('fake.event'));
  237. $manager->off('another.event', ['AClass', 'anotherMethod']);
  238. $expected = [
  239. ['callable' => 'fakeFunction']
  240. ];
  241. $this->assertEquals($expected, $manager->listeners('another.event'));
  242. $manager->off('another.event', 'fakeFunction');
  243. $this->assertEquals([], $manager->listeners('another.event'));
  244. }
  245. /**
  246. * Tests off'ing an event from all event queues
  247. *
  248. * @return void
  249. */
  250. public function testOffFromAll()
  251. {
  252. $manager = new EventManager();
  253. $manager->on('fake.event', ['AClass', 'aMethod']);
  254. $manager->on('another.event', ['AClass', 'aMethod']);
  255. $manager->on('another.event', ['priority' => 1], 'fakeFunction');
  256. $manager->off(['AClass', 'aMethod']);
  257. $expected = [
  258. ['callable' => 'fakeFunction']
  259. ];
  260. $this->assertEquals($expected, $manager->listeners('another.event'));
  261. $this->assertEquals([], $manager->listeners('fake.event'));
  262. }
  263. /**
  264. * Tests off'ing all listeners for an event
  265. */
  266. public function testRemoveAllListeners()
  267. {
  268. $manager = new EventManager();
  269. $manager->on('fake.event', ['AClass', 'aMethod']);
  270. $manager->on('another.event', ['priority' => 1], 'fakeFunction');
  271. $manager->off('fake.event');
  272. $expected = [
  273. ['callable' => 'fakeFunction']
  274. ];
  275. $this->assertEquals($expected, $manager->listeners('another.event'));
  276. $this->assertEquals([], $manager->listeners('fake.event'));
  277. }
  278. /**
  279. * Tests detaching an event from a event key queue
  280. *
  281. * @return void
  282. */
  283. public function testDetach()
  284. {
  285. $manager = new EventManager();
  286. $manager->attach(['AClass', 'aMethod'], 'fake.event');
  287. $manager->attach(['AClass', 'anotherMethod'], 'another.event');
  288. $manager->attach('fakeFunction', 'another.event', ['priority' => 1]);
  289. $manager->detach(['AClass', 'aMethod'], 'fake.event');
  290. $this->assertEquals([], $manager->listeners('fake.event'));
  291. $manager->detach(['AClass', 'anotherMethod'], 'another.event');
  292. $expected = [
  293. ['callable' => 'fakeFunction']
  294. ];
  295. $this->assertEquals($expected, $manager->listeners('another.event'));
  296. $manager->detach('fakeFunction', 'another.event');
  297. $this->assertEquals([], $manager->listeners('another.event'));
  298. }
  299. /**
  300. * Tests detaching an event from all event queues
  301. *
  302. * @return void
  303. */
  304. public function testDetachFromAll()
  305. {
  306. $manager = new EventManager();
  307. $manager->attach(['AClass', 'aMethod'], 'fake.event');
  308. $manager->attach(['AClass', 'aMethod'], 'another.event');
  309. $manager->attach('fakeFunction', 'another.event', ['priority' => 1]);
  310. $manager->detach(['AClass', 'aMethod']);
  311. $expected = [
  312. ['callable' => 'fakeFunction']
  313. ];
  314. $this->assertEquals($expected, $manager->listeners('another.event'));
  315. $this->assertEquals([], $manager->listeners('fake.event'));
  316. }
  317. /**
  318. * Tests event dispatching
  319. *
  320. * @return void
  321. * @triggers fake.event
  322. */
  323. public function testDispatch()
  324. {
  325. $manager = new EventManager();
  326. $listener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  327. ->getMock();
  328. $anotherListener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  329. ->getMock();
  330. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  331. $manager->attach([$anotherListener, 'listenerFunction'], 'fake.event');
  332. $event = new Event('fake.event');
  333. $listener->expects($this->once())->method('listenerFunction')->with($event);
  334. $anotherListener->expects($this->once())->method('listenerFunction')->with($event);
  335. $manager->dispatch($event);
  336. }
  337. /**
  338. * Tests event dispatching using event key name
  339. *
  340. * @return void
  341. */
  342. public function testDispatchWithKeyName()
  343. {
  344. $manager = new EventManager();
  345. $listener = new EventTestListener;
  346. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  347. $event = 'fake.event';
  348. $manager->dispatch($event);
  349. $expected = ['listenerFunction'];
  350. $this->assertEquals($expected, $listener->callList);
  351. }
  352. /**
  353. * Tests event dispatching with a return value
  354. *
  355. * @return void
  356. * @triggers fake.event
  357. */
  358. public function testDispatchReturnValue()
  359. {
  360. $this->skipIf(
  361. version_compare(\PHPUnit_Runner_Version::id(), '3.7', '<'),
  362. 'These tests fail in PHPUnit 3.6'
  363. );
  364. $manager = new EventManager;
  365. $listener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  366. ->getMock();
  367. $anotherListener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  368. ->getMock();
  369. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  370. $manager->attach([$anotherListener, 'listenerFunction'], 'fake.event');
  371. $event = new Event('fake.event');
  372. $listener->expects($this->at(0))->method('listenerFunction')
  373. ->with($event)
  374. ->will($this->returnValue('something special'));
  375. $anotherListener->expects($this->at(0))
  376. ->method('listenerFunction')
  377. ->with($event);
  378. $manager->dispatch($event);
  379. $this->assertEquals('something special', $event->result());
  380. }
  381. /**
  382. * Tests that returning false in a callback stops the event
  383. *
  384. * @return void
  385. * @triggers fake.event
  386. */
  387. public function testDispatchFalseStopsEvent()
  388. {
  389. $this->skipIf(
  390. version_compare(\PHPUnit_Runner_Version::id(), '3.7', '<'),
  391. 'These tests fail in PHPUnit 3.6'
  392. );
  393. $manager = new EventManager();
  394. $listener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  395. ->getMock();
  396. $anotherListener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  397. ->getMock();
  398. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  399. $manager->attach([$anotherListener, 'listenerFunction'], 'fake.event');
  400. $event = new Event('fake.event');
  401. $listener->expects($this->at(0))->method('listenerFunction')
  402. ->with($event)
  403. ->will($this->returnValue(false));
  404. $anotherListener->expects($this->never())
  405. ->method('listenerFunction');
  406. $manager->dispatch($event);
  407. $this->assertTrue($event->isStopped());
  408. }
  409. /**
  410. * Tests event dispatching using priorities
  411. *
  412. * @return void
  413. * @triggers fake.event
  414. */
  415. public function testDispatchPrioritized()
  416. {
  417. $manager = new EventManager();
  418. $listener = new EventTestListener;
  419. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  420. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event', ['priority' => 5]);
  421. $event = new Event('fake.event');
  422. $manager->dispatch($event);
  423. $expected = ['secondListenerFunction', 'listenerFunction'];
  424. $this->assertEquals($expected, $listener->callList);
  425. }
  426. /**
  427. * Tests subscribing a listener object and firing the events it subscribed to
  428. *
  429. * @return void
  430. * @triggers fake.event
  431. * @triggers another.event $this, array(some => data)
  432. */
  433. public function testAttachSubscriber()
  434. {
  435. $manager = new EventManager();
  436. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  437. ->setMethods(['secondListenerFunction'])
  438. ->getMock();
  439. $manager->attach($listener);
  440. $event = new Event('fake.event');
  441. $manager->dispatch($event);
  442. $expected = ['listenerFunction'];
  443. $this->assertEquals($expected, $listener->callList);
  444. $event = new Event('another.event', $this, ['some' => 'data']);
  445. $listener->expects($this->at(0))
  446. ->method('secondListenerFunction')
  447. ->with($event, 'data');
  448. $manager->dispatch($event);
  449. }
  450. /**
  451. * Test implementedEvents binding multiple callbacks to the same event name.
  452. *
  453. * @return void
  454. * @triggers multiple.handlers
  455. */
  456. public function testAttachSubscriberMultiple()
  457. {
  458. $manager = new EventManager();
  459. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  460. ->setMethods(['listenerFunction', 'thirdListenerFunction'])
  461. ->getMock();
  462. $manager->attach($listener);
  463. $event = new Event('multiple.handlers');
  464. $listener->expects($this->once())
  465. ->method('listenerFunction')
  466. ->with($event);
  467. $listener->expects($this->once())
  468. ->method('thirdListenerFunction')
  469. ->with($event);
  470. $manager->dispatch($event);
  471. }
  472. /**
  473. * Tests subscribing a listener object and firing the events it subscribed to
  474. *
  475. * @return void
  476. */
  477. public function testDetachSubscriber()
  478. {
  479. $manager = new EventManager();
  480. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  481. ->setMethods(['secondListenerFunction'])
  482. ->getMock();
  483. $manager->attach($listener);
  484. $expected = [
  485. ['callable' => [$listener, 'secondListenerFunction']]
  486. ];
  487. $this->assertEquals($expected, $manager->listeners('another.event'));
  488. $expected = [
  489. ['callable' => [$listener, 'listenerFunction']]
  490. ];
  491. $this->assertEquals($expected, $manager->listeners('fake.event'));
  492. $manager->detach($listener);
  493. $this->assertEquals([], $manager->listeners('fake.event'));
  494. $this->assertEquals([], $manager->listeners('another.event'));
  495. }
  496. /**
  497. * Tests that it is possible to get/set the manager singleton
  498. *
  499. * @return void
  500. */
  501. public function testGlobalDispatcherGetter()
  502. {
  503. $this->assertInstanceOf('Cake\Event\EventManager', EventManager::instance());
  504. $manager = new EventManager();
  505. EventManager::instance($manager);
  506. $this->assertSame($manager, EventManager::instance());
  507. }
  508. /**
  509. * Tests that the global event manager gets the event too from any other manager
  510. *
  511. * @return void
  512. * @triggers fake.event
  513. */
  514. public function testDispatchWithGlobal()
  515. {
  516. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')
  517. ->setMethods(['prioritisedListeners'])
  518. ->getMock();
  519. $manager = new EventManager();
  520. $event = new Event('fake.event');
  521. EventManager::instance($generalManager);
  522. $generalManager->expects($this->once())->method('prioritisedListeners')->with('fake.event');
  523. $manager->dispatch($event);
  524. EventManager::instance(new EventManager());
  525. }
  526. /**
  527. * Tests that stopping an event will not notify the rest of the listeners
  528. *
  529. * @return void
  530. * @triggers fake.event
  531. */
  532. public function testStopPropagation()
  533. {
  534. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  535. $manager = new EventManager();
  536. $listener = new EventTestListener();
  537. EventManager::instance($generalManager);
  538. $generalManager->expects($this->any())
  539. ->method('prioritisedListeners')
  540. ->with('fake.event')
  541. ->will($this->returnValue([]));
  542. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  543. $manager->attach([$listener, 'stopListener'], 'fake.event', ['priority' => 8]);
  544. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event', ['priority' => 5]);
  545. $event = new Event('fake.event');
  546. $manager->dispatch($event);
  547. $expected = ['secondListenerFunction'];
  548. $this->assertEquals($expected, $listener->callList);
  549. EventManager::instance(new EventManager());
  550. }
  551. /**
  552. * Tests event dispatching using priorities
  553. *
  554. * @return void
  555. * @triggers fake.event
  556. */
  557. public function testDispatchPrioritizedWithGlobal()
  558. {
  559. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  560. $manager = new EventManager();
  561. $listener = new CustomTestEventListenerInterface();
  562. $event = new Event('fake.event');
  563. EventManager::instance($generalManager);
  564. $generalManager->expects($this->any())
  565. ->method('prioritisedListeners')
  566. ->with('fake.event')
  567. ->will($this->returnValue(
  568. [11 => [
  569. ['callable' => [$listener, 'secondListenerFunction']]
  570. ]]
  571. ));
  572. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  573. $manager->attach([$listener, 'thirdListenerFunction'], 'fake.event', ['priority' => 15]);
  574. $manager->dispatch($event);
  575. $expected = ['listenerFunction', 'secondListenerFunction', 'thirdListenerFunction'];
  576. $this->assertEquals($expected, $listener->callList);
  577. EventManager::instance(new EventManager());
  578. }
  579. /**
  580. * Tests event dispatching using priorities
  581. *
  582. * @return void
  583. * @triggers fake.event
  584. */
  585. public function testDispatchGlobalBeforeLocal()
  586. {
  587. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  588. $manager = new EventManager();
  589. $listener = new CustomTestEventListenerInterface();
  590. $event = new Event('fake.event');
  591. EventManager::instance($generalManager);
  592. $generalManager->expects($this->any())
  593. ->method('prioritisedListeners')
  594. ->with('fake.event')
  595. ->will($this->returnValue(
  596. [10 => [
  597. ['callable' => [$listener, 'listenerFunction']]
  598. ]]
  599. ));
  600. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event');
  601. $manager->dispatch($event);
  602. $expected = ['listenerFunction', 'secondListenerFunction'];
  603. $this->assertEquals($expected, $listener->callList);
  604. EventManager::instance(new EventManager());
  605. }
  606. /**
  607. * test callback
  608. */
  609. public function onMyEvent($event)
  610. {
  611. $event->data['callback'] = 'ok';
  612. }
  613. /**
  614. * Tests events dispatched by a local manager can be handled by
  615. * handler registered in the global event manager
  616. * @triggers my_event $manager
  617. */
  618. public function testDispatchLocalHandledByGlobal()
  619. {
  620. $callback = [$this, 'onMyEvent'];
  621. EventManager::instance()->attach($callback, 'my_event');
  622. $manager = new EventManager();
  623. $event = new Event('my_event', $manager);
  624. $manager->dispatch($event);
  625. $this->assertEquals('ok', $event->data('callback'));
  626. }
  627. /**
  628. * Test that events are dispatched properly when there are global and local
  629. * listeners at the same priority.
  630. *
  631. * @return void
  632. * @triggers fake.event $this
  633. */
  634. public function testDispatchWithGlobalAndLocalEvents()
  635. {
  636. $listener = new CustomTestEventListenerInterface();
  637. EventManager::instance()->attach($listener);
  638. $listener2 = new EventTestListener();
  639. $manager = new EventManager();
  640. $manager->attach([$listener2, 'listenerFunction'], 'fake.event');
  641. $manager->dispatch(new Event('fake.event', $this));
  642. $this->assertEquals(['listenerFunction'], $listener->callList);
  643. $this->assertEquals(['listenerFunction'], $listener2->callList);
  644. }
  645. /**
  646. * Test getting a list of dispatched events from the manager.
  647. *
  648. * @return void
  649. * @triggers my_event $this
  650. * @triggers my_second_event $this
  651. */
  652. public function testGetDispatchedEvents()
  653. {
  654. $eventList = new EventList();
  655. $event = new Event('my_event', $this);
  656. $event2 = new Event('my_second_event', $this);
  657. $manager = new EventManager();
  658. $manager->setEventList($eventList);
  659. $manager->dispatch($event);
  660. $manager->dispatch($event2);
  661. $result = $manager->getEventList();
  662. $this->assertInstanceOf('\Cake\Event\EventList', $result);
  663. $this->assertCount(2, $result);
  664. $this->assertEquals($result[0], $event);
  665. $this->assertEquals($result[1], $event2);
  666. $manager->getEventList()->flush();
  667. $result = $manager->getEventList();
  668. $this->assertCount(0, $result);
  669. $manager->unsetEventList();
  670. $manager->dispatch($event);
  671. $manager->dispatch($event2);
  672. $result = $manager->getEventList();
  673. $this->assertNull($result);
  674. }
  675. /**
  676. * Test that locally dispatched events are also added to the global manager's event list
  677. *
  678. * @return void
  679. * @triggers Event $this
  680. */
  681. public function testGetLocallyDispatchedEventsFromGlobal()
  682. {
  683. $localList = new EventList();
  684. $globalList = new EventList();
  685. $globalManager = EventManager::instance();
  686. $globalManager->setEventList($globalList);
  687. $localManager = new EventManager();
  688. $localManager->setEventList($localList);
  689. $globalEvent = new Event('GlobalEvent', $this);
  690. $globalManager->dispatch($globalEvent);
  691. $localEvent = new Event('LocalEvent', $this);
  692. $localManager->dispatch($localEvent);
  693. $this->assertTrue($globalList->hasEvent('GlobalEvent'));
  694. $this->assertFalse($localList->hasEvent('GlobalEvent'));
  695. $this->assertTrue($localList->hasEvent('LocalEvent'));
  696. $this->assertTrue($globalList->hasEvent('LocalEvent'));
  697. }
  698. /**
  699. * Test isTrackingEvents
  700. *
  701. * @return void
  702. */
  703. public function testIsTrackingEvents()
  704. {
  705. $this->assertFalse(EventManager::instance()->isTrackingEvents());
  706. $manager = new EventManager();
  707. $manager->setEventList(new EventList());
  708. $this->assertTrue($manager->isTrackingEvents());
  709. $manager->trackEvents(false);
  710. $this->assertFalse($manager->isTrackingEvents());
  711. }
  712. }