* @author Joas Schilling * @author Morris Jobke * @author Robin Appelman * @author Roeland Jago Douma * @author Thomas Müller * * @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 * */ /** * Public interface of ownCloud for apps to use. * Preview interface * */ // 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; use OCP\Files\File; use OCP\Files\NotFoundException; use OCP\Files\SimpleFS\ISimpleFile; /** * This class provides functions to render and show thumbnails and previews of files * @since 6.0.0 */ interface IPreview { /** * @since 9.2.0 * @deprecated 22.0.0 */ public const EVENT = self::class . ':' . 'PreviewRequested'; public const MODE_FILL = 'fill'; public const MODE_COVER = 'cover'; /** * In order to improve lazy loading a closure can be registered which will be * called in case preview providers are actually requested * * $callable has to return an instance of \OCP\Preview\IProvider * * @param string $mimeTypeRegex Regex with the mime types that are supported by this provider * @param \Closure $callable * @return void * @since 8.1.0 */ public function registerProvider($mimeTypeRegex, \Closure $callable); /** * Get all providers * @return array * @since 8.1.0 */ public function getProviders(); /** * Does the manager have any providers * @return bool * @since 8.1.0 */ public function hasProviders(); /** * Returns a preview of a file * * The cache is searched first and if nothing usable was found then a preview is * generated by one of the providers * * @param File $file * @param int $width * @param int $height * @param bool $crop * @param string $mode * @param string $mimeType To force a given mimetype for the file (files_versions needs this) * @return ISimpleFile * @throws NotFoundException * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) * @since 11.0.0 - \InvalidArgumentException was added in 12.0.0 */ public function getPreview(File $file, $width = -1, $height = -1, $crop = false, $mode = IPreview::MODE_FILL, $mimeType = null); /** * Returns true if the passed mime type is supported * @param string $mimeType * @return boolean * @since 6.0.0 */ public function isMimeSupported($mimeType = '*'); /** * Check if a preview can be generated for a file * * @param \OCP\Files\FileInfo $file * @return bool * @since 8.0.0 */ public function isAvailable(\OCP\Files\FileInfo $file); /** * Generates previews of a file * * @param File $file * @param array $specifications * @param string $mimeType * @return ISimpleFile the last preview that was generated * @throws NotFoundException * @throws \InvalidArgumentException if the preview would be invalid (in case the original image is invalid) * @since 19.0.0 */ public function generatePreviews(File $file, array $specifications, $mimeType = null); } ry_builder'>artonge/feat/add_retry_support_to_query_builder Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
summaryrefslogtreecommitdiffstats
blob: bcdb286d4a38ec02ae84bc9dbdb3fbea1d691b88 (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