mirror of
https://github.com/nextcloud/server.git
synced 2024-12-29 00:18:42 +00:00
67 lines
1.5 KiB
PHP
67 lines
1.5 KiB
PHP
<?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;
|
|
}
|