eZTemplateImageOperator Class Reference
[Template operators]
Text to image conversion using operator "texttoimage".
More...
List of all members.
|
Public Methods |
| | eZTemplateImageOperator ($texttoimageName="texttoimage",$imageName="image",$imagefileName="imagefile") |
| | modify (&$tpl,&$operatorName,&$operatorParameters,&$rootNamespace,&$currentNamespace,&$inputValue,&$namedParameters) |
| & | operatorList () |
| | namedParameterPerOperator () |
| | namedParameterList () |
| | fontDir () |
| | cacheDir () |
| | htmlDir () |
| | family () |
| | pointSize () |
| | angle () |
| | xAdjustment () |
| | yAdjustment () |
| | widthAdjustment () |
| | heightAdjustment () |
| | useCache () |
| | colors () |
| | decodeColor ($col) |
| | color ($colname) |
| | setFontDir ($dir) |
| | setCacheDir ($dir) |
| | setHTMLDir ($dir) |
| | setFamily ($fam) |
| | setPointSize ($size) |
| | setAngle ($ang) |
| | setXAdjustment ($x) |
| | setYAdjustment ($y) |
| | setWidthAdjustment ($w) |
| | setHeightAdjustment ($h) |
| | setUseCache ($use) |
| | setColors ($cols) |
| | setColor ($colname,$colval) |
Private Attributes |
| | Operators |
|
| DefaultClass |
| | The default class to use for text to image conversion.
|
|
| FontDir |
| | the directory were fonts are found, default is ""
|
|
| CacheDir |
| | the directory were cache files are created, default is ""
|
|
| HTMLDir |
| | the directory were html code finds the images, default is ""
|
|
| Family |
| | the default font family, default is "arial"
|
|
| PointSize |
| | the default font point size, default is 12
|
|
| Angle |
| | the default font angle, default is 0
|
|
| XAdjust |
| | the default font x adjustment, default is 0
|
|
| YAdjust |
| | the default font y adjustment, default is 0
|
|
| UseCache |
| | whether to reuse cache files or not
|
|
| Colors |
| | the color array, default is bgcolor=white and textcolor=black
|
|
| ImageGDSupported |
| | Whether image GD is supported.
|
Detailed Description
Text to image conversion using operator "texttoimage".
This operator allows a piece of text be converted to an image file representing the text. The output image is written in PNG format. Use setFontDir() and setCacheDir() to change where the font is located and where the cache file should be put. If fontDir() is an empty string the font will be looked for in the system.
Definition at line eztemplateimageoperator.php.
Constructor & Destructor Documentation
| eZTemplateImageOperator::eZTemplateImageOperator |
( |
$ |
texttoimageName = "texttoimage", |
|
|
$ |
imageName = "image", |
|
|
$ |
imagefileName = "imagefile" |
|
) |
|
|
Member Function Documentation
| eZTemplateImageOperator::angle |
( |
|
) |
|
|
| eZTemplateImageOperator::cacheDir |
( |
|
) |
|
|
| eZTemplateImageOperator::color |
( |
$ |
colname |
) |
|
|
| eZTemplateImageOperator::colors |
( |
|
) |
|
|
| eZTemplateImageOperator::decodeColor |
( |
$ |
col |
) |
|
|
|
|
Takes a mixed mode color representation and decodes it to a an array of three elements which represents the R, G and B color elements. - Parameters:
-
Definition at line eztemplateimageoperator.php.
Referenced by modify(). |
| eZTemplateImageOperator::family |
( |
|
) |
|
|
| eZTemplateImageOperator::fontDir |
( |
|
) |
|
|
| eZTemplateImageOperator::heightAdjustment |
( |
|
) |
|
|
| eZTemplateImageOperator::htmlDir |
( |
|
) |
|
|
| eZTemplateImageOperator::modify |
( |
&$ |
tpl, |
|
|
&$ |
operatorName, |
|
|
&$ |
operatorParameters, |
|
|
&$ |
rootNamespace, |
|
|
&$ |
currentNamespace, |
|
|
&$ |
inputValue, |
|
|
&$ |
namedParameters |
|
) |
|
|
| eZTemplateImageOperator::namedParameterList |
( |
|
) |
|
|
| eZTemplateImageOperator::namedParameterPerOperator |
( |
|
) |
|
|
|
|
- Returns:
-
true to tell the template engine that the parameter list exists per operator type.
Definition at line eztemplateimageoperator.php. |
| & eZTemplateImageOperator::operatorList |
( |
|
) |
|
|
| eZTemplateImageOperator::pointSize |
( |
|
) |
|
|
| eZTemplateImageOperator::setAngle |
( |
$ |
ang |
) |
|
|
| eZTemplateImageOperator::setCacheDir |
( |
$ |
dir |
) |
|
|
| eZTemplateImageOperator::setColor |
( |
$ |
colname, |
|
|
$ |
colval |
|
) |
|
|
|
|
Sets the colorname $colname to color value $colval. The colval is a mixed color mode so different values can be input. - See also:
-
setColors, color
Definition at line eztemplateimageoperator.php.
References Colors. |
| eZTemplateImageOperator::setColors |
( |
$ |
cols |
) |
|
|
| eZTemplateImageOperator::setFamily |
( |
$ |
fam |
) |
|
|
| eZTemplateImageOperator::setFontDir |
( |
$ |
dir |
) |
|
|
| eZTemplateImageOperator::setHeightAdjustment |
( |
$ |
h |
) |
|
|
| eZTemplateImageOperator::setHTMLDir |
( |
$ |
dir |
) |
|
|
| eZTemplateImageOperator::setPointSize |
( |
$ |
size |
) |
|
|
| eZTemplateImageOperator::setUseCache |
( |
$ |
use |
) |
|
|
| eZTemplateImageOperator::setWidthAdjustment |
( |
$ |
w |
) |
|
|
| eZTemplateImageOperator::setXAdjustment |
( |
$ |
x |
) |
|
|
| eZTemplateImageOperator::setYAdjustment |
( |
$ |
y |
) |
|
|
| eZTemplateImageOperator::useCache |
( |
|
) |
|
|
| eZTemplateImageOperator::widthAdjustment |
( |
|
) |
|
|
| eZTemplateImageOperator::xAdjustment |
( |
|
) |
|
|
| eZTemplateImageOperator::yAdjustment |
( |
|
) |
|
|
Member Data Documentation
eZTemplateImageOperator::Operators [private]
|
|
The documentation for this class was generated from the following file:
|