IEntity¶
-
interface
OCP\WorkflowEngine\
IEntity
¶ - Interface IEntityThis interface represents an entity that supports events the workflow enginecan listen to. For example a file with the create, update, etc. events.Ensure to listen to ‘OCP/WorkflowEngine::loadEntities’ for registering yourentities.
Source: lib/public/WorkflowEngine/IEntity.php#42
Methods¶
-
public
OCP\WorkflowEngine\IEntity::
getName
()¶ - returns a translated name to be presented in the web interface.Example: “File” (en), “Dosiero” (eo)
Source: lib/public/WorkflowEngine/IEntity.php#51 Since: 18.0.0
-
public
OCP\WorkflowEngine\IEntity::
getIcon
()¶ - 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’);
Source: lib/public/WorkflowEngine/IEntity.php#63 Since: 18.0.0
-
public
OCP\WorkflowEngine\IEntity::
getEvents
()¶ - returns a list of supported events
Source: lib/public/WorkflowEngine/IEntity.php#71 Returns: \OCP\WorkflowEngine\IEntityEvent[]
Since: 18.0.0
-
public
OCP\WorkflowEngine\IEntity::
prepareRuleMatcher
($ruleMatcher, $eventName, $event)¶ Source: lib/public/WorkflowEngine/IEntity.php#76 Since: 18.0.0
-
public
OCP\WorkflowEngine\IEntity::
isLegitimatedForUserId
($userId)¶ - returns whether the provided user id is allowed to run a flow againstthe known context
Source: lib/public/WorkflowEngine/IEntity.php#84 Since: 18.0.0