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
236
237
238
239
240
241
242
243
244
245
246
247
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Bart Visscher <bartv@thisnet.nl>
* @author Frank Karlitschek <frank@karlitschek.de>
* @author Georg Ehrke <georg@owncloud.com>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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.
* Template 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;
/**
* Make OC_Helper::imagePath available as a simple function
* @param string $app
* @param string $image
* @return string to the image
*
* @see \OCP\IURLGenerator::imagePath
* @deprecated 8.0.0 Use \OCP\Template::image_path() instead
* @suppress PhanDeprecatedFunction
*/
function image_path($app, $image) {
return \image_path($app, $image);
}
/**
* Make OC_Helper::mimetypeIcon available as a simple function
* @param string $mimetype
* @return string to the image of this file type.
* @deprecated 8.0.0 Use \OCP\Template::mimetype_icon() instead
* @suppress PhanDeprecatedFunction
*/
function mimetype_icon($mimetype) {
return \mimetype_icon($mimetype);
}
/**
* Make preview_icon available as a simple function
* @param string $path path to file
* @return string to the preview of the image
* @deprecated 8.0.0 Use \OCP\Template::preview_icon() instead
* @suppress PhanDeprecatedFunction
*/
function preview_icon($path) {
return \preview_icon($path);
}
/**
* Make publicpreview_icon available as a simple function
* Returns the path to the preview of the image.
* @param string $path of file
* @param string $token
* @return string link to the preview
* @deprecated 8.0.0 Use \OCP\Template::publicPreview_icon() instead
* @suppress PhanDeprecatedFunction
*/
function publicPreview_icon($path, $token) {
return \publicPreview_icon($path, $token);
}
/**
* Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB.
* @param int $bytes in bytes
* @return string size as string
* @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
* @suppress PhanDeprecatedFunction
*/
function human_file_size($bytes) {
return \human_file_size($bytes);
}
/**
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
* @param int $timestamp unix timestamp
* @param boolean $dateOnly
* @return string human readable interpretation of the timestamp
*
* @deprecated 8.0.0 Use \OCP\Template::relative_modified_date() instead
* @suppress PhanDeprecatedFunction
* @suppress PhanTypeMismatchArgument
*/
function relative_modified_date($timestamp, $dateOnly = false) {
return \relative_modified_date($timestamp, null, $dateOnly);
}
/**
* Return a human readable outout for a file size.
* @param integer $bytes size of a file in byte
* @return string human readable interpretation of a file size
* @deprecated 8.0.0 Use \OCP\Template::human_file_size() instead
* @suppress PhanDeprecatedFunction
*/
function simple_file_size($bytes) {
return \human_file_size($bytes);
}
/**
* Generate html code for an options block.
* @param array $options the options
* @param mixed $selected which one is selected?
* @param array $params the parameters
* @return string html options
* @deprecated 8.0.0 Use \OCP\Template::html_select_options() instead
* @suppress PhanDeprecatedFunction
*/
function html_select_options($options, $selected, $params=array()) {
return \html_select_options($options, $selected, $params);
}
/**
* This class provides the template system for owncloud. You can use it to load
* specific templates, add data and generate the html code
*
* @since 8.0.0
*/
class Template extends \OC_Template {
/**
* Make OC_Helper::imagePath available as a simple function
*
* @see \OCP\IURLGenerator::imagePath
*
* @param string $app
* @param string $image
* @return string to the image
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function image_path($app, $image) {
return \image_path($app, $image);
}
/**
* Make OC_Helper::mimetypeIcon available as a simple function
*
* @param string $mimetype
* @return string to the image of this file type.
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function mimetype_icon($mimetype) {
return \mimetype_icon($mimetype);
}
/**
* Make preview_icon available as a simple function
*
* @param string $path path to file
* @return string to the preview of the image
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function preview_icon($path) {
return \preview_icon($path);
}
/**
* Make publicpreview_icon available as a simple function
* Returns the path to the preview of the image.
*
* @param string $path of file
* @param string $token
* @return string link to the preview
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function publicPreview_icon($path, $token) {
return \publicPreview_icon($path, $token);
}
/**
* Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB.
*
* @param int $bytes in bytes
* @return string size as string
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function human_file_size($bytes) {
return \human_file_size($bytes);
}
/**
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
*
* @param int $timestamp unix timestamp
* @param boolean $dateOnly
* @return string human readable interpretation of the timestamp
* @since 8.0.0
* @suppress PhanDeprecatedFunction
* @suppress PhanTypeMismatchArgument
*/
public static function relative_modified_date($timestamp, $dateOnly = false) {
return \relative_modified_date($timestamp, null, $dateOnly);
}
/**
* Generate html code for an options block.
*
* @param array $options the options
* @param mixed $selected which one is selected?
* @param array $params the parameters
* @return string html options
* @since 8.0.0
* @suppress PhanDeprecatedFunction
*/
public static function html_select_options($options, $selected, $params=array()) {
return \html_select_options($options, $selected, $params);
}
}
|