nextcloud/lib/private/Preview/Provider.php

70 lines
2.1 KiB
PHP
Raw Normal View History

2013-04-25 14:51:44 +04:00
<?php
2015-03-26 13:44:34 +03:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Georg Ehrke <oc.list@georgehrke.com>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
2015-03-26 13:44:34 +03:00
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
2015-06-25 12:43:55 +03:00
* @author Olivier Paroz <github@oparoz.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2015-03-26 13:44:34 +03:00
*
* @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/>
*
*/
2013-05-29 14:33:24 +04:00
namespace OC\Preview;
use OCP\Preview\IProvider;
abstract class Provider implements IProvider {
2013-04-25 14:51:44 +04:00
private $options;
2015-03-12 14:08:31 +03:00
/**
* Constructor
*
* @param array $options
*/
public function __construct(array $options = []) {
$this->options = $options;
2013-04-25 14:51:44 +04:00
}
2013-05-17 21:08:16 +04:00
/**
* @return string Regex with the mimetypes that are supported by this provider
*/
2013-04-25 14:51:44 +04:00
abstract public function getMimeType();
2014-07-30 18:29:18 +04:00
/**
* Check if a preview can be generated for $path
*
* @param \OCP\Files\FileInfo $file
2014-07-30 18:29:18 +04:00
* @return bool
*/
2015-03-12 14:20:39 +03:00
public function isAvailable(\OCP\Files\FileInfo $file) {
2014-07-30 18:29:18 +04:00
return true;
}
2013-04-25 14:51:44 +04:00
/**
* Generates thumbnail which fits in $maxX and $maxY and keeps the aspect ratio, 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 bool|\OCP\IImage false if no preview was generated
2013-04-25 14:51:44 +04:00
*/
2013-05-29 15:03:33 +04:00
abstract public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
2013-04-25 14:51:44 +04:00
}