lajax / yii2-language-picker
Yii2 语言选择器小部件
1.2.1
2018-03-25 10:14 UTC
Requires
- yiisoft/yii2: ~2.0.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.11
README
Yii2 语言选择器小部件
简介
这个小部件提供了一种易于使用的语言选择器,使我们能够轻松地更改网站的语言。语言更改可以是同步的或异步的(通过Ajax)。默认方法是异步的(通过Ajax调用),但如果由于任何原因(例如客户端上阻止JavaScript)此方法失败,则新语言将通过自动页面刷新同步更新。
语言切换器是完全可定制的。然而,预定义的选项提供了下拉列表(下拉列表)和基于链接的列表(按钮列表)。两种版本都可以显示所选语言的名称和相应的标志(图标)。
安装
安装此扩展的首选方式是通过composer。
composer require lajax/yii2-language-picker
配置
语言元素的标识符。例如:en,en-US
重要
要使用这个小部件,urlManager配置中enablePrettyUrl属性的值必须为true,showScriptName的值为false。
示例
'components' => [ // ... 'urlManager' => [ 'enablePrettyUrl' => true, 'showScriptName' => false, 'rules' => [ // your rules go here ], // ... ], // ... ]
使用urlManager。
最小配置(仅图标)
'language' => 'en', 'bootstrap' => ['languagepicker'], 'components' => [ 'languagepicker' => [ 'class' => 'lajax\languagepicker\Component', // List of available languages (icons only) 'languages' => ['en', 'de', 'fr'], ] ],
最小配置(图标和文本)
'language' => 'en', 'bootstrap' => ['languagepicker'], 'components' => [ 'languagepicker' => [ 'class' => 'lajax\languagepicker\Component', // List of available languages (icons and text) 'languages' => ['en' => 'English', 'de' => 'Deutsch', 'fr' => 'Français'] ] ],
完整配置(仅图标)
'language' => 'en-US', 'bootstrap' => ['languagepicker'], 'components' => [ 'languagepicker' => [ 'class' => 'lajax\languagepicker\Component', 'languages' => ['en-US', 'de-DE', 'fr-FR'], // List of available languages (icons only) 'cookieName' => 'language', // Name of the cookie. 'cookieDomain' => 'example.com', // Domain of the cookie. 'expireDays' => 64, // The expiration time of the cookie is 64 days. // Function to execute after changing the language 'callback' => function() { if (!\Yii::$app->user->isGuest) { $user = \Yii::$app->user->identity; $user->language = \Yii::$app->language; $user->save(); } } ] ],
Yii2-translate-manager集成
最小配置(仅图标)
'language' => 'en', 'bootstrap' => ['languagepicker'], 'components' => [ 'languagepicker' => [ 'class' => 'lajax\languagepicker\Component', // Get available languages from translate manager 'languages' => function () { return array_keys(\lajax\translatemanager\models\Language::getLanguageNames(true)); } ] ],
最小配置(图标和文本)
'language' => 'en', 'bootstrap' => ['languagepicker'], 'components' => [ 'languagepicker' => [ 'class' => 'lajax\languagepicker\Component', // Get available languages from translate manager 'languages' => function () { return \lajax\translatemanager\models\Language::getLanguageNames(true); } ] ],
用法
显示语言选择器
显示预定义的语言选择器按钮(图标和文本或仅图标)
<?= \lajax\languagepicker\widgets\LanguagePicker::widget([ 'skin' => \lajax\languagepicker\widgets\LanguagePicker::SKIN_BUTTON, 'size' => \lajax\languagepicker\widgets\LanguagePicker::SIZE_SMALL ]); ?>
显示预定义的语言选择器下拉列表(图标和文本或仅图标)
<?= \lajax\languagepicker\widgets\LanguagePicker::widget([ 'skin' => \lajax\languagepicker\widgets\LanguagePicker::SKIN_DROPDOWN, 'size' => \lajax\languagepicker\widgets\LanguagePicker::SIZE_LARGE ]); ?>
自定义语言选择器
<?= \lajax\languagepicker\widgets\LanguagePicker::widget([ 'itemTemplate' => '<li><a href="{link}" title="{language}"><i id="{language}"></i> {name}</a></li>', 'activeItemTemplate' => '<a href="{link}" title="{language}"><i id="{language}"></i> {name}</a>', 'parentTemplate' => '<div class="language-picker dropdown-list {size}"><div>{activeItem}<ul>{items}</ul></div></div>', 'languageAsset' => 'lajax\languagepicker\bundles\LanguageLargeIconsAsset', // StyleSheets 'languagePluginAsset' => 'lajax\languagepicker\bundles\LanguagePluginAsset', // JavaScripts ]); ?>