ICheck.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Morris Jobke <hey@morrisjobke.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\WorkflowEngine;
  25. /**
  26. * Interface ICheck
  27. *
  28. * @since 9.1
  29. */
  30. interface ICheck {
  31. /**
  32. * @param string $operator
  33. * @param string $value
  34. * @return bool
  35. * @since 9.1
  36. */
  37. public function executeCheck($operator, $value);
  38. /**
  39. * @param string $operator
  40. * @param string $value
  41. * @throws \UnexpectedValueException
  42. * @since 9.1
  43. */
  44. public function validateCheck($operator, $value);
  45. /**
  46. * returns a list of Entities the checker supports. The values must match
  47. * the class name of the entity.
  48. *
  49. * An empty result means the check is universally available.
  50. *
  51. * @since 18.0.0
  52. */
  53. public function supportedEntities(): array;
  54. /**
  55. * returns whether the operation can be used in the requested scope.
  56. *
  57. * Scope IDs are defined as constants in OCP\WorkflowEngine\IManager. At
  58. * time of writing these are SCOPE_ADMIN and SCOPE_USER.
  59. *
  60. * For possibly unknown future scopes the recommended behaviour is: if
  61. * user scope is permitted, the default behaviour should return `true`,
  62. * otherwise `false`.
  63. *
  64. * @since 18.0.0
  65. */
  66. public function isAvailableForScope(int $scope): bool;
  67. }