aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Preview/Provider.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-04-20 15:02:44 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-04-20 15:02:44 +0200
commit702046d4aae6f22adc679df6e1a64c7a1504c80e (patch)
tree4ff1a427011a8909910aeedc9bf7d421e57b5f08 /lib/private/Preview/Provider.php
parentafad27fafd996f0e2e7117d9f431f9eb63736569 (diff)
downloadnextcloud-server-702046d4aae6f22adc679df6e1a64c7a1504c80e.tar.gz
nextcloud-server-702046d4aae6f22adc679df6e1a64c7a1504c80e.zip
Move \OC\Preview to PSR-4
Diffstat (limited to 'lib/private/Preview/Provider.php')
-rw-r--r--lib/private/Preview/Provider.php67
1 files changed, 67 insertions, 0 deletions
diff --git a/lib/private/Preview/Provider.php b/lib/private/Preview/Provider.php
new file mode 100644
index 00000000000..738d13d7fc8
--- /dev/null
+++ b/lib/private/Preview/Provider.php
@@ -0,0 +1,67 @@
+<?php
+/**
+ * @author Georg Ehrke <georg@owncloud.com>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Olivier Paroz <github@oparoz.com>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @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/>
+ *
+ */
+namespace OC\Preview;
+
+use OCP\Preview\IProvider;
+
+abstract class Provider implements IProvider {
+ private $options;
+
+ /**
+ * Constructor
+ *
+ * @param array $options
+ */
+ public function __construct(array $options = []) {
+ $this->options = $options;
+ }
+
+ /**
+ * @return string Regex with the mimetypes that are supported by this provider
+ */
+ abstract public function getMimeType();
+
+ /**
+ * Check if a preview can be generated for $path
+ *
+ * @param \OCP\Files\FileInfo $file
+ * @return bool
+ */
+ public function isAvailable(\OCP\Files\FileInfo $file) {
+ return true;
+ }
+
+ /**
+ * 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
+ */
+ abstract public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
+}