server/lib/private/preview/provider.php

39 lines
1.1 KiB
PHP
Raw Normal View History

2013-04-25 10:51:44 +00:00
<?php
2013-05-29 10:33:24 +00:00
namespace OC\Preview;
2013-05-29 11:11:43 +00:00
abstract class Provider {
2013-04-25 10:51:44 +00:00
private $options;
public function __construct($options) {
$this->options = $options;
2013-04-25 10:51:44 +00:00
}
2013-05-17 17:08:16 +00:00
/**
* @return string Regex with the mimetypes that are supported by this provider
*/
2013-04-25 10:51:44 +00:00
abstract public function getMimeType();
2014-07-30 14:29:18 +00:00
/**
* Check if a preview can be generated for $path
*
* @param \OC\Files\FileInfo $file
2014-07-30 14:29:18 +00:00
* @return bool
*/
public function isAvailable($file) {
2014-07-30 14:29:18 +00:00
return true;
}
2013-04-25 10:51:44 +00:00
/**
* get thumbnail for file at path $path
* @param string $path Path of file
* @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 bool $scalingup Disable/Enable upscaling of previews
* @param \OC\Files\View $fileview fileview object of user folder
* @return mixed
* false if no preview was generated
* OC_Image object of the preview
2013-04-25 10:51:44 +00:00
*/
2013-05-29 11:03:33 +00:00
abstract public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
2013-04-25 10:51:44 +00:00
}