Hyphenates a word

# ps_hyphenate

(PECL ps >= 1.1.1)

ps_hyphenate — Hyphenates a word

### Beschreibung

function ps_hyphenate(resource `$psdoc`, string `$text`): array|false

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.

### Parameter-Liste

`psdoc`

  Resource identifier of the postscript file as returned by ps_new().

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

### Rückgabewerte

An array of integers indicating the position of possible breaks in the text Bei einem Fehler wird `false` zurückgegeben..

### Beispiele

Beispiel #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);
    ?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    Ko-ordi-na-ten-sys-tem

### Siehe auch

- ps_show_boxed() - Output text in a box
- locale(1)

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open