IDisplayText.php 728 B

1234567891011121314151617181920212223242526272829
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  5. * SPDX-License-Identifier: AGPL-3.0-or-later
  6. */
  7. namespace OCP\WorkflowEngine\EntityContext;
  8. /**
  9. * Interface IDisplayText
  10. *
  11. *
  12. * @since 18.0.0
  13. */
  14. interface IDisplayText {
  15. /**
  16. * returns translated text used for display to the end user. For instance,
  17. * it can describe the event in a human readable way.
  18. *
  19. * The entity may react to a verbosity level that is provided. With the
  20. * basic level, 0, it would return brief information, and more with higher
  21. * numbers. All information shall be shown at a level of 3.
  22. *
  23. * @since 18.0.0
  24. */
  25. public function getDisplayText(int $verbosity = 0): string;
  26. }