shivella/postcode-bundle

Symfony Postcode bundle

1.0.7 2021-03-13 19:38 UTC

Requires

• php: >=5.4
• guzzlehttp/guzzle: ^6.2
• symfony/framework-bundle: ^2.7 || ^3.0 || ^4.0

Requires (Dev)

• matthiasnoback/symfony-dependency-injection-test: ^3.0
• phpunit/phpunit: ^7.0

MIT

• Wessel Strengholt

• symfony
• address
• bundle
• zipcode
• postcode
• ApiWise
• postcode-api

README

This bundle can be useed to fetch Address details from zipcode with number. An account at Apiwise is required. For more information please take a look at: https://www.postcodeapi.nu

Installation

Installation is a quick 4 step process:

1. Download postcode-bundle using composer
2. Enable the Bundle in AppKernel.php
3. Configure Apiwise credentials
4. Add routes

Step 1: Download postcode-bundle using composer

Add UsoftPostcodeBundle by running the command:

$ composer require shivella/postcode-bundle

Step 2: Enable the Bundle in AppKernel.php

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Usoft\PostcodeBundle\UsoftPostcodeBundle(),
    );
}

Step 3: Configure Apiwise credentials

# app/config/config.yml

# Apiwise Postcode API
usoft_postcode:
    apiwise:
        key: secret_api_wise_key

Step 4. Add routes

# app/config/routing.yml

postcode:
    resource: "@UsoftPostcodeBundle/Resources/config/routing.yml"
    prefix:   /

Usage Services

$address = $this->get('usoft.postcode.client')->getAddress('1012JS', 1);
	
$address->getStreet();       // Dam
$address->getCity();         // Amsterdam
$address->getMunicipality(); // Amsterdam
$address->getProvince();     // Noord-Holland
$address->getNumber();       // 1
$address->getZipcode();      // 1012JS
$address->getGeoLocation();  // array('latitude' => 52.3732926, 'longitude' => 4.8937176)

Usage from API

Or try the API response:

http://127.0.0.1:8000/api/postcode?postcode=2011WD&nummer=2