ImageUtils
A utility class for carrying out various image file tasks.
-
since
-
1.1
-
author
-
-
license
-
http://www.opensource.org/licenses/bsd-license.php The BSD License
-
copyright
-
Copyright (c) 2018, John Collins (founder of Alpha Framework).
All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the
following conditions are met:
* Redistributions of source code must retain the above
copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other
materials provided with the distribution.
* Neither the name of the Alpha Framework nor the names
of its contributors may be used to endorse or promote
products derived from this software without specific
prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Table of Contents
-
generateSquareThumbnail()
: mixed
- Generates a perfectly square thumbnail from the supplied original image file.
-
saveImage()
: mixed
- Saves the GD image resource to the file path indicated.
generateSquareThumbnail()
Generates a perfectly square thumbnail from the supplied original image file.
public
static generateSquareThumbnail(string $original, string $thumbnail, int $dimensions) : mixed
Parameters
-
$original
: string
-
The path to the original file
-
$thumbnail
: string
-
The path to the new thumbnail file to generate
-
$dimensions
: int
-
The width/height of the generated thumbnail
-
throws
-
IllegalArguementException
-
since
-
1.1
Return values
mixed
—
saveImage()
Saves the GD image resource to the file path indicated.
public
static saveImage(resource $imageResource, string $type, string $destination) : mixed
Parameters
-
$imageResource
: resource
-
The GD image resource to save
-
$type
: string
-
The image type (jpg, png, or gif)
-
$destination
: string
-
The desination file path of the image file to create
-
throws
-
IllegalArguementException
-
since
-
1.1
Return values
mixed
—