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

class Resize

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);

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

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

None.

None declared.

^ 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()'' | @SuppressWarnings(PHPMD.ElseExpression) | 168 |
| private | ''getOptimalCrop()'' | (undocumented) | 198 |
| private | ''crop()'' | (undocumented) | 219 |
| public | ''saveImage()'' | (undocumented) | 234 |

public function __construct($fileName)

lines 56–64 (9)

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

private function openImage($file)

lines 67–92 (26)

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

Returns: (none declared)

public function resizeImage($newWidth, $newHeight, $option = "auto")

lines 95–111 (17)

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

Returns: (none declared)

private function getDimensions($newWidth, $newHeight, $option)

lines 114–150 (37)

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

Returns: (none declared)

private function getSizeByFixedHeight($newHeight)

lines 153–158 (6)

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

Returns: (none declared)

private function getSizeByFixedWidth($newWidth)

lines 160–165 (6)

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

Returns: (none declared)

private function getSizeByAuto($newWidth, $newHeight)

lines 168–195 (28)

@SuppressWarnings(PHPMD.ElseExpression)

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

Returns: (none declared)

private function getOptimalCrop($newWidth, $newHeight)

lines 198–216 (19)

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

Returns: (none declared)

private function crop($optimalWidth, $optimalHeight, $newWidth, $newHeight)

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)

public function saveImage($savePath, $imageQuality = "100")

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.