EventManagerTest.php 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923
  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. $manager = new EventManager;
  361. $listener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  362. ->getMock();
  363. $anotherListener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  364. ->getMock();
  365. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  366. $manager->attach([$anotherListener, 'listenerFunction'], 'fake.event');
  367. $event = new Event('fake.event');
  368. $listener->expects($this->at(0))->method('listenerFunction')
  369. ->with($event)
  370. ->will($this->returnValue('something special'));
  371. $anotherListener->expects($this->at(0))
  372. ->method('listenerFunction')
  373. ->with($event);
  374. $manager->dispatch($event);
  375. $this->assertEquals('something special', $event->result());
  376. }
  377. /**
  378. * Tests that returning false in a callback stops the event
  379. *
  380. * @return void
  381. * @triggers fake.event
  382. */
  383. public function testDispatchFalseStopsEvent()
  384. {
  385. $manager = new EventManager();
  386. $listener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  387. ->getMock();
  388. $anotherListener = $this->getMockBuilder(__NAMESPACE__ . '\EventTestListener')
  389. ->getMock();
  390. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  391. $manager->attach([$anotherListener, 'listenerFunction'], 'fake.event');
  392. $event = new Event('fake.event');
  393. $listener->expects($this->at(0))->method('listenerFunction')
  394. ->with($event)
  395. ->will($this->returnValue(false));
  396. $anotherListener->expects($this->never())
  397. ->method('listenerFunction');
  398. $manager->dispatch($event);
  399. $this->assertTrue($event->isStopped());
  400. }
  401. /**
  402. * Tests event dispatching using priorities
  403. *
  404. * @return void
  405. * @triggers fake.event
  406. */
  407. public function testDispatchPrioritized()
  408. {
  409. $manager = new EventManager();
  410. $listener = new EventTestListener;
  411. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  412. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event', ['priority' => 5]);
  413. $event = new Event('fake.event');
  414. $manager->dispatch($event);
  415. $expected = ['secondListenerFunction', 'listenerFunction'];
  416. $this->assertEquals($expected, $listener->callList);
  417. }
  418. /**
  419. * Tests subscribing a listener object and firing the events it subscribed to
  420. *
  421. * @return void
  422. * @triggers fake.event
  423. * @triggers another.event $this, array(some => data)
  424. */
  425. public function testAttachSubscriber()
  426. {
  427. $manager = new EventManager();
  428. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  429. ->setMethods(['secondListenerFunction'])
  430. ->getMock();
  431. $manager->attach($listener);
  432. $event = new Event('fake.event');
  433. $manager->dispatch($event);
  434. $expected = ['listenerFunction'];
  435. $this->assertEquals($expected, $listener->callList);
  436. $event = new Event('another.event', $this, ['some' => 'data']);
  437. $listener->expects($this->at(0))
  438. ->method('secondListenerFunction')
  439. ->with($event, 'data');
  440. $manager->dispatch($event);
  441. }
  442. /**
  443. * Test implementedEvents binding multiple callbacks to the same event name.
  444. *
  445. * @return void
  446. * @triggers multiple.handlers
  447. */
  448. public function testAttachSubscriberMultiple()
  449. {
  450. $manager = new EventManager();
  451. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  452. ->setMethods(['listenerFunction', 'thirdListenerFunction'])
  453. ->getMock();
  454. $manager->attach($listener);
  455. $event = new Event('multiple.handlers');
  456. $listener->expects($this->once())
  457. ->method('listenerFunction')
  458. ->with($event);
  459. $listener->expects($this->once())
  460. ->method('thirdListenerFunction')
  461. ->with($event);
  462. $manager->dispatch($event);
  463. }
  464. /**
  465. * Tests subscribing a listener object and firing the events it subscribed to
  466. *
  467. * @return void
  468. */
  469. public function testDetachSubscriber()
  470. {
  471. $manager = new EventManager();
  472. $listener = $this->getMockBuilder(__NAMESPACE__ . '\CustomTestEventListenerInterface')
  473. ->setMethods(['secondListenerFunction'])
  474. ->getMock();
  475. $manager->attach($listener);
  476. $expected = [
  477. ['callable' => [$listener, 'secondListenerFunction']]
  478. ];
  479. $this->assertEquals($expected, $manager->listeners('another.event'));
  480. $expected = [
  481. ['callable' => [$listener, 'listenerFunction']]
  482. ];
  483. $this->assertEquals($expected, $manager->listeners('fake.event'));
  484. $manager->detach($listener);
  485. $this->assertEquals([], $manager->listeners('fake.event'));
  486. $this->assertEquals([], $manager->listeners('another.event'));
  487. }
  488. /**
  489. * Tests that it is possible to get/set the manager singleton
  490. *
  491. * @return void
  492. */
  493. public function testGlobalDispatcherGetter()
  494. {
  495. $this->assertInstanceOf('Cake\Event\EventManager', EventManager::instance());
  496. $manager = new EventManager();
  497. EventManager::instance($manager);
  498. $this->assertSame($manager, EventManager::instance());
  499. }
  500. /**
  501. * Tests that the global event manager gets the event too from any other manager
  502. *
  503. * @return void
  504. * @triggers fake.event
  505. */
  506. public function testDispatchWithGlobal()
  507. {
  508. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')
  509. ->setMethods(['prioritisedListeners'])
  510. ->getMock();
  511. $manager = new EventManager();
  512. $event = new Event('fake.event');
  513. EventManager::instance($generalManager);
  514. $generalManager->expects($this->once())->method('prioritisedListeners')->with('fake.event');
  515. $manager->dispatch($event);
  516. EventManager::instance(new EventManager());
  517. }
  518. /**
  519. * Tests that stopping an event will not notify the rest of the listeners
  520. *
  521. * @return void
  522. * @triggers fake.event
  523. */
  524. public function testStopPropagation()
  525. {
  526. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  527. $manager = new EventManager();
  528. $listener = new EventTestListener();
  529. EventManager::instance($generalManager);
  530. $generalManager->expects($this->any())
  531. ->method('prioritisedListeners')
  532. ->with('fake.event')
  533. ->will($this->returnValue([]));
  534. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  535. $manager->attach([$listener, 'stopListener'], 'fake.event', ['priority' => 8]);
  536. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event', ['priority' => 5]);
  537. $event = new Event('fake.event');
  538. $manager->dispatch($event);
  539. $expected = ['secondListenerFunction'];
  540. $this->assertEquals($expected, $listener->callList);
  541. EventManager::instance(new EventManager());
  542. }
  543. /**
  544. * Tests event dispatching using priorities
  545. *
  546. * @return void
  547. * @triggers fake.event
  548. */
  549. public function testDispatchPrioritizedWithGlobal()
  550. {
  551. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  552. $manager = new EventManager();
  553. $listener = new CustomTestEventListenerInterface();
  554. $event = new Event('fake.event');
  555. EventManager::instance($generalManager);
  556. $generalManager->expects($this->any())
  557. ->method('prioritisedListeners')
  558. ->with('fake.event')
  559. ->will($this->returnValue(
  560. [11 => [
  561. ['callable' => [$listener, 'secondListenerFunction']]
  562. ]]
  563. ));
  564. $manager->attach([$listener, 'listenerFunction'], 'fake.event');
  565. $manager->attach([$listener, 'thirdListenerFunction'], 'fake.event', ['priority' => 15]);
  566. $manager->dispatch($event);
  567. $expected = ['listenerFunction', 'secondListenerFunction', 'thirdListenerFunction'];
  568. $this->assertEquals($expected, $listener->callList);
  569. EventManager::instance(new EventManager());
  570. }
  571. /**
  572. * Tests event dispatching using priorities
  573. *
  574. * @return void
  575. * @triggers fake.event
  576. */
  577. public function testDispatchGlobalBeforeLocal()
  578. {
  579. $generalManager = $this->getMockBuilder('Cake\Event\EventManager')->getMock();
  580. $manager = new EventManager();
  581. $listener = new CustomTestEventListenerInterface();
  582. $event = new Event('fake.event');
  583. EventManager::instance($generalManager);
  584. $generalManager->expects($this->any())
  585. ->method('prioritisedListeners')
  586. ->with('fake.event')
  587. ->will($this->returnValue(
  588. [10 => [
  589. ['callable' => [$listener, 'listenerFunction']]
  590. ]]
  591. ));
  592. $manager->attach([$listener, 'secondListenerFunction'], 'fake.event');
  593. $manager->dispatch($event);
  594. $expected = ['listenerFunction', 'secondListenerFunction'];
  595. $this->assertEquals($expected, $listener->callList);
  596. EventManager::instance(new EventManager());
  597. }
  598. /**
  599. * test callback
  600. *
  601. * @param Event $event
  602. */
  603. public function onMyEvent(Event $event)
  604. {
  605. $event->setData('callback', 'ok');
  606. }
  607. /**
  608. * Tests events dispatched by a local manager can be handled by
  609. * handler registered in the global event manager
  610. * @triggers my_event $manager
  611. */
  612. public function testDispatchLocalHandledByGlobal()
  613. {
  614. $callback = [$this, 'onMyEvent'];
  615. EventManager::instance()->on('my_event', $callback);
  616. $manager = new EventManager();
  617. $event = new Event('my_event', $manager);
  618. $manager->dispatch($event);
  619. $this->assertEquals('ok', $event->data('callback'));
  620. }
  621. /**
  622. * Test that events are dispatched properly when there are global and local
  623. * listeners at the same priority.
  624. *
  625. * @return void
  626. * @triggers fake.event $this
  627. */
  628. public function testDispatchWithGlobalAndLocalEvents()
  629. {
  630. $listener = new CustomTestEventListenerInterface();
  631. EventManager::instance()->on($listener);
  632. $listener2 = new EventTestListener();
  633. $manager = new EventManager();
  634. $manager->on('fake.event', [$listener2, 'listenerFunction']);
  635. $manager->dispatch(new Event('fake.event', $this));
  636. $this->assertEquals(['listenerFunction'], $listener->callList);
  637. $this->assertEquals(['listenerFunction'], $listener2->callList);
  638. }
  639. /**
  640. * Test getting a list of dispatched events from the manager.
  641. *
  642. * @return void
  643. * @triggers my_event $this
  644. * @triggers my_second_event $this
  645. */
  646. public function testGetDispatchedEvents()
  647. {
  648. $eventList = new EventList();
  649. $event = new Event('my_event', $this);
  650. $event2 = new Event('my_second_event', $this);
  651. $manager = new EventManager();
  652. $manager->setEventList($eventList);
  653. $manager->dispatch($event);
  654. $manager->dispatch($event2);
  655. $result = $manager->getEventList();
  656. $this->assertInstanceOf('\Cake\Event\EventList', $result);
  657. $this->assertCount(2, $result);
  658. $this->assertEquals($result[0], $event);
  659. $this->assertEquals($result[1], $event2);
  660. $manager->getEventList()->flush();
  661. $result = $manager->getEventList();
  662. $this->assertCount(0, $result);
  663. $manager->unsetEventList();
  664. $manager->dispatch($event);
  665. $manager->dispatch($event2);
  666. $result = $manager->getEventList();
  667. $this->assertNull($result);
  668. }
  669. /**
  670. * Test that locally dispatched events are also added to the global manager's event list
  671. *
  672. * @return void
  673. * @triggers Event $this
  674. */
  675. public function testGetLocallyDispatchedEventsFromGlobal()
  676. {
  677. $localList = new EventList();
  678. $globalList = new EventList();
  679. $globalManager = EventManager::instance();
  680. $globalManager->setEventList($globalList);
  681. $localManager = new EventManager();
  682. $localManager->setEventList($localList);
  683. $globalEvent = new Event('GlobalEvent', $this);
  684. $globalManager->dispatch($globalEvent);
  685. $localEvent = new Event('LocalEvent', $this);
  686. $localManager->dispatch($localEvent);
  687. $this->assertTrue($globalList->hasEvent('GlobalEvent'));
  688. $this->assertFalse($localList->hasEvent('GlobalEvent'));
  689. $this->assertTrue($localList->hasEvent('LocalEvent'));
  690. $this->assertTrue($globalList->hasEvent('LocalEvent'));
  691. }
  692. /**
  693. * Test isTrackingEvents
  694. *
  695. * @return void
  696. */
  697. public function testIsTrackingEvents()
  698. {
  699. $this->assertFalse(EventManager::instance()->isTrackingEvents());
  700. $manager = new EventManager();
  701. $manager->setEventList(new EventList());
  702. $this->assertTrue($manager->isTrackingEvents());
  703. $manager->trackEvents(false);
  704. $this->assertFalse($manager->isTrackingEvents());
  705. }
  706. public function testDebugInfo()
  707. {
  708. $eventManager = new EventManager();
  709. $this->assertSame(
  710. [
  711. '_listeners' => [],
  712. '_isGlobal' => false,
  713. '_eventList' => null,
  714. '_trackEvents' => false,
  715. '_generalManager' => '(object) EventManager',
  716. ],
  717. $eventManager->__debugInfo()
  718. );
  719. $func = function () {
  720. };
  721. $eventManager->on('foo', $func);
  722. $this->assertSame(
  723. [
  724. '_listeners' => [
  725. 'foo' => '1 listener(s)',
  726. ],
  727. '_isGlobal' => false,
  728. '_eventList' => null,
  729. '_trackEvents' => false,
  730. '_generalManager' => '(object) EventManager',
  731. ],
  732. $eventManager->__debugInfo()
  733. );
  734. $eventManager->off('foo', $func);
  735. $this->assertSame(
  736. [
  737. '_listeners' => [
  738. 'foo' => '0 listener(s)',
  739. ],
  740. '_isGlobal' => false,
  741. '_eventList' => null,
  742. '_trackEvents' => false,
  743. '_generalManager' => '(object) EventManager',
  744. ],
  745. $eventManager->__debugInfo()
  746. );
  747. $eventManager->on('bar', function () {
  748. });
  749. $eventManager->on('bar', function () {
  750. });
  751. $eventManager->on('bar', function () {
  752. });
  753. $eventManager->on('baz', function () {
  754. });
  755. $this->assertSame(
  756. [
  757. '_listeners' => [
  758. 'foo' => '0 listener(s)',
  759. 'bar' => '3 listener(s)',
  760. 'baz' => '1 listener(s)',
  761. ],
  762. '_isGlobal' => false,
  763. '_eventList' => null,
  764. '_trackEvents' => false,
  765. '_generalManager' => '(object) EventManager',
  766. ],
  767. $eventManager->__debugInfo()
  768. );
  769. }
  770. /**
  771. * Test that chainable methods return correct values.
  772. *
  773. * @return void
  774. */
  775. public function testChainableMethods()
  776. {
  777. $eventManager = new EventManager();
  778. $listener = $this->createMock(EventListenerInterface::class);
  779. $callable = function () {
  780. };
  781. $returnValue = $eventManager->on($listener);
  782. $this->assertSame($eventManager, $returnValue);
  783. $returnValue = $eventManager->on('foo', $callable);
  784. $this->assertSame($eventManager, $returnValue);
  785. $returnValue = $eventManager->on('foo', [], $callable);
  786. $this->assertSame($eventManager, $returnValue);
  787. $returnValue = $eventManager->off($listener);
  788. $this->assertSame($eventManager, $returnValue);
  789. $returnValue = $eventManager->off('foo', $listener);
  790. $this->assertSame($eventManager, $returnValue);
  791. $returnValue = $eventManager->off('foo', $callable);
  792. $this->assertSame($eventManager, $returnValue);
  793. $returnValue = $eventManager->off('foo');
  794. $this->assertSame($eventManager, $returnValue);
  795. $returnValue = $eventManager->setEventList(new EventList());
  796. $this->assertSame($eventManager, $returnValue);
  797. $returnValue = $eventManager->addEventToList(new Event('foo'));
  798. $this->assertSame($eventManager, $returnValue);
  799. $returnValue = $eventManager->trackEvents(true);
  800. $this->assertSame($eventManager, $returnValue);
  801. $returnValue = $eventManager->unsetEventList();
  802. $this->assertSame($eventManager, $returnValue);
  803. }
  804. }