Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/os2web/os2web_datalookup
https://github.com/os2web/os2web_datalookup
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/os2web/os2web_datalookup
- Owner: OS2web
- Created: 2019-11-28T08:51:45.000Z (about 5 years ago)
- Default Branch: 8.x
- Last Pushed: 2024-02-15T14:07:56.000Z (11 months ago)
- Last Synced: 2024-04-17T01:51:54.126Z (8 months ago)
- Language: PHP
- Size: 117 KB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OS2Web Data lookup [](https://travis-ci.org/OS2web/os2web_datalookup)
## Install
OS2Web Data lookup provides integration with Danish data lookup services such as Service platformen or Datafordeler.
Module is available to download via composer.
```
composer require os2web/os2web_datalookup
drush en os2web_datalookup
```
## Update
Updating process for OS2Web Data lookup module is similar to usual Drupal 8 module.
Use Composer's built-in command for listing packages that have updates available:
```
composer outdated os2web/os2web_datalookup
```
## Automated testing and code quality
See [OS2Web testing and CI information](https://github.com/OS2Web/docs#testing-and-ci)
## Contribution
Project is opened for new features and os course bugfixes.
If you have any suggestion or you found a bug in project, you are very welcome
to create an issue in github repository issue tracker.
For issue description there is expected that you will provide clear and
sufficient information about your feature request or bug report.
### Code review policy
See [OS2Web code review policy](https://github.com/OS2Web/docs#code-review)
### Git name convention
See [OS2Web git name convention](https://github.com/OS2Web/docs#git-guideline)
### Using services in other modules
```
// CVR lookup
/** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager $pluginManager */
$pluginManager = \Drupal::service('plugin.manager.os2web_datalookup');
/** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterfaceCompany $cvrPlugin */
$cvrPlugin = $pluginManager->createDefaultInstanceByGroup('cvr_lookup');
if ($cvrPlugin->isReady()) {
$cvrResult = $cvrPlugin->lookup($cvr);
}
// CPR lookup.
/** @var \Drupal\os2web_datalookup\Plugin\DataLookupManager $pluginManager */
$pluginManager = \Drupal::service('plugin.manager.os2web_datalookup');
/** @var \Drupal\os2web_datalookup\Plugin\os2web\DataLookup\DataLookupInterfaceCpr $cprPlugin */
$cprPlugin = $pluginManager->createDefaultInstanceByGroup('cpr_lookup');
if ($cprPlugin->isReady()) {
$cprResult = $cprPlugin->lookup($cpr);
}
// CVR lookup - DEPRECATED.
\Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cvr')->getLegalUnit('[CVR number]')
// CPP lookup - DEPRECATED.
\Drupal::service('plugin.manager.os2web_datalookup')->createInstance('serviceplatformen_cpr')->cprBasicInformation('[CPR number]'))
```
## New services/features
### Datafordeler integration (https://datafordeler.dk)
In scope of os2forms project already implemented light integration
with Danmarks Adresseregister (DAR) via fetching data for form elements
autocomplete. See [os2forms_dawa submodule](https://github.com/OS2Forms/os2forms)
As soon as it is clear how the integration is going to be used, then
os2forms_dawa will be refactored to OS2Web Data lookup plugin plugin.
## Important notes
### Serviceplatformen plugins
Settings for CPR and CVR serviceplantormen plugins are storing as configuration
in db and will(could) be exported as `yml` file via Drupal configuration
management system. And afterwards could be tracked by `git`.
If case you have public access to your git repository all setting from plugins
will be exposed for third persons.
To avoid/prevent this behavior we recommend use `Config ignore` module, where
you can add all settings you do not want to export/import via configuration
management system.