aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Lib/IFrontendDefinition.php
blob: 0184d5f536cf2a075dd59388570ee9c088f7e976 (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
<?php
/**
 * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCA\Files_External\Lib;

interface IFrontendDefinition {

	public function getText(): string;

	public function setText(string $text): self;

	/**
	 * @return array<string, DefinitionParameter>
	 */
	public function getParameters(): array;

	/**
	 * @param list<DefinitionParameter> $parameters
	 */
	public function addParameters(array $parameters): self;

	public function addParameter(DefinitionParameter $parameter): self;

	/**
	 * @return string[]
	 */
	public function getCustomJs(): array;

	public function addCustomJs(string $custom): self;

	/**
	 * Serialize into JSON for client-side JS
	 */
	public function jsonSerializeDefinition(): array;

	/**
	 * Check if parameters are satisfied in a StorageConfig
	 */
	public function validateStorageDefinition(StorageConfig $storage): bool;
}