Home > PHP > Function > PS > ps_hyphenate()

ps_hyphenate()

ps_hyphenate - Hyphenates a word

Syntax

array ps_hyphenate (resource $psdoc, string $text)

Arguments

  • 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 interger numbers. Each number is the position of the char in text after which a hyphenation can take place.

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.

Version

PHP PECL ps >= 1.1.1

Return value

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