eZImageObject Class Reference
[Image object and layer handling]

Image object which handles image layers. More...

Inheritance diagram for eZImageObject:

eZImageInterface List of all members.

Public Methods

 templateData ()
 setTemplateURI ($uri)
 calculateAxisPlacement ($value,$type,$alignment,$axisStart,$axisStop,$currentLength)
 initializeAxis ($parameters,$name)
 calculatePosition ($parameters,$width,$height)
 getTransparency ($parameters)
 getTransparencyPercent ($parameters)
 appendLayer (&$imageLayer,$parameters=array())
 prependLayer (&$imageLayer,$parameters=array())
 hasLayer ($layerID)
 removeLayer ($layerID)
 processImage ()
 flatten ()

Public Attributes

 ImageLayers
 \privatesection


Detailed Description

Image object which handles image layers.

Definition at line ezimageobject.php.


Member Function Documentation

eZImageObject::appendLayer &$    imageLayer,
  parameters = array()
 

Adds the image layer object $imageLayer to the end of the layer list with optional parameters $parameters

Returns:
the ID of the layer, the ID is unique per image object.
See also:
prependLayer

Definition at line ezimageobject.php.

References eZDebug::writeWarning().

Referenced by appendLayer().

eZImageObject::calculateAxisPlacement   value,
  type,
  alignment,
  axisStart,
  axisStop,
  currentLength
 

Figures out the absolute axis placement and returns it. The variable $type determines how $value is used, it can either be a constant value (EZ_IMAGE_PLACE_CONSTANT) or a relative value (EZ_IMAGE_PLACE_RELATIVE) where input value is placed relative to the length of the axis ($axisStop - $axisStart). $alignment determines where the axis should start, EZ_IMAGE_ALIGN_AXIS_NONE and EZ_IMAGE_ALIGN_AXIS_START will return the position from $axisStart towards $axisStop, EZ_IMAGE_ALIGN_AXIS_STOP returns the position from the $axisStop towards $axisStart while EZ_IMAGE_ALIGN_AXIS_CENTER returns the middle of $axisStart and $axisStop.

Definition at line ezimageobject.php.

Referenced by calculatePosition().

eZImageObject::calculatePosition   parameters,
  width,
  height
 

Calculates the position for x and y parameters in $parameters and returns an absolute position in an array. The returned array will contain the x and y key.

Definition at line ezimageobject.php.

References eZImageInterface::width().

eZImageObject::flatten  
 

Goes trough all layers and merges them together into a single image. This image can then be displayed on the webpage.

Definition at line ezimageobject.php.

References eZDebug::writeWarning().

Referenced by processImage().

eZImageObject::getTransparency   parameters
 

Returns:
the transparency value found in the parameters or 0 if no value is found.

Definition at line ezimageobject.php.

Referenced by getTransparencyPercent().

eZImageObject::getTransparencyPercent   parameters
 

Returns:
the transparency percentage found in the parameters or 0 if no percentage is found.

Definition at line ezimageobject.php.

References getTransparency().

eZImageObject::hasLayer   layerID
 

Returns:
true if the layer with ID $layerID exists in this image object.

Definition at line ezimageobject.php.

eZImageObject::initializeAxis   parameters,
  name
 

Initializes the axis from the parameter value $name filling in any missing values with defaults.

Definition at line ezimageobject.php.

Referenced by calculatePosition().

eZImageObject::prependLayer &$    imageLayer,
  parameters = array()
 

Adds the image layer object $imageLayer to the beginning of the layer list with optional parameters $parameters

Returns:
the ID of the layer, the ID is unique per image object.
See also:
appendLayer

Definition at line ezimageobject.php.

References eZDebug::writeWarning().

Referenced by prependLayer().

eZImageObject::processImage  
 

\virtual Flattens the image so that it can be displayed.

Reimplemented from eZImageInterface.

Definition at line ezimageobject.php.

References flatten().

eZImageObject::removeLayer   layerID
 

Removes the layer with ID $layerID.

Returns:
true if succesful
See also:
hasLayer, appendLayer

Definition at line ezimageobject.php.

References ImageLayers.

eZImageObject::setTemplateURI   uri
 

Sets the URI of the template to use for displaying it using the template engine to $uri.

Definition at line ezimageobject.php.

eZImageObject::templateData  
 

A definition which tells the template engine which template to use for displaying the image.

Definition at line ezimageobject.php.


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

Exponential