@@ -42,177 +42,177 @@ |
||
42 | 42 | */ |
43 | 43 | class Defaults { |
44 | 44 | |
45 | - /** |
|
46 | - * \OC_Defaults instance to retrieve the defaults |
|
47 | - * @since 6.0.0 |
|
48 | - */ |
|
49 | - private $defaults; |
|
50 | - |
|
51 | - /** |
|
52 | - * creates a \OC_Defaults instance which is used in all methods to retrieve the |
|
53 | - * actual defaults |
|
54 | - * @since 6.0.0 |
|
55 | - */ |
|
56 | - public function __construct(\OC_Defaults $defaults = null) { |
|
57 | - if ($defaults === null) { |
|
58 | - $defaults = \OC::$server->getThemingDefaults(); |
|
59 | - } |
|
60 | - $this->defaults = $defaults; |
|
61 | - } |
|
62 | - |
|
63 | - /** |
|
64 | - * get base URL for the organisation behind your ownCloud instance |
|
65 | - * @return string |
|
66 | - * @since 6.0.0 |
|
67 | - */ |
|
68 | - public function getBaseUrl() { |
|
69 | - return $this->defaults->getBaseUrl(); |
|
70 | - } |
|
71 | - |
|
72 | - /** |
|
73 | - * link to the desktop sync client |
|
74 | - * @return string |
|
75 | - * @since 6.0.0 |
|
76 | - */ |
|
77 | - public function getSyncClientUrl() { |
|
78 | - return $this->defaults->getSyncClientUrl(); |
|
79 | - } |
|
80 | - |
|
81 | - /** |
|
82 | - * link to the iOS client |
|
83 | - * @return string |
|
84 | - * @since 8.0.0 |
|
85 | - */ |
|
86 | - public function getiOSClientUrl() { |
|
87 | - return $this->defaults->getiOSClientUrl(); |
|
88 | - } |
|
89 | - |
|
90 | - /** |
|
91 | - * link to the Android client |
|
92 | - * @return string |
|
93 | - * @since 8.0.0 |
|
94 | - */ |
|
95 | - public function getAndroidClientUrl() { |
|
96 | - return $this->defaults->getAndroidClientUrl(); |
|
97 | - } |
|
98 | - |
|
99 | - /** |
|
100 | - * base URL to the documentation of your ownCloud instance |
|
101 | - * @return string |
|
102 | - * @since 6.0.0 |
|
103 | - */ |
|
104 | - public function getDocBaseUrl() { |
|
105 | - return $this->defaults->getDocBaseUrl(); |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * name of your ownCloud instance |
|
110 | - * @return string |
|
111 | - * @since 6.0.0 |
|
112 | - */ |
|
113 | - public function getName() { |
|
114 | - return $this->defaults->getName(); |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * name of your ownCloud instance containing HTML styles |
|
119 | - * @return string |
|
120 | - * @since 8.0.0 |
|
121 | - * @depreacted 22.0.0 |
|
122 | - */ |
|
123 | - public function getHTMLName() { |
|
124 | - return $this->defaults->getHTMLName(); |
|
125 | - } |
|
126 | - |
|
127 | - /** |
|
128 | - * Entity behind your onwCloud instance |
|
129 | - * @return string |
|
130 | - * @since 6.0.0 |
|
131 | - */ |
|
132 | - public function getEntity() { |
|
133 | - return $this->defaults->getEntity(); |
|
134 | - } |
|
135 | - |
|
136 | - /** |
|
137 | - * ownCloud slogan |
|
138 | - * @return string |
|
139 | - * @since 6.0.0 |
|
140 | - */ |
|
141 | - public function getSlogan(?string $lang = null) { |
|
142 | - return $this->defaults->getSlogan($lang); |
|
143 | - } |
|
144 | - |
|
145 | - /** |
|
146 | - * footer, short version |
|
147 | - * @return string |
|
148 | - * @since 6.0.0 |
|
149 | - */ |
|
150 | - public function getShortFooter() { |
|
151 | - return $this->defaults->getShortFooter(); |
|
152 | - } |
|
153 | - |
|
154 | - /** |
|
155 | - * footer, long version |
|
156 | - * @return string |
|
157 | - * @since 6.0.0 |
|
158 | - */ |
|
159 | - public function getLongFooter() { |
|
160 | - return $this->defaults->getLongFooter(); |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Returns the AppId for the App Store for the iOS Client |
|
165 | - * @return string AppId |
|
166 | - * @since 8.0.0 |
|
167 | - */ |
|
168 | - public function getiTunesAppId() { |
|
169 | - return $this->defaults->getiTunesAppId(); |
|
170 | - } |
|
171 | - |
|
172 | - /** |
|
173 | - * Themed logo url |
|
174 | - * |
|
175 | - * @param bool $useSvg Whether to point to the SVG image or a fallback |
|
176 | - * @return string |
|
177 | - * @since 12.0.0 |
|
178 | - */ |
|
179 | - public function getLogo($useSvg = true) { |
|
180 | - return $this->defaults->getLogo($useSvg); |
|
181 | - } |
|
182 | - |
|
183 | - /** |
|
184 | - * Returns primary color |
|
185 | - * @return string |
|
186 | - * @since 12.0.0 |
|
187 | - */ |
|
188 | - public function getColorPrimary() { |
|
189 | - return $this->defaults->getColorPrimary(); |
|
190 | - } |
|
191 | - |
|
192 | - /** |
|
193 | - * @param string $key |
|
194 | - * @return string URL to doc with key |
|
195 | - * @since 12.0.0 |
|
196 | - */ |
|
197 | - public function buildDocLinkToKey($key) { |
|
198 | - return $this->defaults->buildDocLinkToKey($key); |
|
199 | - } |
|
200 | - |
|
201 | - /** |
|
202 | - * Returns the title |
|
203 | - * @return string title |
|
204 | - * @since 12.0.0 |
|
205 | - */ |
|
206 | - public function getTitle() { |
|
207 | - return $this->defaults->getTitle(); |
|
208 | - } |
|
209 | - |
|
210 | - /** |
|
211 | - * Returns primary color |
|
212 | - * @return string |
|
213 | - * @since 13.0.0 |
|
214 | - */ |
|
215 | - public function getTextColorPrimary() { |
|
216 | - return $this->defaults->getTextColorPrimary(); |
|
217 | - } |
|
45 | + /** |
|
46 | + * \OC_Defaults instance to retrieve the defaults |
|
47 | + * @since 6.0.0 |
|
48 | + */ |
|
49 | + private $defaults; |
|
50 | + |
|
51 | + /** |
|
52 | + * creates a \OC_Defaults instance which is used in all methods to retrieve the |
|
53 | + * actual defaults |
|
54 | + * @since 6.0.0 |
|
55 | + */ |
|
56 | + public function __construct(\OC_Defaults $defaults = null) { |
|
57 | + if ($defaults === null) { |
|
58 | + $defaults = \OC::$server->getThemingDefaults(); |
|
59 | + } |
|
60 | + $this->defaults = $defaults; |
|
61 | + } |
|
62 | + |
|
63 | + /** |
|
64 | + * get base URL for the organisation behind your ownCloud instance |
|
65 | + * @return string |
|
66 | + * @since 6.0.0 |
|
67 | + */ |
|
68 | + public function getBaseUrl() { |
|
69 | + return $this->defaults->getBaseUrl(); |
|
70 | + } |
|
71 | + |
|
72 | + /** |
|
73 | + * link to the desktop sync client |
|
74 | + * @return string |
|
75 | + * @since 6.0.0 |
|
76 | + */ |
|
77 | + public function getSyncClientUrl() { |
|
78 | + return $this->defaults->getSyncClientUrl(); |
|
79 | + } |
|
80 | + |
|
81 | + /** |
|
82 | + * link to the iOS client |
|
83 | + * @return string |
|
84 | + * @since 8.0.0 |
|
85 | + */ |
|
86 | + public function getiOSClientUrl() { |
|
87 | + return $this->defaults->getiOSClientUrl(); |
|
88 | + } |
|
89 | + |
|
90 | + /** |
|
91 | + * link to the Android client |
|
92 | + * @return string |
|
93 | + * @since 8.0.0 |
|
94 | + */ |
|
95 | + public function getAndroidClientUrl() { |
|
96 | + return $this->defaults->getAndroidClientUrl(); |
|
97 | + } |
|
98 | + |
|
99 | + /** |
|
100 | + * base URL to the documentation of your ownCloud instance |
|
101 | + * @return string |
|
102 | + * @since 6.0.0 |
|
103 | + */ |
|
104 | + public function getDocBaseUrl() { |
|
105 | + return $this->defaults->getDocBaseUrl(); |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * name of your ownCloud instance |
|
110 | + * @return string |
|
111 | + * @since 6.0.0 |
|
112 | + */ |
|
113 | + public function getName() { |
|
114 | + return $this->defaults->getName(); |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * name of your ownCloud instance containing HTML styles |
|
119 | + * @return string |
|
120 | + * @since 8.0.0 |
|
121 | + * @depreacted 22.0.0 |
|
122 | + */ |
|
123 | + public function getHTMLName() { |
|
124 | + return $this->defaults->getHTMLName(); |
|
125 | + } |
|
126 | + |
|
127 | + /** |
|
128 | + * Entity behind your onwCloud instance |
|
129 | + * @return string |
|
130 | + * @since 6.0.0 |
|
131 | + */ |
|
132 | + public function getEntity() { |
|
133 | + return $this->defaults->getEntity(); |
|
134 | + } |
|
135 | + |
|
136 | + /** |
|
137 | + * ownCloud slogan |
|
138 | + * @return string |
|
139 | + * @since 6.0.0 |
|
140 | + */ |
|
141 | + public function getSlogan(?string $lang = null) { |
|
142 | + return $this->defaults->getSlogan($lang); |
|
143 | + } |
|
144 | + |
|
145 | + /** |
|
146 | + * footer, short version |
|
147 | + * @return string |
|
148 | + * @since 6.0.0 |
|
149 | + */ |
|
150 | + public function getShortFooter() { |
|
151 | + return $this->defaults->getShortFooter(); |
|
152 | + } |
|
153 | + |
|
154 | + /** |
|
155 | + * footer, long version |
|
156 | + * @return string |
|
157 | + * @since 6.0.0 |
|
158 | + */ |
|
159 | + public function getLongFooter() { |
|
160 | + return $this->defaults->getLongFooter(); |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Returns the AppId for the App Store for the iOS Client |
|
165 | + * @return string AppId |
|
166 | + * @since 8.0.0 |
|
167 | + */ |
|
168 | + public function getiTunesAppId() { |
|
169 | + return $this->defaults->getiTunesAppId(); |
|
170 | + } |
|
171 | + |
|
172 | + /** |
|
173 | + * Themed logo url |
|
174 | + * |
|
175 | + * @param bool $useSvg Whether to point to the SVG image or a fallback |
|
176 | + * @return string |
|
177 | + * @since 12.0.0 |
|
178 | + */ |
|
179 | + public function getLogo($useSvg = true) { |
|
180 | + return $this->defaults->getLogo($useSvg); |
|
181 | + } |
|
182 | + |
|
183 | + /** |
|
184 | + * Returns primary color |
|
185 | + * @return string |
|
186 | + * @since 12.0.0 |
|
187 | + */ |
|
188 | + public function getColorPrimary() { |
|
189 | + return $this->defaults->getColorPrimary(); |
|
190 | + } |
|
191 | + |
|
192 | + /** |
|
193 | + * @param string $key |
|
194 | + * @return string URL to doc with key |
|
195 | + * @since 12.0.0 |
|
196 | + */ |
|
197 | + public function buildDocLinkToKey($key) { |
|
198 | + return $this->defaults->buildDocLinkToKey($key); |
|
199 | + } |
|
200 | + |
|
201 | + /** |
|
202 | + * Returns the title |
|
203 | + * @return string title |
|
204 | + * @since 12.0.0 |
|
205 | + */ |
|
206 | + public function getTitle() { |
|
207 | + return $this->defaults->getTitle(); |
|
208 | + } |
|
209 | + |
|
210 | + /** |
|
211 | + * Returns primary color |
|
212 | + * @return string |
|
213 | + * @since 13.0.0 |
|
214 | + */ |
|
215 | + public function getTextColorPrimary() { |
|
216 | + return $this->defaults->getTextColorPrimary(); |
|
217 | + } |
|
218 | 218 | } |