Overview

Namespaces

  • Gumlet

Classes

  • ImageResize

Exceptions

  • ImageResizeException
  • Overview
  • Namespace
  • Class

Class ImageResize

PHP class to resize and scale images

Namespace: Gumlet
Located at ImageResize.php
Methods summary
public static Gumlet\ImageResize
# createFromString( string $image_data )

Create instance from a strng

Create instance from a strng

Parameters

$image_data

Returns

Gumlet\ImageResize

Throws

Gumlet\ImageResizeException
public
# addFilter( callable $filter )

Add filter function for use right before save image to file.

Add filter function for use right before save image to file.

Parameters

$filter

Returns


$this
protected
# applyFilter( $image, $filterType = IMG_FILTER_NEGATE )

Apply filters.

Apply filters.

Parameters

$image
an image resource identifier
$filterType
type and default value is IMG_FILTER_NEGATE
public Gumlet\ImageResize
# __construct( string $filename )

Loads image source and its properties to the instanciated object

Loads image source and its properties to the instanciated object

Parameters

$filename

Returns

Gumlet\ImageResize

Throws

Gumlet\ImageResizeException
public
# imageCreateJpegfromExif( $filename )
public static
# save( string $filename, string $image_type = null, integer $quality = null, integer $permissions = null )

Saves new image

Saves new image

Parameters

$filename
$image_type
$quality
$permissions

Returns

static
public string
# getImageAsString( integer $image_type = null, integer $quality = null )

Convert the image to string

Convert the image to string

Parameters

$image_type
$quality

Returns

string
public string
# __toString( )

Convert the image to string with the current settings

Convert the image to string with the current settings

Returns

string
public
# output( string $image_type = null, integer $quality = null )

Outputs image to browser

Outputs image to browser

Parameters

$image_type
$quality
public static
# resizeToShortSide( integer $max_short, boolean $allow_enlarge = false )

Resizes image according to the given short side (short side proportional)

Resizes image according to the given short side (short side proportional)

Parameters

$max_short
$allow_enlarge

Returns

static
public static
# resizeToLongSide( integer $max_long, boolean $allow_enlarge = false )

Resizes image according to the given long side (short side proportional)

Resizes image according to the given long side (short side proportional)

Parameters

$max_long
$allow_enlarge

Returns

static
public static
# resizeToHeight( integer $height, boolean $allow_enlarge = false )

Resizes image according to the given height (width proportional)

Resizes image according to the given height (width proportional)

Parameters

$height
$allow_enlarge

Returns

static
public static
# resizeToWidth( integer $width, boolean $allow_enlarge = false )

Resizes image according to the given width (height proportional)

Resizes image according to the given width (height proportional)

Parameters

$width
$allow_enlarge

Returns

static
public static
# resizeToBestFit( integer $max_width, integer $max_height, boolean $allow_enlarge = false )

Resizes image to best fit inside the given dimensions

Resizes image to best fit inside the given dimensions

Parameters

$max_width
$max_height
$allow_enlarge

Returns

static
public static
# scale( integer|float $scale )

Resizes image according to given scale (proportionally)

Resizes image according to given scale (proportionally)

Parameters

$scale

Returns

static
public static
# resize( integer $width, integer $height, boolean $allow_enlarge = false )

Resizes image according to the given width and height

Resizes image according to the given width and height

Parameters

$width
$height
$allow_enlarge

Returns

static
public static
# crop( integer $width, integer $height, boolean $allow_enlarge = false, integer $position = self::CROPCENTER )

Crops image according to the given width, height and crop position

Crops image according to the given width, height and crop position

Parameters

$width
$height
$allow_enlarge
$position

Returns

static
public static
# freecrop( integer $width, integer $height, integer $x = false, integer $y = false )

Crops image according to the given width, height, x and y

Crops image according to the given width, height, x and y

Parameters

$width
$height
$x
$y

Returns

static
public integer
# getSourceWidth( )

Gets source width

Gets source width

Returns

integer
public integer
# getSourceHeight( )

Gets source height

Gets source height

Returns

integer
public integer
# getDestWidth( )

Gets width of the destination image

Gets width of the destination image

Returns

integer
public integer
# getDestHeight( )

Gets height of the destination image

Gets height of the destination image

Returns

integer
protected float|integer
# getCropPosition( integer $expectedSize, integer $position = self::CROPCENTER )

Gets crop position (X or Y) according to the given position

Gets crop position (X or Y) according to the given position

Parameters

$expectedSize
$position

Returns

float|integer
public null
# imageFlip( resource $image, integer $mode )

Flips an image using a given mode if PHP version is lower than 5.5

Flips an image using a given mode if PHP version is lower than 5.5

Parameters

$image
$mode

Returns

null
Constants summary
integer CROPTOP
# 1
integer CROPCENTRE
# 2
integer CROPCENTER
# 2
integer CROPBOTTOM
# 3
integer CROPLEFT
# 4
integer CROPRIGHT
# 5
integer CROPTOPCENTER
# 6
integer IMG_FLIP_HORIZONTAL
# 0
integer IMG_FLIP_VERTICAL
# 1
integer IMG_FLIP_BOTH
# 2
Properties summary
public integer $quality_jpg
# 85
public integer $quality_webp
# 85
public integer $quality_png
# 6
public boolean $quality_truecolor
# true
public integer $interlace
# 1
public $source_type
#
protected $source_image
#
protected $original_w
#
protected $original_h
#
protected integer $dest_x
# 0
protected integer $dest_y
# 0
protected $source_x
#
protected $source_y
#
protected $dest_w
#
protected $dest_h
#
protected $source_w
#
protected $source_h
#
protected $source_info
#
protected array $filters
# []
API documentation generated by ApiGen