https://github.com/overtrue/laravel-pinyin
:cn: Chinese to Pinyin translator for Laravel 5 / Lumen
https://github.com/overtrue/laravel-pinyin
Last synced: about 1 year ago
JSON representation
:cn: Chinese to Pinyin translator for Laravel 5 / Lumen
- Host: GitHub
- URL: https://github.com/overtrue/laravel-pinyin
- Owner: overtrue
- License: mit
- Created: 2015-03-15T05:05:47.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-02-25T14:25:28.000Z (over 1 year ago)
- Last Synced: 2025-04-21T19:01:48.588Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 40 KB
- Stars: 528
- Watchers: 11
- Forks: 61
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Laravel-Pinyin
Chinese to Pinyin translator for Laravel5 / Lumen based on [overtrue/pinyin](https://github.com/overtrue/pinyin).
[](https://packagist.org/packages/overtrue/laravel-pinyin) [](https://packagist.org/packages/overtrue/laravel-pinyin) [](https://packagist.org/packages/overtrue/laravel-pinyin) [](https://packagist.org/packages/overtrue/laravel-pinyin)
[](https://github.com/sponsors/overtrue)
## Install
```shell
composer require "overtrue/laravel-pinyin:~4.0"
```
## For Laravel
(If you are using Laravel >= 5.5, the auto-discovery feature will handle these two steps for you.)
Add the following line to the section `providers` of `config/app.php`:
```php
'providers' => [
//...
Overtrue\LaravelPinyin\ServiceProvider::class,
],
```
as optional, you can use facade:
```php
'aliases' => [
//...
'Pinyin' => Overtrue\LaravelPinyin\Facades\Pinyin::class,
],
```
## For Lumen
Add the following line to `bootstrap/app.php` after `// $app->withEloquent();`
```php
...
// $app->withEloquent();
$app->register(Overtrue\LaravelPinyin\ServiceProvider::class);
...
```
## Usage
you can get the instance of `Overtrue\Pinyin\Pinyin` from app container:
```php
$pinyin = app('pinyin');
echo $pinyin->sentence('带着希望去旅行，比到达终点更美好');
// dài zhe xī wàng qù lǔ xíng, bǐ dào dá zhōng diǎn gèng měi hǎo
```
There are more convenient functions:
| function | method |
| ------------- | --------------------------------------------------- |
| `pinyin()` | `app('pinyin')->convert()` |
| `pinyin_abbr()` | `app('pinyin')->abbr()` |
| `pinyin_permalink` | `app('pinyin')->permalink()` |
| `pinyin_sentence` | `app('pinyin')->sentence()` |
```php
var_dump(pinyin('带着希望去旅行，比到达终点更美好'));
// ["dai", "zhe", "xi", "wang", "qu", "lv", "xing", "bi", "dao", "da", "zhong", "dian", "geng", "mei", "hao"]
var_dump(pinyin_abbr('带着希望去旅行'));
// dzxwqlx
...
```
Using facade:
```php
use Pinyin; // Facade class, NOT Overtrue\Pinyin\Pinyin
var_dump(Pinyin::convert('带着希望去旅行'));
// ["dai", "zhe", "xi", "wang", "qu", "lv", "xing"]
echo Pinyin::sentence('带着希望去旅行，比到达终点更美好');
// dài zhe xī wàng qù lǔ xíng, bǐ dào dá zhōng diǎn gèng měi hǎo
```
About `overtrue/pinyin` specific configuration and use, refer to: [overtrue/pinyin](https://github.com/overtrue/pinyin)
## :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 扩展包？
>
> 请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— [《PHP 扩展包实战教程 - 从入门到发布》](https://learnku.com/courses/creating-package)
## License
MIT