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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<?php
/**
* @copyright Copyright (c) 2024 Julius Härtl <jus@bitgrid.net>
*
* @author Julius Härtl <jus@bitgrid.net>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\Teams;
/**
* @since 29.0.0
*/
class TeamResource implements \JsonSerializable {
/**
* @since 29.0.0
*/
public function __construct(
private ITeamResourceProvider $teamResourceProvider,
private string $resourceId,
private string $label,
private string $url,
private ?string $iconSvg = null,
private ?string $iconURL = null,
private ?string $iconEmoji = null,
) {
}
/**
* Returns the provider details for the current resource
*
* @since 29.0.0
*/
public function getProvider(): ITeamResourceProvider {
return $this->teamResourceProvider;
}
/**
* Unique id of the resource (e.g. primary key id)
* @since 29.0.0
*/
public function getId(): string {
return $this->resourceId;
}
/**
* User visible label when listing resources
*
* @since 29.0.0
*/
public function getLabel(): string {
return $this->label;
}
/**
* Absolute url to navigate the user to the resource
*
* @since 29.0.0
*/
public function getUrl(): string {
return $this->url;
}
/**
* Svg icon to show next to the name for the resource
*
* From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
*
* @since 29.0.0
*/
public function getIconSvg(): ?string {
return $this->iconSvg;
}
/**
* Image url of the icon to show next to the name for the resource
*
* From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
*
* @since 29.0.0
*/
public function getIconURL(): ?string {
return $this->iconURL;
}
/**
* Emoji show next to the name for the resource
*
* From all icons the first one returning not null will be picked in order: iconEmoji, iconSvg, iconUrl
*
* @since 29.0.0
*/
public function getIconEmoji(): ?string {
return $this->iconEmoji;
}
/**
* @since 29.0.0
*/
public function jsonSerialize(): array {
return [
'id' => $this->resourceId,
'label' => $this->label,
'url' => $this->url,
'iconSvg' => $this->iconSvg,
'iconURL' => $this->iconURL,
'iconEmoji' => $this->iconEmoji,
'provider' => [
'id' => $this->teamResourceProvider->getId(),
'name' => $this->teamResourceProvider->getName(),
'icon' => $this->teamResourceProvider->getIconSvg(),
]
];
}
}
|
