aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_versions/lib/Versions/IMetadataVersion.php
blob: bc4cd77138b49e409a6f396b7f81a869749e9fee (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCA\Files_Versions\Versions;

/**
 * This interface allows for just direct accessing of the metadata column JSON
 * @since 29.0.0
 */
interface IMetadataVersion {
	/**
	 * retrieves the all the metadata
	 *
	 * @return string[]
	 * @since 29.0.0
	 */
	public function getMetadata(): array;

	/**
	 * retrieves the metadata value from our $key param
	 *
	 * @param string $key the key for the json value of the metadata column
	 * @since 29.0.0
	 */
	public function getMetadataValue(string $key): ?string;
}