EventManagerTest.php 29 KB

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