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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Dashboard\Model;
use JsonSerializable;
/**
* Interface WidgetItem
*
* This class is used by IAPIWidget interface.
* It represents an widget item data that can be provided to clients via the Dashboard API
* @see IAPIWidget::getItems
*
* @since 22.0.0
*
*/
final class WidgetItem implements JsonSerializable {
/** @var string */
private $title = '';
/** @var string */
private $subtitle = '';
/** @var string */
private $link = '';
/** @var string */
private $iconUrl = '';
/** @var string
* Timestamp or ID used by the dashboard API to avoid getting already retrieved items
*/
private $sinceId = '';
/**
* Overlay icon to show in the bottom right corner of {@see $iconUrl}
*
* @since 27.1.0
*/
private string $overlayIconUrl = '';
/**
* WidgetItem constructor
*
* @since 22.0.0
*/
public function __construct(string $title = '',
string $subtitle = '',
string $link = '',
string $iconUrl = '',
string $sinceId = '',
string $overlayIconUrl = '') {
$this->title = $title;
$this->subtitle = $subtitle;
$this->iconUrl = $iconUrl;
$this->link = $link;
$this->sinceId = $sinceId;
$this->overlayIconUrl = $overlayIconUrl;
}
/**
* Get the item title
*
* @since 22.0.0
*
* @return string
*/
public function getTitle(): string {
return $this->title;
}
/**
* Get the item subtitle
*
* @since 22.0.0
*
* @return string
*/
public function getSubtitle(): string {
return $this->subtitle;
}
/**
* Get the item link
*
* @since 22.0.0
*
* @return string
*/
public function getLink(): string {
return $this->link;
}
/**
* Get the item icon URL
* The icon should be a square svg or a jpg/png of at least 44x44px
*
* @since 22.0.0
*
* @return string
*/
public function getIconUrl(): string {
return $this->iconUrl;
}
/**
* Get the item since ID
*
* @since 22.0.0
*
* @return string
*/
public function getSinceId(): string {
return $this->sinceId;
}
/**
* Get the overlay icon url
*
* @since 27.1.0
*
* @return string
*/
public function getOverlayIconUrl(): string {
return $this->overlayIconUrl;
}
/**
* @since 22.0.0
* @return array{
* subtitle: string,
* title: string,
* link: string,
* iconUrl: string,
* overlayIconUrl: string,
* sinceId: string,
* }
*/
public function jsonSerialize(): array {
return [
'subtitle' => $this->getSubtitle(),
'title' => $this->getTitle(),
'link' => $this->getLink(),
'iconUrl' => $this->getIconUrl(),
'overlayIconUrl' => $this->getOverlayIconUrl(),
'sinceId' => $this->getSinceId(),
];
}
}
|
