
	Manual


	SDK

API Reference

eZImageInterface Class Reference

Base interface for all image object and layer classes. More...

Inheritance diagram for eZImageInterface:

List of all members.


Public Methods
	isTruecolor ()
	attributes ()
	hasAttribute ($name)
&	attribute ($name)
	isProcessed ()
	hasSize ()
&	imagePath ()
	setAlternativeText ($text)
&	alternativeText ()
	unregisterImage ($imageRef)
	cleanupRegisteredImages ()
	loadPNG ($storedPath,$storedFile)
	loadJPEG ($storedPath,$storedFile)
	load ()
	destroy ()
	imageObject ($createMissing=true)
	process ()
	processImage ()
	store ($fileName,$filePath,$type)
	create ($width,$height,$useTruecolor=null)
	clone (&$image)
	cloneImage ($imageObject,$width,$height,$useTruecolor=null)
	width ()
	height ()
	setWidth ($w)
	setHeight ($h)
	setStoredFile ($file,$path,$type)
	setFont ($font)
	font ()
	copyImage ($destinationImageObject,$imageObject,$destinationX,$destinationY,$sourceWidth,$sourceHeight,$sourceX=0,$sourceY=0)
	mergeImage ($destinationImageObject,$imageObject,$destinationX,$destinationY,$sourceWidth,$sourceHeight,$sourceX=0,$sourceY=0,$transparency=0)
	blendImage ($destinationImageObject,$imageObject,$destinationX,$destinationY,$sourceWidth,$sourceHeight,$sourceX=0,$sourceY=0)
	clear ($color=false)
	allocateColor ($name,$red,$green,$blue)
	color ($name)
	textColor ()
	setTextColor ($textColor)
	drawText (&$font,$textColor,$text,$x,$y,$angle,$imageObject=null)
Static Public Methods
	hasGD2 ()
Public Attributes
	Width
	\privatesection
Protected Methods
	registerImage ($image)
	imageObjectInternal ($createMissing=true)
Private Methods
	attributeMemberMap ()
	attributeFunctionMap ()
Static Private Methods
	createImage ($width,$height,&$useTruecolor)

Detailed Description

Base interface for all image object and layer classes.

Definition at line ezimageinterface.php.

Member Function Documentation

eZImageInterface::allocateColor	(	$	name,
		$	red,
		$	green,
		$	blue
	)

Allocates the color $red, $green and $blue with name $name and returns it. Will return the palette index for palette based images and the color value for true color.

Definition at line ezimageinterface.php.

References eZDebug::writeError().

Referenced by allocateColor().

& eZImageInterface::alternativeText

(

)

Returns:: the alternative text for the image.

See also:: setAlternativeText

Definition at line ezimageinterface.php.

& eZImageInterface::attribute

(

name

)

Returns:: the attribute with name $name or null if the attribute does not exist.

Definition at line ezimageinterface.php.

References eZDebug::writeWarning().

Referenced by attribute().

eZImageInterface::attributeFunctionMap ( ) [private]

Returns:: a map array which maps from an attribute name to a member function. Used by attributes, hasAttribute and attribute.

Definition at line ezimageinterface.php.

References imagePath().

Referenced by hasAttribute().

eZImageInterface::attributeMemberMap ( ) [private]

Returns:: a map array which maps from an attribute name to a member variable. Used by attributes, hasAttribute and attribute.

Definition at line ezimageinterface.php.

References width().

Referenced by hasAttribute().

eZImageInterface::attributes

(

)

Returns:: an array with attribute names which this object supports.

Definition at line ezimageinterface.php.

References attributeMemberMap().

eZImageInterface::blendImage	(	$	destinationImageObject,
		$	imageObject,
		$	destinationX,
		$	destinationY,
		$	sourceWidth,
		$	sourceHeight,
		$	sourceX = 0,
		$	sourceY = 0
	)

Alpha blends the image $imageObject with size $sourceWidth and $sourceHeight and position $sourceX and $sourceY onto the destination image $destinationImageObject at position $destinationX and $destinationY.

Note:: This required GD2 and uses color 0 (black) for blending.

Definition at line ezimageinterface.php.

