1
0

IManager.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Morris Jobke <hey@morrisjobke.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Morris Jobke <hey@morrisjobke.de>
  8. * @author Roeland Jago Douma <roeland@famdouma.nl>
  9. *
  10. * @license GNU AGPL version 3 or any later version
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License as
  14. * published by the Free Software Foundation, either version 3 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU Affero General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU Affero General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. *
  25. */
  26. namespace OCP\WorkflowEngine;
  27. /**
  28. * Interface IManager
  29. *
  30. * @since 9.1
  31. */
  32. interface IManager {
  33. public const SCOPE_ADMIN = 0;
  34. public const SCOPE_USER = 1;
  35. /**
  36. * @since 21.0.0
  37. */
  38. public const MAX_CHECK_VALUE_BYTES = 2048;
  39. /**
  40. * @since 21.0.0
  41. */
  42. public const MAX_OPERATION_VALUE_BYTES = 4096;
  43. /**
  44. * @deprecated 17.0.0 Will be removed in NC19. Use the dedicated events in OCP\WorkflowEngine\Events
  45. */
  46. public const EVENT_NAME_REG_OPERATION = 'OCP\WorkflowEngine::registerOperations';
  47. /**
  48. * @deprecated 17.0.0
  49. */
  50. public const EVENT_NAME_REG_ENTITY = 'OCP\WorkflowEngine::registerEntities';
  51. /**
  52. * @deprecated 17.0.0
  53. */
  54. public const EVENT_NAME_REG_CHECK = 'OCP\WorkflowEngine::registerChecks';
  55. /**
  56. * Listen to `OCP\WorkflowEngine\Events\RegisterEntitiesEvent` at the
  57. * IEventDispatcher for registering your entities.
  58. *
  59. * @since 18.0.0
  60. */
  61. public function registerEntity(IEntity $entity): void;
  62. /**
  63. * Listen to `OCP\WorkflowEngine\Events\RegisterOperationsEvent` at the
  64. * IEventDispatcher for registering your operators.
  65. *
  66. * @since 18.0.0
  67. */
  68. public function registerOperation(IOperation $operator): void;
  69. /**
  70. * Listen to `OCP\WorkflowEngine\Events\RegisterChecksEvent` at the
  71. * IEventDispatcher for registering your operators.
  72. *
  73. * @since 18.0.0
  74. */
  75. public function registerCheck(ICheck $check): void;
  76. /**
  77. * @since 18.0.0
  78. */
  79. public function getRuleMatcher(): IRuleMatcher;
  80. }