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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Johannes Leuker <j.leuker@hosting.de>
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Vincent Petry <vincent@nextcloud.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCP\SystemTag;
/**
* Public interface for a system-wide tag.
*
* @since 9.0.0
*/
interface ISystemTag {
/**
* @since 22.0.0
*/
public const ACCESS_LEVEL_PUBLIC = 0;
/**
* @since 22.0.0
*/
public const ACCESS_LEVEL_RESTRICTED = 1;
/**
* @since 22.0.0
*/
public const ACCESS_LEVEL_INVISIBLE = 2;
/**
* @since 22.0.0
*/
public const ACCESS_LEVEL_LOOKUP = [
ISystemTag::ACCESS_LEVEL_PUBLIC => 'public',
ISystemTag::ACCESS_LEVEL_RESTRICTED => 'restricted',
ISystemTag::ACCESS_LEVEL_INVISIBLE => 'invisible',
];
/**
* Returns the tag id
*
* @return string id
*
* @since 9.0.0
*/
public function getId(): string;
/**
* Returns the tag display name
*
* @return string tag display name
*
* @since 9.0.0
*/
public function getName(): string;
/**
* Returns whether the tag is visible for regular users
*
* @return bool true if visible, false otherwise
*
* @since 9.0.0
*/
public function isUserVisible(): bool;
/**
* Returns whether the tag can be assigned to objects by regular users
*
* @return bool true if assignable, false otherwise
*
* @since 9.0.0
*/
public function isUserAssignable(): bool;
/**
* Returns a term summarizing the access control flags
*
* @return int the level of access control
*
* @since 22.0.0
*/
public function getAccessLevel(): int;
}
|