luiseduardo / yii2-correios

3.0.1 2025-06-16 12:57 UTC

Requires

• yiisoft/yii2: >=2.0.0

BSD-3-Clause

• Wanderson Bragança
• Luis Eduardo

• extension
• yii2
• correios
• viacep

Published on Packagist.org on 2025-06-16 12:57 UTC

README

This extension allows automatic completion and search Brazilian address.

Installation

Add to the require section of your composer.json file:

"luiseduardo/yii2-correios": "*"

Configuration

On your controller.

public function actions()
{
    return [
        ...
        'addressSearch' => 'luiseduardo\correios\CepAction'
        ...
    ];
}

How to use

On your view file.

<?php
use luiseduardo\correios\CepInput;
?>

...

<?= CepInput::widget([
    'name' => 'cep',
    'action' => ['addressSearch'],
    'fields' => [
        'location' => 'location_input_id',
        'district' => 'district_input_id',
        'city' => 'city_input_id',
        'state' => 'state_input_id'
    ],
]); ?>

// Example:

<?= $form->field($model, 'cep',)->widget('luiseduardo\correios\CepInput', [
    'action' => ['addressSearch'],
    'fields' => [
        'location' => 'address-location',
        'district' => 'address-district',
        'city' => 'address-city',
        'state' => 'address-state',
    ],
]) ?>

<?= $form->field($model, 'location')->textInput() ?>
<?= $form->field($model, 'district')->textInput() ?>
<?= $form->field($model, 'city')->textInput() ?>
<?= $form->field($model, 'state')->textInput() ?>