nextcloud/lib/public/ipreview.php

59 lines
1.9 KiB
PHP
Raw Normal View History

2013-09-05 01:45:11 +04:00
<?php
/**
2015-02-23 13:28:53 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
*
2015-02-23 13:28:53 +03:00
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
2015-02-23 13:28:53 +03:00
* 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.
*
2015-02-23 13:28:53 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-02-23 13:28:53 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-02-23 13:28:53 +03:00
* 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/>
*
2013-09-05 01:45:11 +04:00
*/
2013-11-03 16:38:25 +04:00
// 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
2013-09-05 01:45:11 +04:00
namespace OCP;
/**
* This class provides functions to render and show thumbnails and previews of files
*/
interface IPreview
{
/**
2013-10-31 22:00:53 +04:00
* Return a preview of a file
2013-09-05 01:45:11 +04:00
* @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\Image
*/
function createPreview($file, $maxX = 100, $maxY = 75, $scaleUp = false);
/**
2013-10-31 22:00:53 +04:00
* Returns true if the passed mime type is supported
2013-09-05 01:45:11 +04:00
* @param string $mimeType
* @return boolean
*/
function isMimeSupported($mimeType = '*');
2014-07-30 18:29:18 +04:00
/**
* Check if a preview can be generated for a file
*
* @param \OCP\Files\FileInfo $file
* @return bool
*/
function isAvailable($file);
2013-09-05 01:45:11 +04:00
}