nextcloud/lib/public/ipreview.php

45 lines
1.3 KiB
PHP
Raw Normal View History

2013-09-05 01:45:11 +04:00
<?php
/**
* Copyright (c) 2013 Frank Karlitschek frank@owncloud.org
* Copyright (c) 2013 Georg Ehrke georg@ownCloud.com
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
2013-11-03 16:38:25 +04:00
/**
* 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
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 = '*');
}