diff options
Diffstat (limited to 'lib/public/IPreview.php')
| -rw-r--r-- | lib/public/IPreview.php | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/lib/public/IPreview.php b/lib/public/IPreview.php new file mode 100644 index 00000000000..cfcbebd8639 --- /dev/null +++ b/lib/public/IPreview.php @@ -0,0 +1,95 @@ +<?php +/** + * @author Joas Schilling <nickvergessen@owncloud.com> + * @author Morris Jobke <hey@morrisjobke.de> + * @author Robin Appelman <icewind@owncloud.com> + * @author Thomas Müller <thomas.mueller@tmit.eu> + * + * @copyright Copyright (c) 2016, ownCloud, Inc. + * @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. + * 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; + +/** + * This class provides functions to render and show thumbnails and previews of files + * @since 6.0.0 + */ +interface IPreview { + /** + * 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(); + + /** + * Return a preview of a file + * @param string $file The path to the file where you want a thumbnail from + * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image + * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image + * @param boolean $scaleUp Scale smaller images up to the thumbnail size or not. Might look ugly + * @return \OCP\IImage + * @since 6.0.0 + */ + public function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false); + + + /** + * 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); +} |