Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hurnell/postcode-api-bundle
Symfony 4 bundle for postcodeapi.nu
https://github.com/hurnell/postcode-api-bundle
symfony-bundle symfony4
Last synced: 29 days ago
JSON representation
Symfony 4 bundle for postcodeapi.nu
- Host: GitHub
- URL: https://github.com/hurnell/postcode-api-bundle
- Owner: hurnell
- License: mit
- Created: 2019-05-13T09:10:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-22T10:33:45.000Z (over 5 years ago)
- Last Synced: 2024-11-17T13:49:38.744Z (about 2 months ago)
- Topics: symfony-bundle, symfony4
- Language: PHP
- Size: 55.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/hurnell/postcode-api-bundle) [](https://coveralls.io/github/hurnell/postcode-api-bundle) [](https://packagist.org/packages/hurnell/postcode-api-bundle) [](https://packagist.org/packages/hurnell/postcode-api-bundle)
# postcode-api-bundle
A Symfony 4 bundle to access Dutch postcode API at [Postcode API (postcodeapi.nu)](https://www.postcodeapi.nu/). Creates a PostcodeModel object based on postcode, house number & number extra combination.
## Characteristics/Requirements
Search based on postcode, house number AND house number extra. Note that some combinations of postcode and house number require a house number extra and without this extra value the address does NOT EXIST:
* ('2011XA', 20, '') is not a valid combination. For this combination of postcode and house number, extra must be 'A', 'RD' or 'ZW'.
* For the values ('2011XA', 20, '') the bundle will return an InvalidNumberExtraException with the following message: "House number extra must be (A, RD, ZW) for this combination of postcode and house number."
## Installation
1. Download via composer.
2. Enable bundle by adding class reference to config/bundles.php (if composer did not do that for you).
3. Create yaml configuration config/packages/hurnell_postcode_api.yaml with reference to your api_key.
### 1 - Download via composer
```bash
composer require hurnell/postcode-api-bundle:*
```
### 2 - Enable bundle
```php
# config/bundles.php
Hurnell\PostcodeApiBundle\HurnellPostcodeApiBundle::class => ['all' => true],
```
### 3 - Configure with API key
```yaml
# config/packages/hurnell_postcode_api.yaml
hurnell_postcode_api:
api_key: 'your_api_key'
```
## Usage
Autowiring is enabled by default so in a controller action (or constructor of other classes)
```php
createForm(PostcodeFormType::class);
try {
$postcodeModel = $client
->makeRequest(
'2011XC',
20,
'RD'
)
->populatePostcodeModel();
$postcodeModel->getStreet(); // Doelstraat
$postcodeModel->getCity(); // Haarlem
// $postcodeModel-> get etc etc
// json response
return $this->json($postcodeModel->toArray());
} catch (InvalidApiResponseException|InvalidPostcodeException $e) {
// handle exception
} catch (InvalidHouseNumberException $e) {
// handle exception
$form->get('number')->addError(new FormError($e->getMessage()));
} catch (InvalidNumberExtraException $e) {
// handle exception
$postcodeModel = $client->populatePostcodeModelWithoutExtra();
return $this->json(
array_merge(
$postcodeModel->toArray(),
['warning'=>$e->getMessage()]
)
);
}
}
}
```
### Handling InvalidNumberExtraException
Note that an invalid number extra value is not critical. Furthermore the api is not flawless; there are omissions for house number extra.
The method populatePostcodeModelWithoutExtra exists for these situations:
```php
try {
$postcodeModel = $client
->makeRequest(
'2011XC',
20,
'RD'
)
->populatePostcodeModel();
// ...
} catch (InvalidNumberExtraException $e) {
$postcodeModel = $client->populatePostcodeModelWithoutExtra();
return $this->json(
array_merge(
$postcodeModel->toArray(),
['warning'=>$e->getMessage()]
)
);
}
```