1
0

IMetadataQuery.php 2.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  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\FilesMetadata;
  25. use OCP\FilesMetadata\Model\IFilesMetadata;
  26. /**
  27. * Model that help building queries with metadata and metadata indexes
  28. *
  29. * @since 28.0.0
  30. */
  31. interface IMetadataQuery {
  32. /** @since 28.0.0 */
  33. public const EXTRA = 'metadata';
  34. /**
  35. * Add metadata linked to file id to the query
  36. *
  37. * @see self::extractMetadata()
  38. * @since 28.0.0
  39. */
  40. public function retrieveMetadata(): void;
  41. /**
  42. * extract metadata from a result row
  43. *
  44. * @param array $row result row
  45. *
  46. * @return IFilesMetadata metadata
  47. * @see self::retrieveMetadata()
  48. * @since 28.0.0
  49. */
  50. public function extractMetadata(array $row): IFilesMetadata;
  51. /**
  52. * join the metadata_index table, based on a metadataKey.
  53. * This will prep the query for condition based on this specific metadataKey.
  54. * If a link to the metadataKey already exists, returns known alias.
  55. *
  56. * TODO: investigate how to support a search done on multiple values for same key (AND).
  57. *
  58. * @param string $metadataKey metadata key
  59. * @param bool $enforce limit the request only to existing metadata
  60. *
  61. * @return string generated table alias
  62. * @since 28.0.0
  63. */
  64. public function joinIndex(string $metadataKey, bool $enforce = false): string;
  65. /**
  66. * returns the name of the field for metadata key to be used in query expressions
  67. *
  68. * @param string $metadataKey metadata key
  69. *
  70. * @return string table field
  71. * @since 28.0.0
  72. */
  73. public function getMetadataKeyField(string $metadataKey): string;
  74. /**
  75. * returns the name of the field for metadata string value to be used in query expressions
  76. *
  77. * @param string $metadataKey metadata key
  78. *
  79. * @return string table field
  80. * @since 28.0.0
  81. */
  82. public function getMetadataValueField(string $metadataKey): string;
  83. }