PHP Класс Overtrue\Pinyin\Pinyin

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$loader Overtrue\Pinyin\DictLoaderInterface Dict loader.
$punctuations array Punctuations map.

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
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.

Описание методов

__construct() публичный метод

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

abbr() публичный метод

Return first letters.
public abbr ( string $string, string $delimiter = '' ) : string
$string string
$delimiter string
Результат string

convert() публичный метод

Convert string to pinyin.
public convert ( string $string, string $option = self::NONE ) : array
$string string
$option string
Результат array

convertSurname() защищенный метод

Convert Chinese Surname to pinyin.
protected convertSurname ( string $string, Overtrue\Pinyin\DictLoaderInterface $dictLoader ) : string
$string string
$dictLoader Overtrue\Pinyin\DictLoaderInterface
Результат string

format() защищенный метод

Format.
protected format ( string $pinyin, boolean $tone = false ) : string
$pinyin string
$tone boolean
Результат string

getLoader() публичный метод

Return dict loader,.
public getLoader ( ) : Overtrue\Pinyin\DictLoaderInterface
Результат Overtrue\Pinyin\DictLoaderInterface

name() публичный метод

Convert string (person name) to pinyin.
public name ( string $stringName, string $option = self::NONE ) : array
$stringName string
$option string
Результат array

prepare() защищенный метод

Preprocess.
protected prepare ( string $string ) : string
$string string
Результат string

romanize() защищенный метод

Convert Chinese to pinyin.
protected romanize ( string $string, boolean $isName = false ) : string
$string string
$isName boolean
Результат string

sentence() публичный метод

Chinese to pinyin sentense.
public sentence ( string $sentence, $withTone = false ) : string
$sentence string
Результат string

setLoader() публичный метод

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

splitWords() публичный метод

Split pinyin string to words.
public splitWords ( string $pinyin, string $option ) : array
$pinyin string
$option string
Результат array

Описание свойств

$loader защищенное свойство

Dict loader.
protected DictLoaderInterface,Overtrue\Pinyin $loader
Результат Overtrue\Pinyin\DictLoaderInterface

$punctuations защищенное свойство

Punctuations map.
protected array $punctuations
Результат array