References imageObject().

eZImageInterface::cleanupRegisteredImages

(

)

Cleans up all registered images.

Definition at line ezimageinterface.php.

eZImageInterface::clear

(

color = false

)

Clears the image object with color $color. If $color is not specified it will use the first color set.

Definition at line ezimageinterface.php.

References color().

Referenced by eZImageTextLayer::processImage().

eZImageInterface::clone

(

image

)

Copies the image from $image as the current image object.

Definition at line ezimageinterface.php.

References cloneImage().

eZImageInterface::cloneImage	(	$	imageObject,
		$	width,
		$	height,
		$	useTruecolor = null
	)

Clones the image object $imageObject with width $width, height $height and truecolor settings $useTruecolor.

Definition at line ezimageinterface.php.

References width().

Referenced by clone().

eZImageInterface::color

(

name

)

Returns:: the color for the name $name.

Definition at line ezimageinterface.php.

References eZDebug::writeError().

Referenced by drawText().

eZImageInterface::copyImage	(	$	destinationImageObject,
		$	imageObject,
		$	destinationX,
		$	destinationY,
		$	sourceWidth,
		$	sourceHeight,
		$	sourceX = 0,
		$	sourceY = 0
	)

Copies the image $imageObject with size $sourceWidth and $sourceHeight and position $sourceX and $sourceY onto the destination image $destinationImageObject at position $destinationX and $destinationY.

Definition at line ezimageinterface.php.

References imageObject().

eZImageInterface::create	(	$	width,
		$	height,
		$	useTruecolor = null
	)

Creates a new image object with width $width and height $height. $useTruecolor determines the type of image, if true it will be truecolor, if false it will be palette based or if null it will create it depending on the GD version. GD 2 will get truecolor while < 2 will get palette based.

Definition at line ezimageinterface.php.

References width().

Referenced by imageObjectInternal().

eZImageInterface::createImage	(	$	width,
		$	height,
		&$	useTruecolor
	)	`[static, private]`

Creates an image with size $width and $height using GD and returns it.

Definition at line ezimageinterface.php.

References eZDebug::writeWarning().

Referenced by createImage().

eZImageInterface::destroy

(

)

Cleans up the current image object if it is set.

Definition at line ezimageinterface.php.

References unregisterImage().

Referenced by create().

eZImageInterface::drawText	(	&$	font,
		$	textColor,
		$	text,
		$	x,
		$	y,
		$	angle,
		$	imageObject = null
	)

Draws the text $text using the font $font and color $textColor at position $x and $y with angle $angle. If $imageObject is specified it will use that for drawing instead of the current image.

Definition at line ezimageinterface.php.

References eZDebug::writeWarning().

Referenced by eZImageTextLayer::processImage().

eZImageInterface::font

(

)

Returns:: the current font object or null if not font object has been set.

Definition at line ezimageinterface.php.

Referenced by setFont().

eZImageInterface::hasAttribute

(

name

)

Returns:: true if the attribute $name exists.

Definition at line ezimageinterface.php.

References attributeMemberMap().

eZImageInterface::hasGD2 ( ) [static]

Returns:: true if GD2 is installed.

Definition at line ezimageinterface.php.

References eZINI::instance().

Referenced by createImage().

eZImageInterface::hasSize

(

)

Returns:: true if the width and height of the image has been set.

Definition at line ezimageinterface.php.

References Width.

Referenced by attributeFunctionMap().

eZImageInterface::height

(

)

Returns:: the current height of the image or false if no size has been set.

Definition at line ezimageinterface.php.

Referenced by processImage().

eZImageInterface::imageObject

(

createMissing = true

)

Returns:: the current image object, if $createMissing is true if will run the image processing to make sure it is created. Returns null if no image is available.

See also:: imageObjectInternal

Definition at line ezimageinterface.php.

References process().

Referenced by store().

eZImageInterface::imageObjectInternal ( $ createMissing = true ) [protected]

Returns:: the current image object, will create an empty image object if $createMissing is true and the image object is not already created.

See also:: imageObject

Definition at line ezimageinterface.php.

References create().

Referenced by eZImageTextLayer::processImage().

