eZPublish  3.8
eZImageTextLayer Class Reference

Layer for text information and rendering. More...

+ Inheritance diagram for eZImageTextLayer:
+ Collaboration diagram for eZImageTextLayer:

Public Member Functions

createForText ($text, &$font, $widthAdjustment, $heightAdjustment, $angle, $absoluteWidth=false, $absoluteHeight=false)
 
 eZImageTextLayer ($imageObjectRef=null, $imageObject=null, $width=false, $height=false, $font=false, $boundingBox=null, $text=null, $textAngle=0)
 
 mergeLayer (&$image, &$layerData, &$lastLayerData)
 
 processImage ()
 
 setText ($text)
 
 setTextAngle ($textAngle)
 
 text ()
 
 textAngle ()
 
 textBoundingBox ()
 
- Public Member Functions inherited from eZImageLayer
createForFile ($fileName, $filePath, $fileType=false)
 
 eZImageLayer ($imageObjectRef=null, $imageObject=null, $width=false, $height=false, $font=false)
 
 mergeLayer (&$image, &$layerData, &$lastLayerData)
 
 setTemplateURI ($uri)
 
 templateData ()
 
- Public Member Functions inherited from eZImageInterface
 allocateColor ($name, $red, $green, $blue)
 
 alternativeText ()
 
attribute ($name)
 
 attributes ()
 
 blendImage ($destinationImageObject, $imageObject, $destinationX, $destinationY, $sourceWidth, $sourceHeight, $sourceX=0, $sourceY=0)
 
 cleanupRegisteredImages ()
 
 clear ($color=false)
 
 clone (&$image)
 
 cloneImage ($imageObject, $width, $height, $useTruecolor=null)
 
 color ($name)
 
 copyImage ($destinationImageObject, $imageObject, $destinationX, $destinationY, $sourceWidth, $sourceHeight, $sourceX=0, $sourceY=0)
 
 create ($width, $height, $useTruecolor=null)
 
 destroy ()
 
 drawText (&$font, $textColor, $text, $x, $y, $angle, $imageObject=null)
 
 eZImageInterface ($imageObjectRef=null, $imageObject=null, $width=false, $height=false)
 
 font ()
 
 hasAttribute ($name)
 
hasSize ()
 
 height ()
 
 imageObject ($createMissing=true)
 
imagePath ()
 
 isProcessed ()
 
 isTruecolor ()
 
 load ()
 
 loadGIF ($storedPath, $storedFile)
 
 loadJPEG ($storedPath, $storedFile)
 
 loadPNG ($storedPath, $storedFile)
 
 merge ($imageObject, $x, $y, $width, $height)
 
 mergeImage ($destinationImageObject, $imageObject, $destinationX, $destinationY, $sourceWidth, $sourceHeight, $sourceX=0, $sourceY=0, $transparency=0)
 
 process ()
 
 processImage ()
 
 setAlternativeText ($text)
 
 setFont ($font)
 
 setHeight ($h)
 
 setStoredFile ($file, $path, $type)
 
 setTextColor ($textColor)
 
 setWidth ($w)
 
 store ($fileName, $filePath, $type)
 
 textColor ()
 
 unregisterImage ($imageRef)
 
 width ()
 

Private Attributes

 $Angle
 
 $Text
 
 $TextBoundingBox
 

Additional Inherited Members

- Static Public Member Functions inherited from eZImageInterface
 hasGD2 ()
 
- Protected Member Functions inherited from eZImageInterface
 imageObjectInternal ($createMissing=true)
 
 registerImage ($image)
 

Detailed Description

Layer for text information and rendering.

Member Function Documentation

& eZImageTextLayer::createForText (   $text,
$font,
  $widthAdjustment,
  $heightAdjustment,
  $angle,
  $absoluteWidth = false,
  $absoluteHeight = false 
)

Creates a new text layer with the text $text, font $font and adjustment $widthAdjustment and $heightAdjustment at the angle $angle and returns it.

Referenced by eZTemplateImageOperator\modify().

eZImageTextLayer::eZImageTextLayer (   $imageObjectRef = null,
  $imageObject = null,
  $width = false,
  $height = false,
  $font = false,
  $boundingBox = null,
  $text = null,
  $textAngle = 0 
)

Constructor

Referenced by createForText().

eZImageTextLayer::mergeLayer ( $image,
$layerData,
$lastLayerData 
)

Renders the text with the other layer data. It will perform something that will look like alphablending of the text.

It will copy the area which it will render on from the other layer and render on it and then merge the result back on the other layer using the transparency value. This means that the original image data is kept and the actual text will be transparent.

eZImageTextLayer::processImage ( )

Draws the text on the current image object.

eZImageTextLayer::setText (   $text)

Sets the current text to $text.

eZImageTextLayer::setTextAngle (   $textAngle)

Sets the angle of the text to $textAngle.

eZImageTextLayer::text ( )
Returns
the current text.

Referenced by mergeLayer(), and processImage().

eZImageTextLayer::textAngle ( )
Returns
the current text angle.

Referenced by mergeLayer(), and processImage().

eZImageTextLayer::textBoundingBox ( )
Returns
the current bounding box for the text. See the PHP function ImageTTFBBox for more info.

Referenced by mergeLayer(), and processImage().

Member Data Documentation

eZImageTextLayer::$Angle
private
eZImageTextLayer::$Text
private

Referenced by text().

eZImageTextLayer::$TextBoundingBox
private

Referenced by textBoundingBox().


The documentation for this class was generated from the following file: