Overview

Classes

  • Syllable
  • Syllable_Cache_FileAbstract
  • Syllable_Cache_Json
  • Syllable_Cache_Serialized
  • Syllable_Hyphen_Dash
  • Syllable_Hyphen_Entity
  • Syllable_Hyphen_Soft
  • Syllable_Hyphen_Text
  • Syllable_Hyphen_ZeroWidthSpace
  • Syllable_Source_File

Interfaces

  • Syllable_Cache_Interface
  • Syllable_Hyphen_Interface
  • Syllable_Source_Interface

Functions

  • Syllable_autoloader
  • Overview
  • Class

Class Syllable

Main class

Located at Syllable.php
Methods summary
public
# __construct( $language = 'en', $hyphen = null )
public static
# setCacheDir( $dir )
public static
# setLanguageDir( $dir )
public
# setLanguage( $language )
public
# setHyphen( Mixed $hyphen )

Set the hyphen to use when hyphenating text

Set the hyphen to use when hyphenating text

Parameters

$hyphen
either a Syllable_Hyphen_Interface or a string, which is turned into a Syllable_Hyphen_Text
public Syllable_Hyphen_Interface
# getHyphen( )

Returns

Syllable_Hyphen_Interface
hyphen
public
# setTreshold( type $treshold = Syllable::TRESHOLD_MOST )

Set the treshold. This feature is deprecated as it was based on misinterpretation of the algorithm.

Set the treshold. This feature is deprecated as it was based on misinterpretation of the algorithm.

Deprecated

since version 1.2

Parameters

$treshold
public integer
# getTreshold( )

Get the treshold. This feature is deprecated as it was based on misinterpretation of the algorithm.

Get the treshold. This feature is deprecated as it was based on misinterpretation of the algorithm.

Deprecated

since version 1.2

Returns

integer
public
# setCache( Syllable_Cache_Interface $Cache = null )

Parameters

$Cache
public Syllable_Cache_Interface
# getCache( )

Returns

Syllable_Cache_Interface
public
# setSource( Syllable_Source_Interface $Source )
public Syllable_Source_Interface
# getSource( )

Returns

Syllable_Source_Interface
public
# splitWord( $word )
public
# splitText( $text )
public
# hyphenateWord( $word )
public
# hyphenateText( $text )
public
# hyphenateHtml( $html )
public
# histogramText( $text )
public
# countWordsText( $text )
public
# countPolysyllablesText( $text )
Constants summary
float CACHE_VERSION

Version string, used to recalculate language caches if needed.

Version string, used to recalculate language caches if needed.

# 1.4
integer TRESHOLD_LEAST

Deprecated

since version 1.2
# PHP_INT_MAX
integer TRESHOLD_AVERAGE

Deprecated

since version 1.2
# PHP_INT_MAX
integer TRESHOLD_MOST

Deprecated

since version 1.2
# PHP_INT_MAX
API documentation generated by ApiGen