blob: 9242a230024024d23b2e12a3076a8db73dfe97ea (
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
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal Nextcloud classes
namespace OCP;
/**
* public api to access default strings and urls for your templates
* @since 6.0.0
*/
class Defaults {
/**
* \OC_Defaults instance to retrieve the defaults
* @since 6.0.0
*/
private $defaults;
/**
* creates a \OC_Defaults instance which is used in all methods to retrieve the
* actual defaults
* @since 6.0.0
*/
public function __construct(?\OC_Defaults $defaults = null) {
if ($defaults === null) {
$defaults = \OC::$server->get('ThemingDefaults');
}
$this->defaults = $defaults;
}
/**
* get base URL for the organisation behind your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getBaseUrl(): string {
return $this->defaults->getBaseUrl();
}
/**
* link to the desktop sync client
* @return string
* @since 6.0.0
*/
public function getSyncClientUrl(): string {
return $this->defaults->getSyncClientUrl();
}
/**
* link to the iOS client
* @return string
* @since 8.0.0
*/
public function getiOSClientUrl(): string {
return $this->defaults->getiOSClientUrl();
}
/**
* link to the Android client
* @return string
* @since 8.0.0
*/
public function getAndroidClientUrl(): string {
return $this->defaults->getAndroidClientUrl();
}
/**
* link to the Android client on F-Droid
* @return string
* @since 23.0.0
*/
public function getFDroidClientUrl() {
return $this->defaults->getFDroidClientUrl();
}
/**
* base URL to the documentation of your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getDocBaseUrl(): string {
return $this->defaults->getDocBaseUrl();
}
/**
* name of your Nextcloud instance (e.g. MyPrivateCloud)
* @return string
* @since 6.0.0
*/
public function getName(): string {
return $this->defaults->getName();
}
/**
* Name of the software product (defaults to Nextcloud)
*
* @return string
* @since 22.0.0
*/
public function getProductName(): string {
return $this->defaults->getProductName();
}
/**
* name of your ownCloud instance containing HTML styles
* @return string
* @since 8.0.0
* @deprecated 22.0.0
*/
public function getHTMLName(): string {
return $this->defaults->getHTMLName();
}
/**
* Entity behind your onwCloud instance
* @return string
* @since 6.0.0
*/
public function getEntity(): string {
return $this->defaults->getEntity();
}
/**
* ownCloud slogan
* @return string
* @since 6.0.0
*/
public function getSlogan(?string $lang = null): string {
return $this->defaults->getSlogan($lang);
}
/**
* footer, short version
* @return string
* @since 6.0.0
*/
public function getShortFooter(): string {
return $this->defaults->getShortFooter();
}
/**
* footer, long version
* @return string
* @since 6.0.0
*/
public function getLongFooter(): string {
return $this->defaults->getLongFooter();
}
/**
* Returns the AppId for the App Store for the iOS Client
* @return string AppId
* @since 8.0.0
*/
public function getiTunesAppId(): string {
return $this->defaults->getiTunesAppId();
}
/**
* Themed logo url
*
* @param bool $useSvg Whether to point to the SVG image or a fallback
* @return string
* @since 12.0.0
*/
public function getLogo(bool $useSvg = true): string {
return $this->defaults->getLogo($useSvg);
}
/**
* Returns primary color
* @return string
* @since 12.0.0
*/
public function getColorPrimary(): string {
return $this->defaults->getColorPrimary();
}
/**
* Return the default color primary
* @return string
* @since 25.0.4
*/
public function getDefaultColorPrimary(): string {
if (method_exists($this->defaults, 'getDefaultColorPrimary')) {
return $this->defaults->getDefaultColorPrimary();
}
return $this->defaults->getColorPrimary();
}
/**
* @param string $key
* @return string URL to doc with key
* @since 12.0.0
*/
public function buildDocLinkToKey(string $key): string {
return $this->defaults->buildDocLinkToKey($key);
}
/**
* Returns the title
* @return string title
* @since 12.0.0
*/
public function getTitle(): string {
return $this->defaults->getTitle();
}
/**
* Returns primary color
* @return string
* @since 13.0.0
*/
public function getTextColorPrimary(): string {
return $this->defaults->getTextColorPrimary();
}
/**
* Returns primary color
* @return string
* @since 25.0.4
*/
public function getDefaultTextColorPrimary(): string {
if (method_exists($this->defaults, 'getDefaultTextColorPrimary')) {
return $this->defaults->getDefaultTextColorPrimary();
}
return $this->defaults->getTextColorPrimary();
}
}
|
