jundayw/pinyin

Chinese characters to Pinyin.

v3.0.0 2022-07-20 12:31 UTC

Requires

• php: >=7.2.0

MIT

• jundayw

• php
• laravel
• Pinyin
• thinkphp

README

使用 Composer 安装:

composer require jundayw/pinyin

原生 PHP 中使用：

use Jundayw\PinYin\PinYin;

$config = include("../config/pinyin.php");

$pinyin = new PinYin($config);

$pinyin->name('单某某');

框架 Laravel 中使用：

use Jundayw\PinYin\Facades\Alphabet;
use Jundayw\PinYin\PinYin;

// 门面使用方法
Alphabet::name('单某某', PinYin::PINYIN_NAME);

// 依赖注入
public function test(PinYin $pinyin) {
    return $pinyin->name('单某某');
}

发布配置文件

php artisan vendor:publish --tag=pinyin-config

框架 ThinkPHP 中使用（ThinkPHP6）：

use Jundayw\PinYin\Services\Alphabet;
use Jundayw\PinYin\PinYin;

// 门面使用方法
Alphabet::name('单某某', PinYin::PINYIN_NAME);

// 依赖注入
public function test(PinYin $pinyin) {
    return $pinyin->name('单某某');
}

发布配置文件

php think vendor:publish

可用选项：

拼音数组

$pinyin->convert('带着希望去旅行，比到达终点更美好');
// ["dai", "zhe", "xi", "wang", "qu", "lyu", "xing", "bi", "dao", "da", "zhong", "dian", "geng", "mei", "hao"]

$pinyin->convert('带着希望去旅行，比到达终点更美好', PinYin::PINYIN_TONE);
// ["dài","zhe","xī","wàng","qù","lǚ","xíng","bǐ","dào","dá","zhōng","diǎn","gèng","měi","hǎo"]

$pinyin->convert('带着希望去旅行，比到达终点更美好', PinYin::PINYIN_ASCII_TONE);
// ["dai4","zhe","xi1","wang4","qu4","lyu3","xing2","bi3","dao4","da2","zhong1","dian3","geng4","mei3","hao3"]

翻译姓名

姓名的姓的读音有些与普通字不一样，比如 ‘单’ 常见的音为 dan，而作为姓的时候读 shan。

name(string $chinese, int $option = PinYin::PINYIN_NAME)

$pinyin->name('单某某'); // ['shan', 'mou', 'mou']
$pinyin->name('单某某', PinYin::PINYIN_TONE); // ["shàn","mǒu","mǒu"]

生成用于链接的拼音字符串

kebab(string $chinese, string $delimiter = null, int $option = PinYin::PINYIN_DEFAULT  | PinYin::PINYIN_KEEP_NUMBER | PinYin::PINYIN_KEEP_ENGLISH)

$pinyin->kebab('带着希望去旅行'); // dai-zhe-xi-wang-qu-lyu-xing
$pinyin->kebab('带着希望去旅行', '.'); // dai.zhe.xi.wang.qu.lyu.xing

获取首字符字符串

abbr(string $chinese, string $delimiter = null, int $option = PinYin::PINYIN_DEFAULT | PinYin::PINYIN_NO_TONE)

$pinyin->abbr('带着希望去旅行'); // dzxwqlx
$pinyin->abbr('带着希望去旅行', '-'); // d-z-x-w-q-l-x

$pinyin->abbr('你好2018！', null, PinYin::PINYIN_KEEP_NUMBER); // nh2018
$pinyin->abbr('Happy New Year! 2018！', null, PinYin::PINYIN_KEEP_ENGLISH); // HNY2018

翻译汉语短语

phrase(string $chinese, string $delimiter = null, int $option = PinYin::PINYIN_DEFAULT)

$pinyin->phrase('新年快乐，2022 Happy New Year!');
// xin nian kuai le

// 数字、英文及标点符号不推荐使用 phrase 函数方法处理
$pinyin->phrase('新年快乐，2022 Happy New Year!', '-', PinYin::PINYIN_TONE | PinYin::PINYIN_KEEP_PUNCTUATION | PinYin::PINYIN_KEEP_ENGLISH | PinYin::PINYIN_KEEP_NUMBER);
// xīn-nián-kuài-lè,-2022-Happy-New-Year!

翻译整段文字为拼音

将会保留中文字符：，。 ！ ？ ： “ ” ‘ ’ 并替换为对应的英文符号。

sentence(string $chinese, string $delimiter = null, int $option = PinYin::PINYIN_NO_TONE | PinYin::PINYIN_KEEP_PUNCTUATION | PinYin::PINYIN_KEEP_ENGLISH | PinYin::PINYIN_KEEP_NUMBER)

$pinyin->sentence('带着希望去旅行，比到达终点更美好！');
// dai zhe xi wang qu lyu xing, bi dao da zhong dian geng mei hao!

$pinyin->sentence('带着希望去旅行，比到达终点更美好！', null, PinYin::PINYIN_TONE);
// dài zhe xī wàng qù lǚ xíng, bǐ dào dá zhōng diǎn gèng měi hǎo!

配置文件格式

使用 tab 制表符作为分隔符

[

    /*
    |--------------------------------------------------------------------------
    | DictLoader Driver
    |--------------------------------------------------------------------------
    |
    | Supported Drivers:
    | \Jundayw\PinYin\Support\FileDictLoader
    | \Jundayw\PinYin\Support\GeneratorFileDictLoader
    | \Jundayw\PinYin\Support\MemoryFileDictLoader
    |
    | Default:
    | \Jundayw\PinYin\Support\FileDictLoader
    |
    */

    'driver' => null,

    /*
    |--------------------------------------------------------------------------
    | 姓氏处理
    |--------------------------------------------------------------------------
    |
    */

    'surnames' => [
        '单' => '	shàn',
    ],

    /*
    |--------------------------------------------------------------------------
    | 单词处理
    |--------------------------------------------------------------------------
    | 注意：优先级高于短语处理
    |
    */

    'chars' => [
        '⺁' => '	fǎn',
    ],

    /*
    |--------------------------------------------------------------------------
    | 短语处理
    |--------------------------------------------------------------------------
    |
    */

    'words' => [
        '单田芳' => '	shàn	tián	fāng',
        '一路同行' => '	yí	lù	tóng	xíng',
    ],
];

可选字典驱动类型：

1、Jundayw\PinYin\Support\MemoryFileDictLoader

• 内存型，适用于服务器内存空间较富余
• 优点：转换快
• 将所有字典预先载入内存

2、Jundayw\PinYin\Support\FileDictLoader

• 小内存型（默认），适用于内存比较紧张的环境
• 优点：占用内存小，转换不如内存型快
• 将字典分片载入内存

3、Jundayw\PinYin\Support\GeneratorFileDictLoader

• I/O型，适用于虚拟机，内存限制比较严格环境
• 优点：非常微小内存消耗
• 缺点：转换慢，不如内存型转换快
• 不载入内存
• 将字典使用文件流打开逐行遍历并运用 php5.5 生成器 yield 特性分配单行内存

鸣谢

基于 CC-CEDICT 词典的中文转拼音工具，更准确的支持多音字的汉字转拼音解决方案。

项目源于 overtrue/pinyin ，因词库完善及补充不能满足业务时效性需求，此项目才应运而生。