paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\Images; /** * Expected behavior of an Image handler */ interface ImageHandlerInterface { /** * Resize the image * * @param integer $width * @param integer $height * @param boolean $maintainRatio If true, will get the closest match possible while keeping aspect ratio true. * @param string $masterDim * * @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 integer|null $width * @param integer|null $height * @param integer|null $x X-axis coord to start cropping from the left of image * @param integer|null $y Y-axis coord to start cropping from the top of image * @param boolean $maintainRatio * @param string $masterDim * * @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 integer|null $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. * * @param float $angle * * @return $this */ public function rotate(float $angle); //-------------------------------------------------------------------- /** * Flattens transparencies, default white background * * @param integer $red * @param integer $green * @param integer $blue * * @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 * * @param integer $width * @param integer $height * @param string $position * * @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 * - hOffset * - vOffset * - fontPath * - fontSize * - shadowOffset * * @param string $text * @param array $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 string $target * @param integer $quality * * @return boolean */ public function save(string $target = null, int $quality = 90); } |
Commits for paulgoughbooks_old/trunk/system/Images/ImageHandlerInterface.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |