lib/ezimage/classes/ezimageobject.php

Show: inherited
Table of Contents

File containing the eZImageObject class.

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
lib  
Version
4.6.0  

\eZImageObject

Package: lib

File containing the eZImageObject class.

Parent(s)
\eZImageInterface
Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Version
4.6.0  

Constants

Constant  ALIGN_AXIS_NONE = 0x00
Constant  ALIGN_AXIS_START = 0x01
Constant  ALIGN_AXIS_STOP = 0x02
Constant  ALIGN_AXIS_CENTER = 0x03
Constant  ALIGN_AXIS_MASK = 0x03
Constant  PLACE_CONSTANT = 1
Constant  PLACE_RELATIVE = 2

Properties

Propertypublic  $AlternativeText= ''
inheritedInherited from: \eZImageInterface::$$AlternativeText
Details
Type
n/a
Inherited_from
\eZImageInterface::$$AlternativeText  
Propertypublic  $Font= ''
inheritedInherited from: \eZImageInterface::$$Font
Details
Type
n/a
Inherited_from
\eZImageInterface::$$Font  
Propertypublic  $Height= ''
inheritedInherited from: \eZImageInterface::$$Height
Details
Type
n/a
Inherited_from
\eZImageInterface::$$Height  
Propertypublic  $ImageLayerIndex= ''
Details
Type
n/a
Propertypublic  $ImageLayers= ''
Details
Type
n/a
Propertypublic  $ImageObject= ''
inheritedInherited from: \eZImageInterface::$$ImageObject
Details
Type
n/a
Inherited_from
\eZImageInterface::$$ImageObject  
Propertypublic  $ImageObjectRef= ''
inheritedInherited from: \eZImageInterface::$$ImageObjectRef
Details
Type
n/a
Inherited_from
\eZImageInterface::$$ImageObjectRef  
Propertypublic  $IsProcessed= ''
inheritedInherited from: \eZImageInterface::$$IsProcessed
Details
Type
n/a
Inherited_from
\eZImageInterface::$$IsProcessed  
Propertypublic  $IsTrueColor= ''
inheritedInherited from: \eZImageInterface::$$IsTrueColor
Details
Type
n/a
Inherited_from
\eZImageInterface::$$IsTrueColor  
Propertypublic  $Palette= ''
inheritedInherited from: \eZImageInterface::$$Palette
Details
Type
n/a
Inherited_from
\eZImageInterface::$$Palette  
Propertypublic  $PaletteIndex= ''
inheritedInherited from: \eZImageInterface::$$PaletteIndex
Details
Type
n/a
Inherited_from
\eZImageInterface::$$PaletteIndex  
Propertypublic  $StoredFile= ''
inheritedInherited from: \eZImageInterface::$$StoredFile
Details
Type
n/a
Inherited_from
\eZImageInterface::$$StoredFile  
Propertypublic  $StoredPath= ''
inheritedInherited from: \eZImageInterface::$$StoredPath
Details
Type
n/a
Inherited_from
\eZImageInterface::$$StoredPath  
Propertypublic  $StoredType= ''
inheritedInherited from: \eZImageInterface::$$StoredType
Details
Type
n/a
Inherited_from
\eZImageInterface::$$StoredType  
Propertypublic  $TemplateURI= ''
Details
Type
n/a
Propertypublic  $Width= ''
inheritedInherited from: \eZImageInterface::$$Width
Details
Type
n/a
Inherited_from
\eZImageInterface::$$Width  

Methods

methodpublic__clone( ) : void
inherited

Inherited from: \eZImageInterface::__clone()
methodpublicallocateColor(  $name,  $red,  $green,  $blue ) : void
inherited

Inherited from: \eZImageInterface::allocateColor()
Parameters
Name Type Description
$name
$red
$green
$blue
methodpublicalternativeText( ) : void
inherited

Inherited from: \eZImageInterface::alternativeText()
methodpublicappendLayer(  $imageLayer,  $parameters = array() ) : void

Parameters
Name Type Description
$imageLayer
$parameters
methodpublicattribute(  $name ) : void
inherited

Inherited from: \eZImageInterface::attribute()
Parameters
Name Type Description
$name
methodpublicattributeFunctionMap( ) : void
inherited

Inherited from: \eZImageInterface::attributeFunctionMap()
methodpublicattributeMemberMap( ) : void
inherited

Inherited from: \eZImageInterface::attributeMemberMap()
methodpublicattributes( ) : void
inherited

Inherited from: \eZImageInterface::attributes()
methodpublicblendImage(  $destinationImageObject,  $imageObject,  $destinationX,  $destinationY,  $sourceWidth,  $sourceHeight,  $sourceX = 0,  $sourceY = 0 ) : void
inherited

Inherited from: \eZImageInterface::blendImage()
Parameters
Name Type Description
$destinationImageObject
$imageObject
$destinationX
$destinationY
$sourceWidth
$sourceHeight
$sourceX
$sourceY
methodpubliccalculateAxisPlacement(  $value,  $type,  $alignment,  $axisStart,  $axisStop,  $currentLength ) : void

Parameters
Name Type Description
$value
$type
$alignment
$axisStart
$axisStop
$currentLength
methodpubliccalculatePosition(  $parameters,  $width,  $height ) : void

Parameters
Name Type Description
$parameters
$width
$height
methodpubliccleanupRegisteredImages( ) : void
staticinherited

Inherited from: \eZImageInterface::cleanupRegisteredImages()
methodpublicclear(  $color = false ) : void
inherited

Inherited from: \eZImageInterface::clear()
Parameters
Name Type Description
$color
methodpubliccloneImage(  $imageObject,  $width,  $height,  $useTruecolor = null ) : void
inherited

Inherited from: \eZImageInterface::cloneImage()
Parameters
Name Type Description
$imageObject
$width
$height
$useTruecolor
methodpubliccolor(  $name ) : void
inherited

Inherited from: \eZImageInterface::color()
Parameters
Name Type Description
$name
methodpubliccopyImage(  $destinationImageObject,  $imageObject,  $destinationX,  $destinationY,  $sourceWidth,  $sourceHeight,  $sourceX = 0,  $sourceY = 0 ) : void
inherited

Inherited from: \eZImageInterface::copyImage()
Parameters
Name Type Description
$destinationImageObject
$imageObject
$destinationX
$destinationY
$sourceWidth
$sourceHeight
$sourceX
$sourceY
methodpubliccreate(  $width,  $height,  $useTruecolor = null ) : void
inherited

Inherited from: \eZImageInterface::create()
Parameters
Name Type Description
$width
$height
$useTruecolor
methodpubliccreateImage(  $width,  $height,  $useTruecolor ) : void
staticinherited

Inherited from: \eZImageInterface::createImage()
Parameters
Name Type Description
$width
$height
$useTruecolor
methodpublicdestroy( ) : void

methodpublicdrawText(  $font,  $textColor,  $text,  $x,  $y,  $angle,  $imageObject = null ) : void
inherited

Inherited from: \eZImageInterface::drawText()
Parameters
Name Type Description
$font
$textColor
$text
$x
$y
$angle
$imageObject
methodpubliceZImageInterface(  $imageObjectRef = null,  $imageObject = null,  $width = false,  $height = false ) : void
inherited

Inherited from: \eZImageInterface::eZImageInterface()
Parameters
Name Type Description
$imageObjectRef
$imageObject
$width
$height
methodpubliceZImageObject(  $imageObjectRef = null,  $imageObject = null,  $width = false,  $height = false ) : void

Parameters
Name Type Description
$imageObjectRef
$imageObject
$width
$height
methodpublicflatten( ) : void

methodpublicfont( ) : void
inherited

Inherited from: \eZImageInterface::font()
methodpublicgetTransparency(  $parameters ) : void

Parameters
Name Type Description
$parameters
methodpublicgetTransparencyPercent(  $parameters ) : void

Parameters
Name Type Description
$parameters
methodpublichasAttribute(  $name ) : void
inherited

Inherited from: \eZImageInterface::hasAttribute()
Parameters
Name Type Description
$name
methodpublichasGD2( ) : void
staticinherited

Inherited from: \eZImageInterface::hasGD2()
methodpublichasLayer(  $layerID ) : void

Parameters
Name Type Description
$layerID
methodpublichasSize( ) : void
inherited

Inherited from: \eZImageInterface::hasSize()
methodpublicheight( ) : void
inherited

Inherited from: \eZImageInterface::height()
methodpublicimageObject(  $createMissing = true ) : void
inherited

