IDisplayText.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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\EntityContext;
  25. /**
  26. * Interface IDisplayText
  27. *
  28. *
  29. * @since 18.0.0
  30. */
  31. interface IDisplayText {
  32. /**
  33. * returns translated text used for display to the end user. For instance,
  34. * it can describe the event in a human readable way.
  35. *
  36. * The entity may react to a verbosity level that is provided. With the
  37. * basic level, 0, it would return brief information, and more with higher
  38. * numbers. All information shall be shown at a level of 3.
  39. *
  40. * @since 18.0.0
  41. */
  42. public function getDisplayText(int $verbosity = 0): string;
  43. }