PHP Class JpnForPhp\Transliterator\TransliterationSystem

Author: Matthieu Bilbille (@mbibille)
Datei anzeigen Open project: mbilbille/jpnforphp Class Usage Examples

Public Properties

Property Type Description
$configuration Load transliteration system configuration.

Public Methods

Method Description
__construct ( $file ) Transliteration system's constructor
__toString ( ) Implement magic method __toString().
transliterate ( string $str ) : string Transliterate a string from an alphabet into another alphabet as per the workflow specified in the configuration file.

Protected Methods

Method Description
postTransliterate ( string $str ) : string To be executed after the transliteration workflow.
preTransliterate ( string $str ) : string To be executed before the transliteration workflow.

Method Details

__construct() public method

Transliteration system's constructor
public __construct ( $file )

__toString() abstract public method

Implement magic method __toString().
abstract public __toString ( )

postTransliterate() protected method

To be executed after the transliteration workflow.
protected postTransliterate ( string $str ) : string
$str string The transliterated string.
return string The transliterated string.

preTransliterate() protected method

To be executed before the transliteration workflow.
protected preTransliterate ( string $str ) : string
$str string The input string.
return string The string ready for transliteration.

transliterate() public method

Transliterate a string from an alphabet into another alphabet as per the workflow specified in the configuration file.
public transliterate ( string $str ) : string
$str string The string to be converted.
return string Converted string.

Property Details

$configuration public_oe property

Load transliteration system configuration.
public $configuration