blob: 9ff9a728063fe6f16a9abc52102537cfd08ed4c5 (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Collaboration\Reference;
/**
* @since 25.0.0
*/
interface IReferenceProvider {
/**
* Validate that a given reference identifier matches the current provider
*
* @since 25.0.0
*/
public function matchReference(string $referenceText): bool;
/**
* Return a reference with its metadata for a given reference identifier
*
* @since 25.0.0
*/
public function resolveReference(string $referenceText): ?IReference;
/**
* Return true if the reference metadata can be globally cached
*
* @since 25.0.0
*/
public function getCachePrefix(string $referenceId): string;
/**
* Return a custom cache key to be used for caching the metadata
* This could be for example the current user id if the reference
* access permissions are different for each user
*
* Should return null, if the cache is only related to the
* reference id and has no further dependency
*
* @since 25.0.0
*/
public function getCacheKey(string $referenceId): ?string;
}
|
