aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Http/Template/IMenuAction.php
blob: 50b346add86774ab22baae13ffca0b92a5f287b7 (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
<?php
/**
 * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\AppFramework\Http\Template;

/**
 * Interface IMenuAction
 *
 * @since 14.0
 */
interface IMenuAction {
	/**
	 * @since 14.0.0
	 * @return string
	 */
	public function getId(): string;

	/**
	 * The translated label of the menu item.
	 *
	 * @since 14.0.0
	 * @return string
	 */
	public function getLabel(): string;

	/**
	 * The link this menu item points to.
	 *
	 * @since 14.0.0
	 * @return string
	 */
	public function getLink(): string;

	/**
	 * @since 14.0.0
	 * @return int
	 */
	public function getPriority(): int;

	/**
	 * Custom render function.
	 * The returned HTML will be wrapped within a listitem element (`<li>...</li>`).
	 *
	 * @since 14.0.0
	 * @return string
	 */
	public function render(): string;
}