====== Resize ======

**Layer:** ''Core'' · **Source:** ''lib/core/Resize.php:22'' (lines 22–289)

----
<code>
class Resize
</code>

Purpose: Resizing and save image
Require PHP5+, GD library

Usage Example:
$resizeObj = new resize('images/cars/large/input.jpg');
$resizeObj -> resizeImage(150, 100, 0)
$resizeObj -> saveImage('images/cars/large/output.jpg', 100);

======= Docblock Metadata =======

^ Tag ^ Value ^
| ''@category'' | Core Class |
| ''@author'' | Jarrod Oberto |

======= Inheritance =======

//No parent, interface or trait. This is a root type.//

======= Constants (0) =======

//None.//

======= Properties (4) =======

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$image'' |  | 30 |
| ''private'' | ''(untyped)'' | ''$width'' |  | 38 |
| ''private'' | ''(untyped)'' | ''$height'' |  | 46 |
| ''private'' | ''(untyped)'' | ''$imageResized'' |  | 54 |

======= Methods (10) =======

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | (undocumented) | 56 |
| private | ''openImage()'' | (undocumented) | 67 |
| public | ''resizeImage()'' | (undocumented) | 95 |
| private | ''getDimensions()'' | (undocumented) | 114 |
| private | ''getSizeByFixedHeight()'' | (undocumented) | 153 |
| private | ''getSizeByFixedWidth()'' | (undocumented) | 160 |
| private | ''getSizeByAuto()'' |  | 168 |
| private | ''getOptimalCrop()'' | (undocumented) | 198 |
| private | ''crop()'' | (undocumented) | 219 |
| public | ''saveImage()'' | (undocumented) | 234 |


======== __construct() ========

<code>
public function __construct($fileName)
</code>

//lines 56–64 (9)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$fileName'' |  ''(untyped)'' |  //required// |  //none// |


======== openImage() ========

<code>
private function openImage($file)
</code>

//lines 67–92 (26)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$file'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== resizeImage() ========

<code>
public function resizeImage($newWidth, $newHeight, $option = &quot;auto&quot;)
</code>

//lines 95–111 (17)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$option'' |  ''(untyped)'' |  ''"auto"'' |  //none// |

**Returns:** ''(none declared)''


======== getDimensions() ========

<code>
private function getDimensions($newWidth, $newHeight, $option)
</code>

//lines 114–150 (37)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$option'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== getSizeByFixedHeight() ========

<code>
private function getSizeByFixedHeight($newHeight)
</code>

//lines 153–158 (6)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== getSizeByFixedWidth() ========

<code>
private function getSizeByFixedWidth($newWidth)
</code>

//lines 160–165 (6)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== getSizeByAuto() ========

<code>
private function getSizeByAuto($newWidth, $newHeight)
</code>

//lines 168–195 (28)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== getOptimalCrop() ========

<code>
private function getOptimalCrop($newWidth, $newHeight)
</code>

//lines 198–216 (19)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== crop() ========

<code>
private function crop($optimalWidth, $optimalHeight, $newWidth, $newHeight)
</code>

//lines 219–231 (13)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$optimalWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$optimalHeight'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newWidth'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$newHeight'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== saveImage() ========

<code>
public function saveImage($savePath, $imageQuality = &quot;100&quot;)
</code>

//lines 234–286 (53)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$savePath'' |  ''(untyped)'' |  //required// |  //none// |
|  ''$imageQuality'' |  ''(untyped)'' |  ''"100"'' |  //none// |

**Returns:** ''(none declared)''


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//