1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Olivier Paroz <github@oparoz.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @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 data mimetype
* @since 13.0.0
*/
public function dataMimeType();
/**
* @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(int $width, int $height): bool;
/**
* 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(int $x, int $y, int $w, int $h): bool;
/**
* 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);
}
|
