PHP Class Grafika\Gd\Image

Inheritance: implements Grafika\ImageInterface
Show file Open project: kosinix/grafika Class Usage Examples

Public Methods

Method Description
__clone ( ) Method called when 'clone' keyword is used.
__construct ( resource $gd, string $imageFile, integer $width, integer $height, string $type, string $blocks = '', boolean $animated = false ) Image constructor.
alphaBlendingMode ( boolean $flag ) : self Set the blending mode for an image. Allows transparent overlays on top of an image.
blob ( string | ImageType $type = 'PNG' ) Output a binary raw dump of an image in a specified format.
createBlank ( integer $width = 1, integer $height = 1 ) : Image Create a blank image.
createFromCore ( resource $gd ) : Image Create an Image from a GD resource. The file type defaults to unknown.
createFromFile ( string $imageFile ) : Image Create Image from image file.
fullAlphaMode ( boolean $flag ) : self Enable/Disable transparency
getBlocks ( ) : string. Get blocks.
getCore ( ) : resource Get GD resource ID.
getHeight ( ) : integer Get image height in pixels.
getImageFile ( ) : string Get image file path.
getType ( ) : string Get image type.
getWidth ( ) : integer Get image width in pixels.
histogram ( array | null $slice = null ) : array Get histogram from an entire image or its sub-region.
isAnimated ( ) : boolean Returns animated flag.

Private Methods

Method Description
_createGif ( string $imageFile ) : Image Load a GIF image.
_createJpeg ( string $imageFile ) : Image Load a JPEG image.
_createPng ( string $imageFile ) : Image Load a PNG image.
_createWbmp ( string $imageFile ) : Image Load a WBMP image.
_guessType ( $imageFile ) : string

Method Details

__clone() public method

Method called when 'clone' keyword is used.
public __clone ( )

__construct() public method

Image constructor.
public __construct ( resource $gd, string $imageFile, integer $width, integer $height, string $type, string $blocks = '', boolean $animated = false )
$gd resource Must use GD's imagecreate* family of functions to create a GD resource.
$imageFile string
$width integer
$height integer
$type string
$blocks string
$animated boolean

alphaBlendingMode() public method

Set the blending mode for an image. Allows transparent overlays on top of an image.
public alphaBlendingMode ( boolean $flag ) : self
$flag boolean True to enable blending mode.
return self

blob() public method

Output a binary raw dump of an image in a specified format.
public blob ( string | ImageType $type = 'PNG' )
$type string | Grafika\ImageType Image format of the dump.

createBlank() public static method

Create a blank image.
public static createBlank ( integer $width = 1, integer $height = 1 ) : Image
$width integer Width in pixels.
$height integer Height in pixels.
return Image

createFromCore() public static method

Create an Image from a GD resource. The file type defaults to unknown.
public static createFromCore ( resource $gd ) : Image
$gd resource GD resource.
return Image

createFromFile() public static method

Create Image from image file.
public static createFromFile ( string $imageFile ) : Image
$imageFile string Path to image.
return Image

fullAlphaMode() public method

Enable/Disable transparency
public fullAlphaMode ( boolean $flag ) : self
$flag boolean True to enable alpha mode.
return self

getBlocks() public method

Get blocks.
public getBlocks ( ) : string.
return string.

getCore() public method

Get GD resource ID.
public getCore ( ) : resource
return resource

getHeight() public method

Get image height in pixels.
public getHeight ( ) : integer
return integer

getImageFile() public method

Get image file path.
public getImageFile ( ) : string
return string File path to image.

getType() public method

Get image type.
public getType ( ) : string
return string

getWidth() public method

Get image width in pixels.
public getWidth ( ) : integer
return integer

histogram() public method

Get histogram from an entire image or its sub-region.
public histogram ( array | null $slice = null ) : array
$slice array | null Array of slice information. array( array( 0,0), array(100,50)) means x,y is 0,0 and width,height is 100,50
return array Returns array containing RGBA bins array('r'=>array(), 'g'=>array(), 'b'=>array(), 'a'=>array())

isAnimated() public method

Returns animated flag.
public isAnimated ( ) : boolean
return boolean True if animated GIF.