Event.php 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\EventDispatcher;
  25. use Psr\EventDispatcher\StoppableEventInterface;
  26. /**
  27. * Base event class for the event dispatcher service
  28. *
  29. * Typically this class isn't instantiated directly but sub classed for specific
  30. * event types
  31. *
  32. * This class extended \Symfony\Contracts\EventDispatcher\Event until 21.0, since
  33. * 22.0.0 this class directly implements the PSR StoppableEventInterface and no
  34. * longer relies on Symfony. This transition does not come with any changes in API,
  35. * the class has the same methods and behavior before and after this change.
  36. *
  37. * @since 17.0.0
  38. */
  39. class Event implements StoppableEventInterface {
  40. /**
  41. * @var bool
  42. *
  43. * @since 22.0.0
  44. */
  45. private $propagationStopped = false;
  46. /**
  47. * Compatibility constructor
  48. *
  49. * In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base
  50. * class that had a constructor (with default arguments). To lower the risk of
  51. * a breaking change (PHP won't allow parent constructor calls if there is none),
  52. * this empty constructor's only purpose is to hopefully not break existing sub-
  53. * classes of this class.
  54. *
  55. * @since 18.0.0
  56. */
  57. public function __construct() {
  58. }
  59. /**
  60. * Stops the propagation of the event to further event listeners
  61. *
  62. * @return void
  63. *
  64. * @since 22.0.0
  65. */
  66. public function stopPropagation(): void {
  67. $this->propagationStopped = true;
  68. }
  69. /**
  70. * {@inheritDoc}
  71. *
  72. * @since 22.0.0
  73. * @see \Psr\EventDispatcher\StoppableEventInterface
  74. */
  75. public function isPropagationStopped(): bool {
  76. return $this->propagationStopped;
  77. }
  78. }