https://github.com/jdkweb/rdw-api-filament
Filament extension for the Laravel rdw-api. The rdw-api is a wrapper for opendata.rdw.nl
https://github.com/jdkweb/rdw-api-filament
filament filamentphp php rdw rdwapi
Last synced: 6 months ago
JSON representation
Filament extension for the Laravel rdw-api. The rdw-api is a wrapper for opendata.rdw.nl
- Host: GitHub
- URL: https://github.com/jdkweb/rdw-api-filament
- Owner: jdkweb
- License: gpl-3.0
- Created: 2025-01-31T07:45:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-27T10:22:38.000Z (over 1 year ago)
- Last Synced: 2025-05-28T09:29:28.858Z (about 1 year ago)
- Topics: filament, filamentphp, php, rdw, rdwapi
- Language: PHP
- Homepage:
- Size: 138 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RDW API extension for Filament
[](https://github.com/jdkweb/rdw-api-filament)
[](https://github.com/jdkweb/rdw-api-filament)
[](https://github.com/jdkweb/rdw-api-filament)
[](https://github.com/jdkweb/rdw-api-filament)
[](https://packagist.org/packages/jdkweb/rdw-api)
Laravel wrapper for the Dutch open mobility data. Basic Vehicle Registration All non-sensitive data of the Dutch vehicle fleet.
Laravel application to get vehicle information from [opendata.rdw.nl](https://opendata.rdw.nl) or [overheid.io](https://overheid.io).
Depends on:
[](https://github.com/jdkweb/rdw-api)
[](https://packagist.org/packages/jdkweb/rdw-api)
This package extends [jdkweb/rdw-api](https://github.com/jdkweb/rdw-api?tab=readme-ov-file#demo) to be used in [Filament](https://filamentphp.com/).
## Table of contents
- [Installation](#installation)
- [Translation](#translation)
- [Usage](#usage)
- [Form Field](#formfield)
- [Handle Response](#response)
- [Example](#example)
- [Demo](#demo)
## Installation
Requires PHP 8.1 and Laravel 10 and Filament 3.0 or higher \
Install the package via composer:
```bash
composer require jdkweb/rdw-api-filament
```
## Translation
Translations available:
- [Dutch (nl)](https://github.com/jdkweb/rdw-api/tree/main/lang/nl)
- [English (en)](https://github.com/jdkweb/rdw-api/tree/main/lang/en)
See:
[](https://github.com/jdkweb/rdw-api/tree/main?tab=readme-ov-file#translation)
[](https://packagist.org/packages/jdkweb/rdw-api)
# Usage
- [Form Field](#formfield)
- [RDW Response](#response)
## Form Field
### Basic usage
```php
use Jdkweb\RdwApi\Filament\Forms\Components\RdwApiLicenseplate;
...
RdwApiLicenseplate::make('licenseplate')
->label(__('rdw-api::form.licenseplateLabel'))
->default('155GV3')
->licenseplateStyle() // Basic style Dutch licenseplate
```
- Request to the active API (default: opendata.rdw.nl) \
- All RDW endpoints are selected
### All options used
```php
use Jdkweb\RdwApi\Filament\Enums\Endpoints;
use Jdkweb\RdwApi\Filament\Enums\OutputFormats;
use Jdkweb\RdwApi\Filament\Forms\Components\RdwApiLicenseplate;
...
RdwApiLicenseplate::make('licenseplate')
->label(__('rdw-api::form.licenseplateLabel'))
->default('155GV3')
->setApi(1)
->setEndpoints(Endpoints::cases())
->setOutputformat(OutputFormats::ARRAY)
->setLanguage('en')
->licenseplateStyle()
```
### Options
#### Select other API than default
```php
->setApi(int|string|\Closure) // 0 | opendata | 1 | overheid
```
Overwrite the config settings
- 0 or 'opendata' for using the RDW API opendata.rdw.nl **[default]**
- 1 or 'overheidio' for using the overheid.io API
#### Select endpoints for request
```php
use \Jdkweb\RdwApi\Enums\Endpoints;
...
->setEndpoints(string|array|Endpoints|\Closure)
#examples
# one string
->setEndpoints('vehicle')
# array with strings
->setEndpoints([
'vehicle',
'fuel'
])
# array with endpoints
->setEndpoints([
Endpoints::VEHICLE,
Endpoints::FUEL,
])
# closure
->setEndpoints(fn() => ($when ? Endpoints::cases() : Endpoints::BODYWORK))
# select all
->setEndpoints(Endpoints::cases())
````
Available endpoints (not case sensitive):
- Endpoints::VEHICLE | vehicle
- Endpoints::VEHICLE_CLASS |vehicle_class
- Endpoints::FUEL | fuel
- Endpoints::BODYWORK | bodywork
- Endpoints::BODYWORK_SPECIFIC | bodywork_specific
- Endpoints::AXLES | axles
- Endpoints::cases() **[default]**
#### Format of the response output
```php
->outputFormat(string|OutputFormat|\Closure)
#examples
->outputFormat('array')
->outputFormat(OutputFormat::ARRAY)
->setOutputformat(fn(Forms\Get $get) => $get('output_format'))
```
- OutputFormat::ARRAY | array **[default]**
- OutputFormat::JSON | json
- OutputFormat::AML | xml
by using this method the response contains a formated output. see [RdwApiResponse](#RdwApiResponse)
#### Set output language
```php
->setLanguage(string|\Closure)
```
Force output language, so form can be English and RDW response in Dutch. \
Available:
- nl
- en
#### Basic style for Dutch licenseplate
```php
->licenseplateStyle()
->licenseplateStyle('taxi') // blue taxi plate
```
### Handle RDW response
RDW API request with to filament form data
```php
public function handleForm(string $form): void
{
$result = RdwApiRequest::make()
->setFormData($this->form)
->fetch();
```
#### RDW Response
Response data form the RDW API request in $result:
```php
Jdkweb\RdwApi\Controllers\RdwApiResponse {#2800 ▼
+response: array:2 [▶] // API response
+request: {#3036 ▶} // Request vars
+output: array:2 [▶] // Formated output when setOutputFormat is used
+status: true
}
```
See rdw-api for the [response methods](https://github.com/jdkweb/rdw-api/tree/main?tab=readme-ov-file#response)
## Example
Create Filament form
```php
use Jdkweb\RdwApi\Filament\Enums\Endpoints;
use Jdkweb\RdwApi\Filament\Enums\OutputFormats;
use Jdkweb\RdwApi\Controllers\RdwApiRequest;
use Jdkweb\RdwApi\Filament\Forms\Components\RdwApiLicenseplate;
use Jdkweb\RdwApi\Filament\Forms\Components\RdwApiResponse;
...
/**
* Dataset Selectbox
*/
Forms\Components\Select::make('datasets')
->label(__('rdw-api::form.selectdatasetLabel'))
->multiple()
->options(Endpoints::class)
->default([
Endpoints::VEHICLE,
Endpoints::FUEL
])
->hintAction(selectAllDatasets()) // Helper function for select all link
->reactive() // Enables reactivity
->required(),
//-----------------------------------------------------------------------------
/**
* Licenseplate
*
* Extra reactive data for Endpoints and outputFormat
*/
RdwApiLicenseplate::make('licenseplate')
->label(__('rdw-api::form.licenseplateLabel'))
->setOutputformat(fn(Forms\Get $get) => $get('output_format'))
->setEndpoints(fn(Forms\Get $get) => $get('datasets'))
->required()
->licenseplateStyle()
->live(true)
->afterStateUpdated(function ($state, Forms\Set $set) use ($form) {
$result = \Jdkweb\RdwApi\Controllers\RdwApiRequest::make()
->setFormData($form)
->fetch();
if ($result->status === false) {
return;
}
// Handle data
// $set('merk', $result->quickSearch('merk'));
// $set('voertuigsoort', $result->quickSearch('voertuigsoort'));
// $set('brandstof_omschrijving', $result->quickSearch('1.brandstof_omschrijving')); // type or hybrid: first type
// $set('aslast', $result->quickSearch('2.wettelijk_toegestane_maximum_aslast')); // second axle
// ...
}),
//-----------------------------------------------------------------------------
/**
* Selectbox for the output format
*/
Forms\Components\Select::make('output_format')
->label(__('rdw-api::form.formatLabel'))
->required()
->default(OutputFormats::XML)
->options(OutputFormats::class)
->reactive() // Enables reactivity
```
Handle Form data
```php
...
public function handleForm(string $form): void
{
// Get RDW data
$result = RdwApiRequest::make()
->setFormData($this->form)
->fetch();
...
..
// Handle data format
switch ($data->request->outputformat) {
case OutputFormat::XML:
$data->toXml(true)
...
```
## Demo
There is a demo available to test this wrapper \
Two options to use the demo:
1. ### .env
```php
RDW_API_DEMO=1
```
Add this value to .env
2. ### config
Import the rwd-api config en set the value to 1 ([Installation](#installation))
```php
rdw_api_demo => 1,
```
Demo: 0 = Off | 1 = On
### Demo url
```html
http://[domainname]/rdw-api/demo
```