ps_hyphenate

Description

Hyphenates the passed word. ps_hyphenate() evaluates the value hyphenminchars (set by ps_set_value()) and the parameter hyphendict (set by ps_set_parameter()). hyphendict must be set before calling this function.

This function requires the locale category LC_CTYPE to be set properly. This is done when the extension is initialized by using the environment variables. On Unix systems read the man page of locale for more information.

Parameters

Return Values

An array of integers indicating the position of possible breaks in the text or FALSE in case of an error.

Examples

Example 1. Hyphennate a text <?php $word = "Koordinatensystem"; $psdoc = ps_new(); ps_set_parameter($psdoc, "hyphendict", "hyph_de.dic"); $hyphens = ps_hyphenate($psdoc, $word); for($i=0; $i<strlen($word); $i++) {   echo $word[$i];   if(in_array($i, $hyphens))     echo "-"; } ps_delete($psdoc); ?> The above example will output: Ko-ordi-na-ten-sys-tem

See Also