php man page for ps_hyphenate

PS_HYPHENATE(3) 							 1							   PS_HYPHENATE(3)

ps_hyphenate - Hyphenates a word

SYNOPSIS
       array ps_hyphenate (resource  $psdoc, string  $text)

DESCRIPTION
	Hyphenates  the passed word. ps_hyphenate(3) evaluates the value hyphenminchars (set by ps_set_value(3)) and the parameter hyphendict (set
       by ps_set_parameter(3)). 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  envi-
       ronment variables. On Unix systems read the man page of locale for more information.

PARAMETERS
	      o $psdoc
		- Resource identifier of the postscript file as returned by ps_new(3).

	      o $text
		-$text	should	not  contain any non alpha characters. Possible positions for breaks are returned in an array of interger numbers.
		Each number is the position of the char in $text after which a hyphenation can take place.

RETURN VALUES
	An array of integers indicating the position of possible breaks in the text or FALSE on failure.

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
       ps_show_boxed(3), locale(1).

PHP Documentation Group 													   PS_HYPHENATE(3)