blob: 0b469b479e6828687944ca7f7b988d142c818d47 (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\WorkflowEngine;
use OCP\EventDispatcher\Event;
/**
* Interface IEntity
*
* This interface represents an entity that supports events the workflow engine
* can listen to. For example a file with the create, update, etc. events.
*
* Ensure to listen to 'OCP/WorkflowEngine::loadEntities' for registering your
* entities.
*
* @since 18.0.0
*/
interface IEntity {
/**
* returns a translated name to be presented in the web interface.
*
* Example: "File" (en), "Dosiero" (eo)
*
* @since 18.0.0
*/
public function getName(): string;
/**
* returns the URL to the icon of the entity for display in the web interface.
*
* Usually, the implementation would utilize the `imagePath()` method of the
* `\OCP\IURLGenerator` instance and simply return its result.
*
* Example implementation: return $this->urlGenerator->imagePath('myApp', 'cat.svg');
*
* @since 18.0.0
*/
public function getIcon(): string;
/**
* returns a list of supported events
*
* @return IEntityEvent[]
* @since 18.0.0
*/
public function getEvents(): array;
/**
* @since 18.0.0
*/
public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void;
/**
* returns whether the provided user id is allowed to run a flow against
* the known context
*
* @since 18.0.0
*/
public function isLegitimatedForUserId(string $userId): bool;
}
|