fix:修复BUG/升级1.1.6版本
This commit is contained in:
224
vendor/overtrue/pinyin/README.md
vendored
224
vendor/overtrue/pinyin/README.md
vendored
@@ -1,124 +1,212 @@
|
||||
<h1 align="center">Pinyin</h1>
|
||||
# Pinyin
|
||||
|
||||
<p align="center">
|
||||
|
||||
[](https://travis-ci.org/overtrue/pinyin)
|
||||
[](https://github.com/overtrue/pinyin/actions/workflows/test.yml)
|
||||
[](https://packagist.org/packages/overtrue/pinyin) [](https://packagist.org/packages/overtrue/pinyin) [](https://packagist.org/packages/overtrue/pinyin) [](https://packagist.org/packages/overtrue/pinyin)
|
||||
[](https://scrutinizer-ci.com/g/overtrue/pinyin/?branch=master)
|
||||
[](https://scrutinizer-ci.com/g/overtrue/pinyin/?branch=master)
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fovertrue%2Fpinyin?ref=badge_shield)
|
||||
|
||||
</p>
|
||||
|
||||
:cn: 基于 [CC-CEDICT](http://cc-cedict.org/wiki/) 词典的中文转拼音工具,更准确的支持多音字的汉字转拼音解决方案。
|
||||
:cn: 基于 [mozillazg/pinyin-data](https://github.com/mozillazg/pinyin-data) 词典的中文转拼音工具,更准确的支持多音字的汉字转拼音解决方案。
|
||||
|
||||
[喜欢我的项目?点击这里支持我](https://github.com/sponsors/overtrue)
|
||||
|
||||
## 安装
|
||||
|
||||
使用 Composer 安装:
|
||||
|
||||
```
|
||||
$ composer require "overtrue/pinyin:~4.0"
|
||||
``` bash
|
||||
composer require overtrue/pinyin:^5.0
|
||||
```
|
||||
|
||||
## 使用
|
||||
|
||||
可选转换方案:
|
||||
### 拼音风格
|
||||
|
||||
- 内存型,适用于服务器内存空间较富余,优点:转换快
|
||||
- 小内存型(默认),适用于内存比较紧张的环境,优点:占用内存小,转换不如内存型快
|
||||
- I/O型,适用于虚拟机,内存限制比较严格环境。优点:非常微小内存消耗。缺点:转换慢,不如内存型转换快,php >= 5.5
|
||||
除了获取首字母的方法外,所有方法都支持第二个参数,用于指定拼音的格式,可选值为:
|
||||
|
||||
## 可用选项:
|
||||
- `symbol` (默认)声调符号,例如 `pīn yīn`
|
||||
- `none` 不输出拼音,例如 `pin yin`
|
||||
- `number` 末尾数字模式的拼音,例如 `pin1 yin1`
|
||||
|
||||
| 选项 | 描述 |
|
||||
| ------------- | ---------------------------------------------------|
|
||||
| `PINYIN_TONE` | UNICODE 式音调:`měi hǎo` |
|
||||
| `PINYIN_ASCII_TONE` | 带数字式音调: `mei3 hao3` |
|
||||
| `PINYIN_NO_TONE` | 无音调:`mei hao` |
|
||||
| `PINYIN_KEEP_NUMBER` | 保留数字 |
|
||||
| `PINYIN_KEEP_ENGLISH` | 保留英文 |
|
||||
| `PINYIN_KEEP_PUNCTUATION` | 保留标点 |
|
||||
| `PINYIN_UMLAUT_V` | 使用 `v` 代替 `yu`, 例如:吕 `lyu` 将会转为 `lv` |
|
||||
### 返回值
|
||||
|
||||
### 拼音数组
|
||||
除了 `permalink` 返回字符串外,其它方法都返回集合类型 [`Overtrue\Pinyin\Collection`](https://github.com/overtrue/pinyin/blob/master/src/Collection.php):
|
||||
|
||||
```php
|
||||
use Overtrue\Pinyin\Pinyin;
|
||||
|
||||
// 小内存型
|
||||
$pinyin = new Pinyin(); // 默认
|
||||
// 内存型
|
||||
// $pinyin = new Pinyin('\\Overtrue\\Pinyin\\MemoryFileDictLoader');
|
||||
// I/O型
|
||||
// $pinyin = new Pinyin('\\Overtrue\\Pinyin\\GeneratorFileDictLoader');
|
||||
|
||||
$pinyin->convert('带着希望去旅行,比到达终点更美好');
|
||||
// ["dai", "zhe", "xi", "wang", "qu", "lyu", "xing", "bi", "dao", "da", "zhong", "dian", "geng", "mei", "hao"]
|
||||
|
||||
$pinyin->convert('带着希望去旅行,比到达终点更美好', 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_ASCII_TONE);
|
||||
//["dai4","zhe","xi1","wang4","qu4","lyu3","xing2","bi3","dao4","da2","zhong1","dian3","geng4","mei3","hao3"]
|
||||
$pinyin = Pinyin::sentence('你好,世界');
|
||||
```
|
||||
|
||||
- 小内存型: 将字典分片载入内存
|
||||
- 内存型: 将所有字典预先载入内存
|
||||
- I/O型: 不载入内存,将字典使用文件流打开逐行遍历并运用php5.5生成器(yield)特性分配单行内存
|
||||
你可以通过以下方式访问集合内容:
|
||||
|
||||
```php
|
||||
echo $pinyin; // nǐ hǎo shì jiè
|
||||
|
||||
// 直接将对象转成字符串
|
||||
$string = (string) $pinyin; // nǐ hǎo shì jiè
|
||||
|
||||
$pinyin->toArray(); // ['nǐ', 'hǎo', 'shì', 'jiè']
|
||||
|
||||
// 直接使用索引访问
|
||||
$pinyin[0]; // 'nǐ'
|
||||
|
||||
// 使用函数遍历
|
||||
$pinyin->map('ucfirst'); // ['Nǐ', 'Hǎo', 'Shì', 'Jiè']
|
||||
|
||||
// 拼接为字符串
|
||||
$pinyin->join(' '); // 'nǐ hǎo shì jiè'
|
||||
$pinyin->join('-'); // 'nǐ-hǎo-shì-jiè'
|
||||
|
||||
// 转成 json
|
||||
$pinyin->toJson(); // '["nǐ","hǎo","shì","jiè"]'
|
||||
json_encode($pinyin); // '["nǐ","hǎo","shì","jiè"]'
|
||||
```
|
||||
|
||||
### 文字段落转拼音
|
||||
|
||||
```php
|
||||
use Overtrue\Pinyin\Pinyin;
|
||||
|
||||
echo Pinyin::sentence('带着希望去旅行,比到达终点更美好');
|
||||
// dài zhe xī wàng qù lyu xíng , bǐ dào dá zhōng diǎn gèng měi hǎo
|
||||
|
||||
// 去除声调
|
||||
echo Pinyin::sentence('带着希望去旅行,比到达终点更美好', 'none');
|
||||
dai zhe xi wang qu lyu xing , bi dao da zhong dian geng mei hao
|
||||
```
|
||||
|
||||
### 生成用于链接的拼音字符串
|
||||
|
||||
通常用于文章链接等,可以使用 `permalink` 方法获取拼音字符串:
|
||||
|
||||
```php
|
||||
$pinyin->permalink('带着希望去旅行'); // dai-zhe-xi-wang-qu-lyu-xing
|
||||
$pinyin->permalink('带着希望去旅行', '.'); // dai.zhe.xi.wang.qu.lyu.xing
|
||||
echo Pinyin::permalink('带着希望去旅行'); // dai-zhe-xi-wang-qu-lyu-xing
|
||||
echo Pinyin::permalink('带着希望去旅行', '.'); // dai.zhe.xi.wang.qu.lyu.xing
|
||||
```
|
||||
|
||||
### 获取首字符字符串
|
||||
|
||||
```php
|
||||
$pinyin->abbr('带着希望去旅行'); // dzxwqlx
|
||||
$pinyin->abbr('带着希望去旅行', '-'); // d-z-x-w-q-l-x
|
||||
|
||||
$pinyin->abbr('你好2018!', PINYIN_KEEP_NUMBER); // nh2018
|
||||
$pinyin->abbr('Happy New Year! 2018!', PINYIN_KEEP_ENGLISH); // HNY2018
|
||||
```
|
||||
|
||||
### 翻译整段文字为拼音
|
||||
|
||||
将会保留中文字符:`,。 ! ? : “ ” ‘ ’` 并替换为对应的英文符号。
|
||||
通常用于创建搜索用的索引,可以使用 `abbr` 方法转换:
|
||||
|
||||
```php
|
||||
$pinyin->sentence('带着希望去旅行,比到达终点更美好!');
|
||||
// dai zhe xi wang qu lyu xing, bi dao da zhong dian geng mei hao!
|
||||
echo Pinyin::abbr('带着希望去旅行'); // d z x w q l x
|
||||
echo Pinyin::abbr('带着希望去旅行')->join('-'); // d-z-x-w-q-l-x
|
||||
|
||||
$pinyin->sentence('带着希望去旅行,比到达终点更美好!', 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!
|
||||
echo Pinyin::abbr('你好2018!')->join(''); // nh2018
|
||||
echo Pinyin::abbr('Happy New Year! 2018!')->join(''); // HNY2018
|
||||
```
|
||||
|
||||
### 翻译姓名
|
||||
**姓名首字母**
|
||||
|
||||
将首字作为姓氏转换,其余作为普通词语转换:
|
||||
|
||||
```php
|
||||
echo Pinyin::nameAbbr('欧阳'); // o y
|
||||
echo Pinyin::nameAbbr('单单单')->join('-'); // s-d-d
|
||||
```
|
||||
|
||||
|
||||
### 姓名转换
|
||||
|
||||
姓名的姓的读音有些与普通字不一样,比如 ‘单’ 常见的音为 `dan`,而作为姓的时候读 `shan`。
|
||||
|
||||
```php
|
||||
$pinyin->name('单某某'); // ['shan', 'mou', 'mou']
|
||||
$pinyin->name('单某某', PINYIN_TONE); // ["shàn","mǒu","mǒu"]
|
||||
echo Pinyin::name('单某某'); // shàn mǒu mǒu
|
||||
echo Pinyin::name('单某某', 'none'); // shan mou mou
|
||||
echo Pinyin::name('单某某', 'none')->join('-'); // shan-mou-mou
|
||||
```
|
||||
|
||||
更多使用请参考 [测试用例](https://github.com/overtrue/pinyin/blob/master/tests/AbstractDictLoaderTestCase.php)。
|
||||
### 多音字
|
||||
|
||||
多音字的返回值为关联数组的集合:
|
||||
|
||||
```php
|
||||
$pinyin = Pinyin::polyphones('重庆');
|
||||
|
||||
echo $pinyin['重']; // ["zhòng", "chóng", "tóng"]
|
||||
echo $pinyin['庆']; // ["qìng"]
|
||||
|
||||
$pinyin->toArray();
|
||||
// [
|
||||
// "重": ["zhòng", "chóng", "tóng"],
|
||||
// "庆": ["qìng"]
|
||||
// ]
|
||||
```
|
||||
|
||||
### 单字转拼音
|
||||
|
||||
和多音字类似,单字的返回值为字符串,多音字将根据该字字频调整得到常用音:
|
||||
|
||||
```php
|
||||
$pinyin = Pinyin::polyphones('重庆');
|
||||
|
||||
echo $pinyin['重']; // "zhòng"
|
||||
echo $pinyin['庆']; // "qìng"
|
||||
|
||||
$pinyin->toArray();
|
||||
// [
|
||||
// "重": "zhòng",
|
||||
// "庆": "qìng"
|
||||
// ]
|
||||
```
|
||||
|
||||
> **Warning**
|
||||
>
|
||||
> 当单字处理时由于多音字来自词频表中取得常用音,所以在词语环境下可能出现不正确的情况,建议使用多音字处理。
|
||||
|
||||
更多使用请参考 [测试用例](https://github.com/overtrue/pinyin/blob/master/tests/PinyinTest.php)。
|
||||
|
||||
## 命令行工具
|
||||
|
||||
你可以使用命令行来实现拼音的转换:
|
||||
|
||||
```bash
|
||||
php ./bin/pinyin 带着希望去旅行
|
||||
|
||||
# dài zhe xī wàng qù lyu xíng
|
||||
```
|
||||
|
||||
更多使用方法,可以查看帮助文档:
|
||||
|
||||
```bash
|
||||
php ./bin/pinyin --help
|
||||
|
||||
# Usage:
|
||||
# ./pinyin [chinese] [method] [options]
|
||||
# Options:
|
||||
# -j, --json 输出 JSON 格式.
|
||||
# -c, --compact 不格式化输出 JSON.
|
||||
# -m, --method=[method] 转换方式,可选:name/phrase/permalink/polyphones/chars/nameAbbr/abbr/sentence.
|
||||
# --no-tone 不使用音调.
|
||||
# --tone-style=[style] 音调风格,可选值:default/none/number.
|
||||
# -h, --help 显示帮助.
|
||||
```
|
||||
|
||||
## 在 Laravel 中使用
|
||||
|
||||
独立的包在这里:[overtrue/laravel-pinyin](https://github.com/overtrue/laravel-pinyin)
|
||||
|
||||
## Contribution
|
||||
欢迎提意见及完善补充词库 [`overtrue/pinyin-dictionary-maker`](https://github.com/overtrue/pinyin-dictionary-maker/tree/master/patches) :kiss:
|
||||
|
||||
欢迎提意见及完善补充词库:
|
||||
- 单字拼音错误请添加到:[sources/pathes/chars.txt](https://github.com/overtrue/pinyin/blob/master/sources/pathes/chars.txt);
|
||||
- 词语错误或补齐,请添加到:[sources/pathes/words.txt](https://github.com/overtrue/pinyin/blob/master/sources/pathes/words.txt);
|
||||
|
||||
## 参考
|
||||
|
||||
- [mozillazg/pinyin-data](https://github.com/mozillazg/pinyin-data)
|
||||
- [详细参考资料](https://github.com/overtrue/pinyin-resources)
|
||||
|
||||
## :heart: Sponsor me
|
||||
|
||||
[](https://github.com/sponsors/overtrue)
|
||||
|
||||
如果你喜欢我的项目并想支持它,[点击这里 :heart:](https://github.com/sponsors/overtrue)
|
||||
|
||||
## Project supported by JetBrains
|
||||
|
||||
Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
|
||||
|
||||
[](https://www.jetbrains.com/?from=https://github.com/overtrue)
|
||||
|
||||
## PHP 扩展包开发
|
||||
|
||||
> 想知道如何从零开始构建 PHP 扩展包?
|
||||
@@ -127,4 +215,4 @@ $pinyin->name('单某某', PINYIN_TONE); // ["shàn","mǒu","mǒu"]
|
||||
|
||||
# License
|
||||
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fovertrue%2Fpinyin?ref=badge_large)
|
||||
MIT
|
||||
|
||||
Reference in New Issue
Block a user