1
0

IReferenceProvider.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  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. namespace OCP\Collaboration\Reference;
  24. /**
  25. * @since 25.0.0
  26. */
  27. interface IReferenceProvider {
  28. /**
  29. * Validate that a given reference identifier matches the current provider
  30. *
  31. * @since 25.0.0
  32. */
  33. public function matchReference(string $referenceText): bool;
  34. /**
  35. * Return a reference with its metadata for a given reference identifier
  36. *
  37. * @since 25.0.0
  38. */
  39. public function resolveReference(string $referenceText): ?IReference;
  40. /**
  41. * Return true if the reference metadata can be globally cached
  42. *
  43. * @since 25.0.0
  44. */
  45. public function getCachePrefix(string $referenceId): string;
  46. /**
  47. * Return a custom cache key to be used for caching the metadata
  48. * This could be for example the current user id if the reference
  49. * access permissions are different for each user
  50. *
  51. * Should return null, if the cache is only related to the
  52. * reference id and has no further dependency
  53. *
  54. * @since 25.0.0
  55. */
  56. public function getCacheKey(string $referenceId): ?string;
  57. }