blob: 82bf5be38439dc2f081822fb2559f75db25e2d25 (
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
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Björn Schießle <bjoern@schiessle.org>
* @author Joas Schilling <coding@schilljs.com>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author scolebrook <scolebrook@mac.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
/**
* Public interface of ownCloud for apps to use.
* Defaults Class
*
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud 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->getThemingDefaults();
}
$this->defaults = $defaults;
}
/**
* get base URL for the organisation behind your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getBaseUrl() {
return $this->defaults->getBaseUrl();
}
/**
* link to the desktop sync client
* @return string
* @since 6.0.0
*/
public function getSyncClientUrl() {
return $this->defaults->getSyncClientUrl();
}
/**
* link to the iOS client
* @return string
* @since 8.0.0
*/
public function getiOSClientUrl() {
return $this->defaults->getiOSClientUrl();
}
/**
* link to the Android client
* @return string
* @since 8.0.0
*/
public function getAndroidClientUrl() {
return $this->defaults->getAndroidClientUrl();
}
/**
* base URL to the documentation of your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getDocBaseUrl() {
return $this->defaults->getDocBaseUrl();
}
/**
* name of your ownCloud instance
* @return string
* @since 6.0.0
*/
public function getName() {
return $this->defaults->getName();
}
/**
* name of your ownCloud instance containing HTML styles
* @return string
* @since 8.0.0
*/
public function getHTMLName() {
return $this->defaults->getHTMLName();
}
/**
* Entity behind your onwCloud instance
* @return string
* @since 6.0.0
*/
public function getEntity() {
return $this->defaults->getEntity();
}
/**
* ownCloud slogan
* @return string
* @since 6.0.0
*/
public function getSlogan() {
return $this->defaults->getSlogan();
}
/**
* logo claim
* @return string
* @since 6.0.0
* @deprecated 13.0.0
*/
public function getLogoClaim() {
return '';
}
/**
* footer, short version
* @return string
* @since 6.0.0
*/
public function getShortFooter() {
return $this->defaults->getShortFooter();
}
/**
* footer, long version
* @return string
* @since 6.0.0
*/
public function getLongFooter() {
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() {
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($useSvg = true) {
return $this->defaults->getLogo($useSvg);
}
/**
* Returns primary color
* @return string
* @since 12.0.0
*/
public function getColorPrimary() {
return $this->defaults->getColorPrimary();
}
/**
* @param string $key
* @return string URL to doc with key
* @since 12.0.0
*/
public function buildDocLinkToKey($key) {
return $this->defaults->buildDocLinkToKey($key);
}
/**
* Returns the title
* @return string title
* @since 12.0.0
*/
public function getTitle() {
return $this->defaults->getTitle();
}
/**
* Returns primary color
* @return string
* @since 13.0.0
*/
public function getTextColorPrimary() {
return $this->defaults->getTextColorPrimary();
}
}
|
