aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/IImage.php
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 08:00:09 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-05-19 09:43:33 +0200
commitd666725fa783c21235eec79fa6dbe8ba1881fec3 (patch)
tree98914481ca4218c9af2c04db17c6d8f281b0094d /lib/public/IImage.php
parent4a94203492e3b475ee26b65d5992796152c645bd (diff)
downloadnextcloud-server-d666725fa783c21235eec79fa6dbe8ba1881fec3.tar.gz
nextcloud-server-d666725fa783c21235eec79fa6dbe8ba1881fec3.zip
Move \OCP to PSR-4
Diffstat (limited to 'lib/public/IImage.php')
-rw-r--r--lib/public/IImage.php185
1 files changed, 185 insertions, 0 deletions
diff --git a/lib/public/IImage.php b/lib/public/IImage.php
new file mode 100644
index 00000000000..db0ca0f93be
--- /dev/null
+++ b/lib/public/IImage.php
@@ -0,0 +1,185 @@
+<?php
+/**
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Olivier Paroz <github@oparoz.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 OCP;
+
+/**
+ * Class for basic image manipulation
+ * @since 8.1.0
+ */
+interface IImage {
+ /**
+ * Determine whether the object contains an image resource.
+ *
+ * @return bool
+ * @since 8.1.0
+ */
+ public function valid();
+
+ /**
+ * Returns the MIME type of the image or an empty string if no image is loaded.
+ *
+ * @return string
+ * @since 8.1.0
+ */
+ public function mimeType();
+
+ /**
+ * Returns the width of the image or -1 if no image is loaded.
+ *
+ * @return int
+ * @since 8.1.0
+ */
+ public function width();
+
+ /**
+ * Returns the height of the image or -1 if no image is loaded.
+ *
+ * @return int
+ * @since 8.1.0
+ */
+ public function height();
+
+ /**
+ * Returns the width when the image orientation is top-left.
+ *
+ * @return int
+ * @since 8.1.0
+ */
+ public function widthTopLeft();
+
+ /**
+ * Returns the height when the image orientation is top-left.
+ *
+ * @return int
+ * @since 8.1.0
+ */
+ public function heightTopLeft();
+
+ /**
+ * Outputs the image.
+ *
+ * @param string $mimeType
+ * @return bool
+ * @since 8.1.0
+ */
+ public function show($mimeType = null);
+
+ /**
+ * Saves the image.
+ *
+ * @param string $filePath
+ * @param string $mimeType
+ * @return bool
+ * @since 8.1.0
+ */
+ public function save($filePath = null, $mimeType = null);
+
+ /**
+ * @return resource Returns the image resource in any.
+ * @since 8.1.0
+ */
+ public function resource();
+
+ /**
+ * @return string Returns the raw image data.
+ * @since 8.1.0
+ */
+ public function data();
+
+ /**
+ * (I'm open for suggestions on better method name ;)
+ * Get the orientation based on EXIF data.
+ *
+ * @return int The orientation or -1 if no EXIF data is available.
+ * @since 8.1.0
+ */
+ public function getOrientation();
+
+ /**
+ * (I'm open for suggestions on better method name ;)
+ * Fixes orientation based on EXIF data.
+ *
+ * @return bool
+ * @since 8.1.0
+ */
+ public function fixOrientation();
+
+ /**
+ * Resizes the image preserving ratio.
+ *
+ * @param integer $maxSize The maximum size of either the width or height.
+ * @return bool
+ * @since 8.1.0
+ */
+ public function resize($maxSize);
+
+ /**
+ * @param int $width
+ * @param int $height
+ * @return bool
+ * @since 8.1.0
+ */
+ public function preciseResize($width, $height);
+
+ /**
+ * Crops the image to the middle square. If the image is already square it just returns.
+ *
+ * @param int $size maximum size for the result (optional)
+ * @return bool for success or failure
+ * @since 8.1.0
+ */
+ public function centerCrop($size = 0);
+
+ /**
+ * Crops the image from point $x$y with dimension $wx$h.
+ *
+ * @param int $x Horizontal position
+ * @param int $y Vertical position
+ * @param int $w Width
+ * @param int $h Height
+ * @return bool for success or failure
+ * @since 8.1.0
+ */
+ public function crop($x, $y, $w, $h);
+
+ /**
+ * Resizes the image to fit within a boundary while preserving ratio.
+ *
+ * @param integer $maxWidth
+ * @param integer $maxHeight
+ * @return bool
+ * @since 8.1.0
+ */
+ public function fitIn($maxWidth, $maxHeight);
+
+ /**
+ * Shrinks the image to fit within a boundary while preserving ratio.
+ *
+ * @param integer $maxWidth
+ * @param integer $maxHeight
+ * @return bool
+ * @since 8.1.0
+ */
+ public function scaleDownToFit($maxWidth, $maxHeight);
+}