blob: 3e68b47f822f12e3831a1b9ab2b8e6bcfa71bf31 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
<?php
declare(strict_types=1);
/**
* @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
*
* @author Maxence Lange <maxence@artificial-owl.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\FilesMetadata\Model;
/**
* Model that help building queries with metadata and metadata indexes
*
* @since 28.0.0
*/
interface IMetadataQuery {
public const EXTRA = 'metadata';
/**
* Add metadata linked to file id to the query
*
* @see self::extractMetadata()
* @since 28.0.0
*/
public function retrieveMetadata(): void;
/**
* extract metadata from a result row
*
* @param array $row result row
*
* @return IFilesMetadata metadata
* @see self::retrieveMetadata()
* @since 28.0.0
*/
public function extractMetadata(array $row): IFilesMetadata;
/**
* join the metadata_index table, based on a metadataKey.
* This will prep the query for condition based on this specific metadataKey.
* If a link to the metadataKey already exists, returns known alias.
*
* TODO: investigate how to support a search done on multiple values for same key (AND).
*
* @param string $metadataKey metadata key
* @param bool $enforce limit the request only to existing metadata
*
* @return string generated table alias
* @since 28.0.0
*/
public function joinIndex(string $metadataKey, bool $enforce = false): string;
/**
* returns the name of the field for metadata key to be used in query expressions
*
* @param string $metadataKey metadata key
*
* @return string table field
* @since 28.0.0
*/
public function getMetadataKeyField(string $metadataKey): string;
/**
* returns the name of the field for metadata string value to be used in query expressions
*
* @param string $metadataKey metadata key
*
* @return string table field
* @since 28.0.0
*/
public function getMetadataValueField(string $metadataKey): string;
}
|
