-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathImageHandlerInterface.php
More file actions
159 lines (144 loc) · 4.3 KB
/
ImageHandlerInterface.php
File metadata and controls
159 lines (144 loc) · 4.3 KB
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
<?php
declare(strict_types=1);
/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/
namespace CodeIgniter\Images;
/**
* Expected behavior of an Image handler
*/
interface ImageHandlerInterface
{
/**
* Resize the image
*
* @param bool $maintainRatio If true, will get the closest match possible while keeping aspect ratio true.
*
* @return $this
*/
public function resize(int $width, int $height, bool $maintainRatio = false, string $masterDim = 'auto');
/**
* Crops the image to the desired height and width. If one of the height/width values
* is not provided, that value will be set the appropriate value based on offsets and
* image dimensions.
*
* @param int|null $x X-axis coord to start cropping from the left of image
* @param int|null $y Y-axis coord to start cropping from the top of image
*
* @return $this
*/
public function crop(?int $width = null, ?int $height = null, ?int $x = null, ?int $y = null, bool $maintainRatio = false, string $masterDim = 'auto');
/**
* Changes the stored image type to indicate the new file format to use when saving.
* Does not touch the actual resource.
*
* @param int $imageType A PHP imagetype constant, e.g. https://www.php.net/manual/en/function.image-type-to-mime-type.php
*
* @return $this
*/
public function convert(int $imageType);
/**
* Rotates the image on the current canvas.
*
* @return $this
*/
public function rotate(float $angle);
/**
* Flattens transparencies, default white background
*
* @return $this
*/
public function flatten(int $red = 255, int $green = 255, int $blue = 255);
/**
* Reads the EXIF information from the image and modifies the orientation
* so that displays correctly in the browser.
*
* @return ImageHandlerInterface
*/
public function reorient();
/**
* Retrieve the EXIF information from the image, if possible. Returns
* an array of the information, or null if nothing can be found.
*
* @param string|null $key If specified, will only return this piece of EXIF data.
*
* @return mixed
*/
public function getEXIF(?string $key = null);
/**
* Flip an image horizontally or vertically
*
* @param string $dir Direction to flip, either 'vertical' or 'horizontal'
*
* @return $this
*/
public function flip(string $dir = 'vertical');
/**
* Combine cropping and resizing into a single command.
*
* Supported positions:
* - top-left
* - top
* - top-right
* - left
* - center
* - right
* - bottom-left
* - bottom
* - bottom-right
*
* @return $this
*/
public function fit(int $width, int $height, string $position);
/**
* Overlays a string of text over the image.
*
* Valid options:
*
* - color Text Color (hex number)
* - shadowColor Color of the shadow (hex number)
* - hAlign Horizontal alignment: left, center, right
* - vAlign Vertical alignment: top, middle, bottom
*
* @param array{
* color?: string,
* shadowColor?: string,
* hAlign?: string,
* vAlign?: string,
* hOffset?: int,
* vOffset?: int,
* fontPath?: string,
* fontSize?: int,
* shadowOffset?: int,
* opacity?: float,
* padding?: int,
* withShadow?: bool|string
* } $options
*
* @return $this
*/
public function text(string $text, array $options = []);
/**
* Saves any changes that have been made to file.
*
* Example:
* $image->resize(100, 200, true)
* ->save($target);
*
* @param non-empty-string|null $target The path to save the file to.
*
* @return bool
*/
public function save(?string $target = null, int $quality = 90);
/**
* Clear metadata before saving image as a new file.
*
* @return $this
*/
public function clearMetadata(): static;
}