Move \OCP\Preview to PSR-4

1 files changed, 58 insertions, 0 deletions

diff --git a/lib/public/Preview/IProvider.php b/lib/public/Preview/IProvider.php
new file mode 100644
index 00000000000..8231e90f000
--- /dev/null
+++ b/lib/public/Preview/IProvider.php
@@ -0,0 +1,58 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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 OCP\Preview;
+
+/**
+ * Interface IProvider
+ *
+ * @package OCP\Preview
+ * @since 8.1.0
+ */
+interface IProvider {
+	/**
+	 * @return string Regex with the mimetypes that are supported by this provider
+	 * @since 8.1.0
+	 */
+	public function getMimeType();
+
+	/**
+	 * Check if a preview can be generated for $path
+	 *
+	 * @param \OCP\Files\FileInfo $file
+	 * @return bool
+	 * @since 8.1.0
+	 */
+	public function isAvailable(\OCP\Files\FileInfo $file);
+
+	/**
+	 * 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 bool|\OCP\IImage false if no preview was generated
+	 * @since 8.1.0
+	 */
+	public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);
+}