| 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: | * A utility trait for implementing {@link \GenericEventInterface}. |
| 27: | * |
| 28: | * @see https://github.com/kelvinmo/f3-event-dispatcher |
| 29: | */ |
| 30: | trait GenericEventTrait { |
| 31: | /** @var string */ |
| 32: | protected $eventName; |
| 33: | |
| 34: | /** |
| 35: | * Sets the name of the event to be returned by `GenericEventInterface::getEventName()`. |
| 36: | * |
| 37: | * The name of the event is specified by the `$eventName` parameter. If |
| 38: | * `$eventName` is null, then the name of the class which inserted the trait |
| 39: | * is used instead. |
| 40: | * |
| 41: | * @param string $eventName the name of the event, or null |
| 42: | * @return void |
| 43: | */ |
| 44: | protected function setEventName($eventName = null) { |
| 45: | if ($eventName == null) { |
| 46: | // We use static::class instead of self::class or __CLASS__ |
| 47: | // to pick up the name of the subclass instead of |
| 48: | // BaseDataCollectionEvent (if applicable) |
| 49: | $this->eventName = static::class; |
| 50: | } else { |
| 51: | $this->eventName = $eventName; |
| 52: | } |
| 53: | } |
| 54: | |
| 55: | /** |
| 56: | * @see \GenericEventInterface::getEventName() |
| 57: | * |
| 58: | * @return string |
| 59: | */ |
| 60: | public function getEventName() { |
| 61: | if ($this->eventName == null) { |
| 62: | return static::class; |
| 63: | } else { |
| 64: | return $this->eventName; |
| 65: | } |
| 66: | } |
| 67: | } |
| 68: | |
| 69: | ?> |
| 70: |