lib/ezimage/classes/ezimageobject.php
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
Properties


$AlternativeText= ''
inheritedInherited from:
\eZImageInterface::$$AlternativeText
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$AlternativeText


$Font= ''
inheritedInherited from:
\eZImageInterface::$$Font
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$Font


$Height= ''
inheritedInherited from:
\eZImageInterface::$$Height
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$Height


$ImageObject= ''
inheritedInherited from:
\eZImageInterface::$$ImageObject
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$ImageObject


$ImageObjectRef= ''
inheritedInherited from:
\eZImageInterface::$$ImageObjectRef
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$ImageObjectRef


$IsProcessed= ''
inheritedInherited from:
\eZImageInterface::$$IsProcessed
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$IsProcessed


$IsTrueColor= ''
inheritedInherited from:
\eZImageInterface::$$IsTrueColor
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$IsTrueColor


$Palette= ''
inheritedInherited from:
\eZImageInterface::$$Palette
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$Palette


$PaletteIndex= ''
inheritedInherited from:
\eZImageInterface::$$PaletteIndex
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$PaletteIndex


$StoredFile= ''
inheritedInherited from:
\eZImageInterface::$$StoredFile
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$StoredFile


$StoredPath= ''
inheritedInherited from:
\eZImageInterface::$$StoredPath
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$StoredPath


$StoredType= ''
inheritedInherited from:
\eZImageInterface::$$StoredType
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$StoredType


$Width= ''
inheritedInherited from:
\eZImageInterface::$$Width
Details
- Type
- n/a
- Inherited_from
- \eZImageInterface::$$Width
Methods


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


appendLayer(
$imageLayer, $parameters
=
array()
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$imageLayer | ||
$parameters |


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


blendImage(
$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 |


calculateAxisPlacement(
$value, $type, $alignment, $axisStart, $axisStop, $currentLength
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$value | ||
$type | ||
$alignment | ||
$axisStart | ||
$axisStop | ||
$currentLength |


calculatePosition(
$parameters, $width, $height
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$parameters | ||
$width | ||
$height |


clear(
$color
=
false
)
:
void
inherited
Inherited from:
\eZImageInterface::clear()
Parameters
Name | Type | Description |
---|---|---|
$color |


cloneImage(
$imageObject, $width, $height, $useTruecolor
=
null
)
:
void
inherited
Inherited from:
\eZImageInterface::cloneImage()
Parameters
Name | Type | Description |
---|---|---|
$imageObject | ||
$width | ||
$height | ||
$useTruecolor |


color(
$name
)
:
void
inherited
Inherited from:
\eZImageInterface::color()
Parameters
Name | Type | Description |
---|---|---|
$name |


copyImage(
$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 |


create(
$width, $height, $useTruecolor
=
null
)
:
void
inherited
Inherited from:
\eZImageInterface::create()
Parameters
Name | Type | Description |
---|---|---|
$width | ||
$height | ||
$useTruecolor |


createImage(
$width, $height, $useTruecolor
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$width | ||
$height | ||
$useTruecolor |


drawText(
$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 |


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


eZImageObject(
$imageObjectRef
=
null, $imageObject
=
null, $width
=
false, $height
=
false
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$imageObjectRef | ||
$imageObject | ||
$width | ||
$height |


hasAttribute(
$name
)
:
void
inherited
Inherited from:
\eZImageInterface::hasAttribute()
Parameters
Name | Type | Description |
---|---|---|
$name |


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


imageObjectInternal(
$createMissing
=
true
)
:
void
inherited
Inherited from:
\eZImageInterface::imageObjectInternal()
Parameters
Name | Type | Description |
---|---|---|
$createMissing |


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


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


loadPNG(
$storedPath, $storedFile
)
:
void
inherited
Inherited from:
\eZImageInterface::loadPNG()
Parameters
Name | Type | Description |
---|---|---|
$storedPath | ||
$storedFile |


merge(
$imageObject, $x, $y, $width, $height
)
:
void
inherited
Inherited from:
\eZImageInterface::merge()
Parameters
Name | Type | Description |
---|---|---|
$imageObject | ||
$x | ||
$y | ||
$width | ||
$height |


mergeImage(
$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 |


prependLayer(
$imageLayer, $parameters
=
array()
)
:
void
Parameters
Name | Type | Description |
---|---|---|
$imageLayer | ||
$parameters |


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


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


setHeight(
$h
)
:
void
inherited
Inherited from:
\eZImageInterface::setHeight()
Parameters
Name | Type | Description |
---|---|---|
$h |


setStoredFile(
$file, $path, $type
)
:
void
inherited
Inherited from:
\eZImageInterface::setStoredFile()
Parameters
Name | Type | Description |
---|---|---|
$file | ||
$path | ||
$type |


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


setWidth(
$w
)
:
void
inherited
Inherited from:
\eZImageInterface::setWidth()
Parameters
Name | Type | Description |
---|---|---|
$w |


store(
$fileName, $filePath, $type
)
:
void
inherited
Inherited from:
\eZImageInterface::store()
Parameters
Name | Type | Description |
---|---|---|
$fileName | ||
$filePath | ||
$type |