README

Chinese to Pinyin translator for Laravel based on overtrue/pinyin.

Install

composer require "overtrue/laravel-pinyin:^6.0"

The auto-discovery feature will handle these two steps for you.

Add the following line to the section providers of config/app.php:

'providers' => [
    //...
    Overtrue\LaravelPinyin\ServiceProvider::class,
],

as optional, you can use facade:

'aliases' => [
    //...
    'Pinyin' => Overtrue\LaravelPinyin\Facades\Pinyin::class,
],

Usage

you can get the instance of Overtrue\Pinyin\Pinyin from app container:

$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()`

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:

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

Performance Strategies (New in 6.0)

Laravel-pinyin 6.0 includes support for the new performance optimization strategies introduced in overtrue/pinyin 6.0:

use Overtrue\Pinyin\Pinyin;

// Memory Optimized (default) - ~400KB memory usage, suitable for web requests
Pinyin::useMemoryOptimized();

// Cached Strategy - ~4MB memory usage, 2-3x faster for repeated conversions
Pinyin::useCached();

// Smart Strategy - 600KB-1.5MB memory usage, adaptive loading
Pinyin::useSmart();

// Auto Strategy - automatically selects the best strategy for your environment
Pinyin::useAutoStrategy();

// Clear cache when needed (useful in long-running processes)
Pinyin::clearCache();

❤️ Sponsor me

如果你喜欢我的项目并想支持它，点击这里 ❤️

Project supported by JetBrains

Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.

PHP 扩展包开发

想知道如何从零开始构建 PHP 扩展包？

请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》

License

MIT

overtrue / laravel-pinyin

Maintainers

Details