156 lines
3.4 KiB
PHP
156 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* @author Joas Schilling <nickvergessen@owncloud.com>
|
|
*
|
|
* @copyright Copyright (c) 2015, 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
|
|
*/
|
|
interface IImage {
|
|
/**
|
|
* Determine whether the object contains an image resource.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function valid();
|
|
|
|
/**
|
|
* Returns the MIME type of the image or an empty string if no image is loaded.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function mimeType();
|
|
|
|
/**
|
|
* Returns the width of the image or -1 if no image is loaded.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function width();
|
|
|
|
/**
|
|
* Returns the height of the image or -1 if no image is loaded.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function height();
|
|
|
|
/**
|
|
* Returns the width when the image orientation is top-left.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function widthTopLeft();
|
|
|
|
/**
|
|
* Returns the height when the image orientation is top-left.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function heightTopLeft();
|
|
|
|
/**
|
|
* Outputs the image.
|
|
*
|
|
* @param string $mimeType
|
|
* @return bool
|
|
*/
|
|
public function show($mimeType = null);
|
|
|
|
/**
|
|
* Saves the image.
|
|
*
|
|
* @param string $filePath
|
|
* @param string $mimeType
|
|
* @return bool
|
|
*/
|
|
public function save($filePath = null, $mimeType = null);
|
|
|
|
/**
|
|
* @return resource Returns the image resource in any.
|
|
*/
|
|
public function resource();
|
|
|
|
/**
|
|
* @return string Returns the raw image data.
|
|
*/
|
|
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.
|
|
*/
|
|
public function getOrientation();
|
|
|
|
/**
|
|
* (I'm open for suggestions on better method name ;)
|
|
* Fixes orientation based on EXIF data.
|
|
*
|
|
* @return bool.
|
|
*/
|
|
public function fixOrientation();
|
|
|
|
/**
|
|
* Resizes the image preserving ratio.
|
|
*
|
|
* @param integer $maxSize The maximum size of either the width or height.
|
|
* @return bool
|
|
*/
|
|
public function resize($maxSize);
|
|
|
|
/**
|
|
* @param int $width
|
|
* @param int $height
|
|
* @return bool
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
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
|
|
*/
|
|
public function fitIn($maxWidth, $maxHeight);
|
|
}
|