ICheck¶

interface OCP\WorkflowEngine\ICheck¶

Interface ICheck

Source:	lib/public/WorkflowEngine/ICheck.php#32

Methods¶

public OCP\WorkflowEngine\ICheck::executeCheck($operator, $value)¶

Source:	lib/public/WorkflowEngine/ICheck.php#39
Parameters:	$operator (string) $value (string)
Returns:	bool
Since:	9.1

public OCP\WorkflowEngine\ICheck::validateCheck($operator, $value)¶

Source:	lib/public/WorkflowEngine/ICheck.php#47
Parameters:	$operator (string) $value (string)
Throws:	`\UnexpectedValueException`
Since:	9.1

public OCP\WorkflowEngine\ICheck::supportedEntities()¶

returns a list of Entities the checker supports. The values must match

the class name of the entity.

An empty result means the check is universally available.

Source:	lib/public/WorkflowEngine/ICheck.php#57
Since:	18.0.0

public OCP\WorkflowEngine\ICheck::isAvailableForScope($scope)¶

returns whether the operation can be used in the requested scope.

Scope IDs are defined as constants in OCP\WorkflowEngine\IManager. At
time of writing these are SCOPE_ADMIN and SCOPE_USER.

For possibly unknown future scopes the recommended behaviour is: if
user scope is permitted, the default behaviour should return `true`,
otherwise `false`.

Source:	lib/public/WorkflowEngine/ICheck.php#71
Since:	18.0.0