| 1: | <?php |
| 2: | /* |
| 3: | * SimpleID |
| 4: | * |
| 5: | * Copyright (C) Kelvin Mo 2021-2025 |
| 6: | * |
| 7: | * This program is free software; you can redistribute it and/or |
| 8: | * modify it under the terms of the GNU General Public |
| 9: | * License as published by the Free Software Foundation; either |
| 10: | * version 2 of the License, or (at your option) any later version. |
| 11: | * |
| 12: | * This program is distributed in the hope that it will be useful, |
| 13: | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14: | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 15: | * General Public License for more details. |
| 16: | * |
| 17: | * You should have received a copy of the GNU General Public |
| 18: | * License along with this program; if not, write to the Free |
| 19: | * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 20: | * |
| 21: | */ |
| 22: | |
| 23: | namespace SimpleID\Util\Events; |
| 24: | |
| 25: | |
| 26: | /** |
| 27: | * A utility trait for implementing {@link Psr\EventDispatcher\StoppableEventInterface}. |
| 28: | */ |
| 29: | trait StoppableEventTrait { |
| 30: | /** @var bool */ |
| 31: | protected $stopped = false; |
| 32: | |
| 33: | /** |
| 34: | * @see Psr\EventDispatcher\StoppableEventInterface::isPropagationStopped() |
| 35: | */ |
| 36: | public function isPropagationStopped(): bool { |
| 37: | return $this->stopped; |
| 38: | } |
| 39: | |
| 40: | /** |
| 41: | * Stops further propagation of the event |
| 42: | * |
| 43: | * @return $this |
| 44: | */ |
| 45: | public function stopPropagation() { |
| 46: | $this->stopped = true; |
| 47: | return $this; |
| 48: | } |
| 49: | } |
| 50: | |
| 51: | ?> |