blob: 4bb51f2f9b69225b825467d112148a9329314871 (
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
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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2023 Richard Steinmetz <richard@steinmetz.cloud>
*
* @author Richard Steinmetz <richard@steinmetz.cloud>
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Dashboard\Model;
use JsonSerializable;
use OCP\Dashboard\IAPIWidgetV2;
/**
* Interface WidgetItems
*
* This class is used by {@see IAPIWidgetV2} interface.
* It represents an array of widget items and additional context information that can be provided to clients via the Dashboard API
*
* @see IAPIWidgetV2::getItemsV2
*
* @since 27.1.0
*/
class WidgetItems implements JsonSerializable {
/**
* @param $items WidgetItem[]
*
* @since 27.1.0
*/
public function __construct(
private array $items = [],
private string $emptyContentMessage = '',
private string $halfEmptyContentMessage = '',
) {
}
/**
* Items to render in the widgets
*
* @since 27.1.0
*
* @return WidgetItem[]
*/
public function getItems(): array {
return $this->items;
}
/**
* The "half" empty content message to show above the list of items.
*
* A non-empty string enables this feature.
* An empty string hides the message and disables this feature.
*
* @since 27.1.0
*/
public function getEmptyContentMessage(): string {
return $this->emptyContentMessage;
}
/**
* The empty content message to show in case of no items at all
*
* @since 27.1.0
*/
public function getHalfEmptyContentMessage(): string {
return $this->halfEmptyContentMessage;
}
/**
* @since 27.1.0
*/
public function jsonSerialize(): array {
$items = array_map(static function (WidgetItem $item) {
return $item->jsonSerialize();
}, $this->getItems());
return [
'items' => $items,
'emptyContentMessage' => $this->getEmptyContentMessage(),
'halfEmptyContentMessage' => $this->getHalfEmptyContentMessage(),
];
}
}
|
