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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
* @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\Files\Template;
/**
* @since 21.0.0
*/
final class TemplateFileCreator implements \JsonSerializable {
protected $appId;
/** @var string[] $mimetypes */
protected $mimetypes = [];
protected $actionName;
protected $fileExtension;
/** @var ?string $iconClass */
protected $iconClass;
/** @var ?float $ratio */
protected $ratio = null;
protected $order = 100;
/**
* @since 27.0.0
* @deprecated 28.0.0
*/
protected string $actionLabel = '';
/**
* @since 21.0.0
*/
public function __construct(
string $appId, string $actionName, string $fileExtension
) {
$this->appId = $appId;
$this->actionName = $actionName;
$this->fileExtension = $fileExtension;
}
/**
* @since 21.0.0
*/
public function getAppId(): string {
return $this->appId;
}
/**
* @since 21.0.0
*/
public function setIconClass(string $iconClass): TemplateFileCreator {
$this->iconClass = $iconClass;
return $this;
}
/**
* @since 21.0.0
*/
public function addMimetype(string $mimetype): TemplateFileCreator {
$this->mimetypes[] = $mimetype;
return $this;
}
/**
* @since 21.0.0
*/
public function getMimetypes(): array {
return $this->mimetypes;
}
/**
* @since 21.0.0
*/
public function setRatio(float $ratio): TemplateFileCreator {
$this->ratio = $ratio;
return $this;
}
/**
* @param int $order order in which the create action shall be listed
* @since 21.0.0
*/
public function setOrder(int $order): TemplateFileCreator {
$this->order = $order;
return $this;
}
/**
* @since 21.0.0
*/
public function getOrder(): int {
return $this->order;
}
/**
* @since 27.0.0
*/
public function setActionLabel(string $actionLabel): TemplateFileCreator {
$this->actionLabel = $actionLabel;
return $this;
}
/**
* @since 27.0.0
*/
public function getActionLabel(): string {
return $this->actionLabel;
}
/**
* @since 21.0.0
* @return array{app: string, label: string, extension: string, iconClass: ?string, mimetypes: string[], ratio: ?float, actionLabel: string}
*/
public function jsonSerialize(): array {
return [
'app' => $this->appId,
'label' => $this->actionName,
'extension' => $this->fileExtension,
'iconClass' => $this->iconClass,
'mimetypes' => $this->mimetypes,
'ratio' => $this->ratio,
'actionLabel' => $this->actionLabel,
];
}
}
|
