You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

51 lines
1.5 KiB

3 years ago
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.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 IFileCheck
  27. *
  28. * @since 18.0.0
  29. */
  30. interface IEntityCheck {
  31. /**
  32. * Equips the check with a subject fitting the Entity. For instance, an
  33. * entity of File will receive an instance of OCP\Files\Node, or a comment
  34. * entity might get an IComment.
  35. *
  36. * The implementing check must be aware of the incoming type.
  37. *
  38. * If an unsupported subject is passed the implementation MAY throw an
  39. * \UnexpectedValueException.
  40. *
  41. * @param IEntity $entity
  42. * @param mixed $subject
  43. * @throws \UnexpectedValueException
  44. * @since 18.0.0
  45. */
  46. public function setEntitySubject(IEntity $entity, $subject): void;
  47. }