PHP Class Overtrue\Pinyin\Pinyin

Show file Open project: overtrue/pinyin Class Usage Examples

Protected Properties

Property Type Description
$loader Overtrue\Pinyin\DictLoaderInterface Dict loader.
$punctuations array Punctuations map.

Public Methods

Method Description
__construct ( string $loaderName = null ) Constructor.
abbr ( string $string, string $delimiter = '' ) : string Return first letters.
convert ( string $string, string $option = self::NONE ) : array Convert string to pinyin.
getLoader ( ) : Overtrue\Pinyin\DictLoaderInterface Return dict loader,.
name ( string $stringName, string $option = self::NONE ) : array Convert string (person name) to pinyin.
permalink ( string $string, string $delimiter = '-' ) : string Return a pinyin permalink from string.
sentence ( string $sentence, $withTone = false ) : string Chinese to pinyin sentense.
setLoader ( Overtrue\Pinyin\DictLoaderInterface $loader ) Loader setter.
splitWords ( string $pinyin, string $option ) : array Split pinyin string to words.

Protected Methods

Method Description
convertSurname ( string $string, Overtrue\Pinyin\DictLoaderInterface $dictLoader ) : string Convert Chinese Surname to pinyin.
format ( string $pinyin, boolean $tone = false ) : string Format.
prepare ( string $string ) : string Preprocess.
romanize ( string $string, boolean $isName = false ) : string Convert Chinese to pinyin.

Method Details

__construct() public method

Constructor.
public __construct ( string $loaderName = null )
$loaderName string

abbr() public method

Return first letters.
public abbr ( string $string, string $delimiter = '' ) : string
$string string
$delimiter string
return string

convert() public method

Convert string to pinyin.
public convert ( string $string, string $option = self::NONE ) : array
$string string
$option string
return array

convertSurname() protected method

Convert Chinese Surname to pinyin.
protected convertSurname ( string $string, Overtrue\Pinyin\DictLoaderInterface $dictLoader ) : string
$string string
$dictLoader Overtrue\Pinyin\DictLoaderInterface
return string

format() protected method

Format.
protected format ( string $pinyin, boolean $tone = false ) : string
$pinyin string
$tone boolean
return string

getLoader() public method

Return dict loader,.
public getLoader ( ) : Overtrue\Pinyin\DictLoaderInterface
return Overtrue\Pinyin\DictLoaderInterface

name() public method

Convert string (person name) to pinyin.
public name ( string $stringName, string $option = self::NONE ) : array
$stringName string
$option string
return array

prepare() protected method

Preprocess.
protected prepare ( string $string ) : string
$string string
return string

romanize() protected method

Convert Chinese to pinyin.
protected romanize ( string $string, boolean $isName = false ) : string
$string string
$isName boolean
return string

sentence() public method

Chinese to pinyin sentense.
public sentence ( string $sentence, $withTone = false ) : string
$sentence string
return string

setLoader() public method

Loader setter.
public setLoader ( Overtrue\Pinyin\DictLoaderInterface $loader )
$loader Overtrue\Pinyin\DictLoaderInterface

splitWords() public method

Split pinyin string to words.
public splitWords ( string $pinyin, string $option ) : array
$pinyin string
$option string
return array

Property Details

$loader protected property

Dict loader.
protected DictLoaderInterface,Overtrue\Pinyin $loader
return Overtrue\Pinyin\DictLoaderInterface

$punctuations protected property

Punctuations map.
protected array $punctuations
return array