dynamikaweb / yii2-brasilapi
使用BrasilApi资源的巴西邮政编码查询yii2小部件
v1.0.1
2021-07-05 18:55 UTC
Requires
- php: >=7.0
- curl/curl: ^2.0
- yiisoft/yii2: *
README
描述
此库具有从BrasilAPI获取数据并以此数据形式作为小部件处理的功能。查看完整的API文档
安装
安装此扩展的首选方式是通过composer。
运行以下命令之一:
$ composer require dynamikaweb/yii2-brasilapi "*"
或
"dynamikaweb/yii2-brasilapi": "*"
将以下内容添加到您的composer.json
文件的require
部分:
用法
将规则添加到您的urlManager组件中,并添加模块
'components' =>[ 'urlManager' => [ ... 'rules' => [ 'brasilapi/<route:[a-zA-Z0-9\/-]+>' => 'brasilapi/request/index', ] ] ], ... 'modules' => [ 'brasilapi' => [ 'class' => '\dynamikaweb\brasilapi\Module' ], ]
小部件
此小部件将消费通过API获取的数据,并在选项中指定的字段中分配。
Widget Cep
请记住,必须添加相应的IDs
才能正确填写。如果您使用MaterializeCSS,请添加选项'template' => CepWidget::TEMPLATE_MATERIALIZE
。
use dynamikaweb\brasilapi\widgets\CepWidget; ... echo $form->field($model, 'cep')->widget(CepWidget::className(), [ //'template' => CepWidget::TEMPLATE_MATERIALIZE, 'fields' => [ 'street' => 'id-model-street', 'neighborhood' => 'id-model-neighborhood', 'city' => 'id-model-city', 'state' => 'id-model-state', ] ]);
或
echo CepWidget::widget([ 'fields' => [ 'street' => 'id-model-street', 'neighborhood' => 'id-model-neighborhood', 'city' => 'id-model-city', 'state' => 'id-model-state', ] ]);
此项目遵循BSD-3-Clause许可证。