Inherited from: \eZImageInterface::imageObject()
Parameters
Name Type Description
$createMissing
methodpublicimageObjectInternal(  $createMissing = true ) : void
inherited

Inherited from: \eZImageInterface::imageObjectInternal()
Parameters
Name Type Description
$createMissing
methodpublicimagePath( ) : void
inherited

Inherited from: \eZImageInterface::imagePath()
methodpublicinitializeAxis(  $parameters,  $name ) : void

Parameters
Name Type Description
$parameters
$name
methodpublicisProcessed( ) : void
inherited

Inherited from: \eZImageInterface::isProcessed()
methodpublicisTruecolor( ) : void
inherited

Inherited from: \eZImageInterface::isTruecolor()
methodpublicload( ) : void
inherited

Inherited from: \eZImageInterface::load()
methodpublicloadGIF(  $storedPath,  $storedFile ) : void
inherited

Inherited from: \eZImageInterface::loadGIF()
Parameters
Name Type Description
$storedPath
$storedFile
methodpublicloadJPEG(  $storedPath,  $storedFile ) : void
inherited

Inherited from: \eZImageInterface::loadJPEG()
Parameters
Name Type Description
$storedPath
$storedFile
methodpublicloadPNG(  $storedPath,  $storedFile ) : void
inherited

Inherited from: \eZImageInterface::loadPNG()
Parameters
Name Type Description
$storedPath
$storedFile
methodpublicmerge(  $imageObject,  $x,  $y,  $width,  $height ) : void
inherited

Inherited from: \eZImageInterface::merge()
Parameters
Name Type Description
$imageObject
$x
$y
$width
$height
methodpublicmergeImage(  $destinationImageObject,  $imageObject,  $destinationX,  $destinationY,  $sourceWidth,  $sourceHeight,  $sourceX = 0,  $sourceY = 0,  $transparency = 0 ) : void
inherited

Inherited from: \eZImageInterface::mergeImage()
Parameters
Name Type Description
$destinationImageObject
$imageObject
$destinationX
$destinationY
$sourceWidth
$sourceHeight
$sourceX
$sourceY
$transparency
methodpublicprependLayer(  $imageLayer,  $parameters = array() ) : void

Parameters
Name Type Description
$imageLayer
$parameters
methodpublicprocess( ) : void
inherited

Inherited from: \eZImageInterface::process()
methodpublicprocessImage( ) : void

methodpublicregisterImage(  $image ) : void
staticinherited

Inherited from: \eZImageInterface::registerImage()
Parameters
Name Type Description
$image
methodpublicremoveLayer(  $layerID ) : void

Parameters
Name Type Description
$layerID
methodpublicsetAlternativeText(  $text ) : void
inherited

Inherited from: \eZImageInterface::setAlternativeText()
Parameters
Name Type Description
$text
methodpublicsetFont(  $font ) : void
inherited

Inherited from: \eZImageInterface::setFont()
Parameters
Name Type Description
$font
methodpublicsetHeight(  $h ) : void
inherited

Inherited from: \eZImageInterface::setHeight()
Parameters
Name Type Description
$h
methodpublicsetStoredFile(  $file,  $path,  $type ) : void
inherited

Inherited from: \eZImageInterface::setStoredFile()
Parameters
Name Type Description
$file
$path
$type
methodpublicsetTemplateURI(  $uri ) : void

Parameters
Name Type Description
$uri
methodpublicsetTextColor(  $textColor ) : void
inherited

Inherited from: \eZImageInterface::setTextColor()
Parameters
Name Type Description
$textColor
methodpublicsetWidth(  $w ) : void
inherited

Inherited from: \eZImageInterface::setWidth()
Parameters
Name Type Description
$w
methodpublicstore(  $fileName,  $filePath,  $type ) : void
inherited

Inherited from: \eZImageInterface::store()
Parameters
Name Type Description
$fileName
$filePath
$type
methodpublictemplateData( ) : void

methodpublictextColor( ) : void
inherited

Inherited from: \eZImageInterface::textColor()
methodpublicunregisterImage(  $imageRef ) : void
staticinherited

Inherited from: \eZImageInterface::unregisterImage()
Parameters
Name Type Description
$imageRef
methodpublicwidth( ) : void
inherited

Inherited from: \eZImageInterface::width()
Documentation was generated by DocBlox 0.18.1.