aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Files/Template/ICustomTemplateProvider.php
blob: 305f2c9a55eaee85f8fe6083b81d865202722b93 (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Files\Template;

use OCP\Files\File;

/**
 * @since 21.0.0
 */
interface ICustomTemplateProvider {
	/**
	 * Return a list of additional templates that the template provider is offering
	 *
	 * @return File[]
	 * @since 21.0.0
	 */
	public function getCustomTemplates(string $mimetype): array;

	/**
	 * Return the file for a given template id
	 *
	 * @param string $template identifier of the template
	 * @return File
	 * @since 21.0.0
	 */
	public function getCustomTemplate(string $template): File;
}