blob: d88654c5e0ceb53c62463fa9f24109bec28a48cf (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\WorkflowEngine;
/**
* Class GenericEntityEvent
*
*
* @since 18.0.0
*/
class GenericEntityEvent implements IEntityEvent {
/** @var string */
private $displayName;
/** @var string */
private $eventName;
/**
* GenericEntityEvent constructor.
*
* @since 18.0.0
*/
public function __construct(string $displayName, string $eventName) {
if (trim($displayName) === '') {
throw new \InvalidArgumentException('DisplayName must not be empty');
}
if (trim($eventName) === '') {
throw new \InvalidArgumentException('EventName must not be empty');
}
$this->displayName = trim($displayName);
$this->eventName = trim($eventName);
}
/**
* returns a translated name to be presented in the web interface.
*
* Example: "created" (en), "kreita" (eo)
*
* @since 18.0.0
*/
public function getDisplayName(): string {
return $this->displayName;
}
/**
* returns the event name that is emitted by the EventDispatcher, e.g.:
*
* Example: "OCA\MyApp\Factory\Cats::postCreated"
*
* @since 18.0.0
*/
public function getEventName(): string {
return $this->eventName;
}
}
|