& eZImageInterface::imagePath

(

)

Returns:: the path to the image file including the file.

Definition at line ezimageinterface.php.

Referenced by attributeFunctionMap().

eZImageInterface::isProcessed

(

)

Returns:: true if the image object has been processed, this means that image has been rendered.

Definition at line ezimageinterface.php.

eZImageInterface::isTruecolor

(

)

Returns:: true if the image is true color. True color images behave differently from palette based and GD has problems with mixing the two types.

Definition at line ezimageinterface.php.

eZImageInterface::load

(

)

Tries to load the stored image set by setStoredFile(). If the stored type is not set it will try all formats until one succeeds.

Returns:: true if succesful.

Definition at line ezimageinterface.php.

References eZDebug::writeError().

Referenced by processImage().

eZImageInterface::loadJPEG	(	$	storedPath,
		$	storedFile
	)

Tries to load the JPEG image from the path $storedPath and file $storedFile into the current image object.

Returns:: true if succesful.

Definition at line ezimageinterface.php.

References registerImage().

Referenced by load().

eZImageInterface::loadPNG	(	$	storedPath,
		$	storedFile
	)

Tries to load the PNG image from the path $storedPath and file $storedFile into the current image object.

Returns:: true if succesful.

Definition at line ezimageinterface.php.

References registerImage().

Referenced by load().

eZImageInterface::mergeImage	(	$	destinationImageObject,
		$	imageObject,
		$	destinationX,
		$	destinationY,
		$	sourceWidth,
		$	sourceHeight,
		$	sourceX = 0,
		$	sourceY = 0,
		$	transparency = 0
	)

Merges the image $imageObject with size $sourceWidth and $sourceHeight and position $sourceX and $sourceY with the destination image $destinationImageObject at position $destinationX and $destinationY. The merged image is placed on the $destinationImageObject.

Parameters:

transparency

determines how transparent the source image is. 0 is the same as copyImage and 100 is the same is no copy is made.

Definition at line ezimageinterface.php.

References imageObject().

eZImageInterface::process

(

)

Makes sure the image object is processed and rendered. Calls processImage() which is implemented by all descendants of this class to do the real work.

Definition at line ezimageinterface.php.

References processImage().

Referenced by store().

eZImageInterface::processImage

(

)

\virtual Tries to render an image onto the image object, each inheriting class must override this to do somethign sensible. By default it will try to load the stored image if one is set.

Returns:: true if the image was succesfully processed.

Reimplemented in eZImageTextLayer.

Definition at line ezimageinterface.php.

References eZDebug::writeWarning().

Referenced by process().

eZImageInterface::registerImage ( $ image ) [protected]

Registers the GD image object $image for destruction upon script end. This makes sure that image resources are cleaned up after use.

Returns:: a reference for the image which can be used in unregisterImage later on.

Definition at line ezimageinterface.php.

Referenced by loadPNG().

eZImageInterface::setAlternativeText

(

text

)

Sets the alternative text to $text, it will be used for describing the image and can be used by browsers that cannot view images.

Definition at line ezimageinterface.php.

eZImageInterface::setFont

(

font

)

Sets the current font object to $font.

Definition at line ezimageinterface.php.

References font().

Referenced by eZImageLayer::eZImageLayer().

eZImageInterface::setHeight

(

)

Sets the height of the image to $h.

Definition at line ezimageinterface.php.

Referenced by eZImageObject::flatten().

eZImageInterface::setStoredFile	(	$	file,
		$	path,
		$	type
	)

Sets the path, file and type of the stored file. These settings will be used by load().

Definition at line ezimageinterface.php.

eZImageInterface::setTextColor

(

textColor

)

Sets the color used for text drawing to $textColor.

Definition at line ezimageinterface.php.

References textColor().

eZImageInterface::setWidth

(

)

Sets the width of the image to $w.

Definition at line ezimageinterface.php.

References Width.

Referenced by eZImageObject::flatten().

eZImageInterface::store	(	$	fileName,
		$	filePath,
		$	type
	)

Stores the current image object to disk, the image is stored in the path $filePath with filename $fileName. The parameter $type determines the image format, supported are png and jpg.