ps_get_parameter
(PECL ps >= 1.1.0)
ps_get_parameter — Gets certain parameters
Description
$psdoc, string $name, float $modifier = ?): string|falseGets several parameters which were directly set by ps_set_parameter() or indirectly by one of the other functions. Parameters are by definition string values. This function cannot be used to retrieve resources which were also set by ps_set_parameter().
The parameter name can have the following values.
-
fontname -
The name of the currently active font or the font whose identifier is passed in parameter
modifier. -
fontencoding -
The encoding of the currently active font.
-
dottedversion -
The version of the underlying pslib library in the format <major>.<minor>.<subminor>
-
scope -
The current drawing scope. Can be object, document, null, page, pattern, path, template, prolog, font, glyph.
-
ligaturedisolvechar -
The character which dissolves a ligature. If your are using a font which contains the ligature `ff' and `|' is the char to dissolve the ligature, then `f|f' will result in two `f' instead of the ligature `ff'.
-
imageencoding -
The encoding used for encoding images. Can be either
hexor85. hex encoding uses two bytes in the postscript file each byte in the image. 85 stand for Ascii85 encoding. -
linenumbermode -
Set to
paragraphif lines are numbered within a paragraph orboxif they are numbered within the surrounding box. -
linebreak -
Only used if text is output with ps_show_boxed(). If set to
truea carriage return will add a line break. -
parbreak -
Only used if text is output with ps_show_boxed(). If set to
truea carriage return will start a new paragraph. -
hyphenation -
Only used if text is output with ps_show_boxed(). If set to
truethe paragraph will be hyphenated if a hypen dictionary is set and exists. -
hyphendict -
Filename of the dictionary used for hyphenation pattern.
Parameters
-
psdoc -
Resource identifier of the postscript file as returned by ps_new().
-
name -
Name of the parameter.
-
modifier -
An identifier needed if a parameter of a resource is requested, e.g. the size of an image. In such a case the resource id is passed.
Return Values
Returns the value of the parameter or false on failure.
