https://github.com/yiier/yii2-china-region
Yii2 中国省市区三级联动
https://github.com/yiier/yii2-china-region
Last synced: about 2 months ago
JSON representation
Yii2 中国省市区三级联动
- Host: GitHub
- URL: https://github.com/yiier/yii2-china-region
- Owner: yiier
- Created: 2018-06-07T09:53:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-11T03:07:16.000Z (almost 7 years ago)
- Last Synced: 2024-04-14T09:58:38.083Z (about 1 year ago)
- Language: PHP
- Size: 537 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
china region for Yii2
=====================
Yii2中国省市区街道四级联动
[](https://packagist.org/packages/yiier/yii2-china-region)
[](https://packagist.org/packages/yiier/yii2-china-region)
[](https://packagist.org/packages/yiier/yii2-china-region)
[](https://packagist.org/packages/yiier/yii2-china-region)
Installation
------------
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiier/yii2-china-region "*"
```
or add
```
"yiier/yii2-china-region": "*"
```
to the require section of your `composer.json` file.
Migrations
------------
Run the following command
```
php yii migrate --migrationPath=@yiier/region/migrations/
```
配置
-------
在 controller 中添加以下 action
```php
public function actions()
{
$actions = parent::actions();
$actions['get-region'] = [
'class' => \yiier\region\RegionAction::className(),
];
return $actions;
}
```
使用
-------
view 页面
```php
= Html::label('地址') ?>
= $form->field($model, 'province_id')->widget(\yiier\region\RegionWidget::className(), [
'model' => $model,
'url' => \yii\helpers\Url::toRoute(['get-region']),
'showOutOfRange'=> true, // 默认是 false，表示只展示 out_of_range 为 0 的数据， true 表示展示所有数据
'province' => [
'attribute' => 'province_id',
'items' => Region::getRegion(),
'options' => ['class' => 'form-control form-control-inline', 'prompt' => '选择省份']
],
'city' => [
'attribute' => 'city_id',
'items' => Region::getRegion($model->province_id),
'options' => ['class' => 'form-control form-control-inline', 'prompt' => '选择城市']
],
'district' => [
'attribute' => 'district_id',
'items' => Region::getRegion($model->city_id),
'options' => ['class' => 'form-control form-control-inline', 'prompt' => '选择县/区']
],
'street' => [
'attribute' => 'street_id',
'items' => Region::getRegion($model->district_id),
'options' => ['class' => 'form-control form-control-inline', 'prompt' => '选择街道']
]
])->label(false); ?>
```
province 为省份配置，可用的选项可以查看 Html::dropdownList。如果不需要县/区或者街道，可以把 district 或者 street 删除。
**可选功能：使用 behaviors 轻松获取省、市、区、街道的名称**
你需要的 Model 主题 里添加 behaviors（注意：Model 主表字段不要命名为 province，会冲突，会导致此功能用不了，建议字段命名为 province_id；city 、district 和 street 字段同理）
```php
/**
* @inheritdoc
*/
public function behaviors()
{
return [
'region' => [
'class' => \yiier\region\RegionBehavior::className(),
'provinceAttribute' => 'provinceId', // 可选参数 默认 province_id
'cityAttribute' => 'cityId', // 可选参数 默认 city_id
'districtAttribute' => 'districtId', // 可选参数 默认 district_id
'streetAttribute' => 'streetId' // 可选参数 默认 street_id
],
];
}
```
然后可以通过下面方法获取到省、市、区、街道以及省市区街道的名称：
```php
$model = Model::findOne($id);
$model->province['name'];
$model->city['name'];
$model->district['name'];
$model->street['name'];
$model->fullRegion;
```
Credits
--------
[chenkby/yii2-region](https://github.com/chenkby/yii2-region)
_与之最大的区别是，数据源不同_