Download the PHP package common-gateway/pdd-bundle without Composer

On this page you can find all versions of the php package common-gateway/pdd-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package pdd-bundle

OpenWoo Service

De OpenWoo Service versterkt de toegankelijkheid van overheidspublicaties volgens de Wet open overheid (Woo) door organisatiebronnen naadloos te synchroniseren met Open Index. Deze kernservice ondersteunt efficiënte zoekacties binnen Woo-categorieën en bevordert data-uitwisseling via het Common Ground OpenServices framework. Het faciliteert integratie met lokale en landelijke publicatieplatformen, inclusief koppelingen met het Kennis- en Exploitatiecentrum Officiële Publicaties (KOOP). OpenWoo.app is ontworpen voor zowel open source als proprietary platforms, waardoor het een centrale oplossing biedt voor het beheer en de zoekbaarheid van overheidsinformatie..

Kernfunctionaliteiten

Installatie

Vereisten

Stap-voor-stap Installatiegids in een Common Gateway

  1. Clone het OpenWoo repository: git clone https://github.com/OpenWoo/OpenWooService.git
  2. Installeer afhankelijkheden met Composer: composer install
  3. Pas de .env bestanden aan met uw specifieke configuraties voor de database en andere diensten.
  4. Start de OpenWoo Service met Docker: docker-compose up -d

Docker container

Er is ook een docker-compose.yml beschikbaar voor de OpenWoo service om bovenstaande snel op te bouwen. Deze file is beschikbaar in de root folder van deze repository. Om deze te draaien is docker benodigd en zet u de volgende stappen:

  1. Open een terminalvenster waarmee Docker kan worden gedraaid
  2. Navigeer naar de map waarin u de repository heeft gecloned
  3. Draai het commando docker compose up
    1. Indien de image nog niet in docker beschikbaar is, zal de image opnieuw worden opgebouwd op basis van de latest versie van de common gateway images.
    2. Daarna worden de containers gestart (als de image wel beschikbaar is zal dit direct gebeuren)
  4. De admin omgeving komt beschikbaar op https://localhost:8000, de frontend op https://localhost:8080

Op de admin omgeving kan worden ingelogd met de default credentials username: [email protected], password: !ChangeMe!. Daarmee kan dan de configuratie van de omgeving worden beïnvloed.

Wijzigingen die in de code van deze repository (de map src) worden gedaan worden lokaal direct overgenomen. Changes in de configuratiebestanden in deze repository (Installation-folder) worden eveneens overgenomen, maar moeten om actief te worden in de lokale omgeving nog worden ingeladen met het commando docker compose exec php bin/console commongateway:initialize

Gebruik

Na de installatie kunt u de OpenWoo Service configureren om te beginnen met de automatische synchronisatie van uw organisatiebronnen naar Open Index.

De synchronisaties werken aan de hand van een action in combinatie met een source. Hieronder wordt uitgelegd hoe deze ingevuld moeten worden, er zijn ook genoeg voorbeelden in de /Installation/Action en /Installation/Source folders.

Er kan vanuit de volgende brontypen gesynchroniseerd worden:

Voor elk brontypen verschilt de configuratie voor de source en action die ingevuld moet worden.

Source

Een source heeft standaard een reference en een name nodig. De reference moet uniek zijn als bijvoorbeeld https://commongateway.woo.nl/source/example.zaaksysteem.source.json.

Zaaksysteem

Voor een source voor een zaaksysteem moeten de location ingevoerd worden. Dat is de volledige url van het zaaksysteem url, dus inclusief https:// aan het begin en /api aan het eind.

Ook moeten er headers geset worden met auth gegevens om te kunnen autoriseren voor het ophalen van documenten, hier een voorbeeld: "headers": { "Accept": "*/*", "API-Interface-ID": "{apiInterfaceId}", "API-KEY": "{apiKey}", "Content-Type": "application/json" }

Als je al de velden van je source goed ingevuld heb kan je hem aanzetten door isEnabled op true te zetten.

De volledige POST van een goed ingevulde source voor het zaaksysteem ziet er als volgt uit: { "reference": "https://commongateway.woo.nl/source/example.zaaksysteem.source.json" "name": "Jouw zaaksysteem", "location": "https://{zaaksysteemUrl}/api", "isEnabled": true, "headers": { "Accept": "*/*", "API-Interface-ID": "{apiInterfaceId}", "API-KEY": "{apiKey}", "Content-Type": "application/json" } }

OpenWoo en OpenConvenant

Voor een source voor OpenWoo of OpenConvenant hoeft alleen de location geset te worden, inclusief https:// aan het begin en /wp-json aan het eind (bijv: https://{openWooUrl}/wp-json).

Als je wilt dat je source en dus synchronisatie aanstaat moet isEnabled op true staan.

De volledige POST van een goed ingevulde source voor het OpenWoo of OpenConvenant ziet er als volgt uit: { "reference": "https://commongateway.woo.nl/source/example.openwoo.source.json" "name": "Jouw OpenWoo", "location": "https://{openWooUrl}/wp-json", "isEnabled": true }

Action

Voor een voorbeeld van een action voor het zaaksysteem kan je kijken naar SyncEpeAction en als voor OpenWoo naar SyncBurenOpenWooAction. Voor OpenConvenant kan er gekeken worden naar SyncBurenOpenConvenantAction.

Een action heeft standaard een reference en een name nodig. De reference moet uniek zijn als bijvoorbeeld https://commongateway.nl/woo.SyncExampleAction.action.json.

Een action heeft ook een listens veld. Deze is in deze context meestal gelijk aan de throws van de algemene cronjob: woo.default.listens. Dit zorgt ervoor dat de action (synchronisatie) elke x minuten afgaat als in de cronjob ingesteld staat (standaard 10 minuten).

Het conditions veld. Dit zijn extra regels waneer een action af mag gaan. In dit geval gaan de actions standaard op de throws van de cronjob af, ingesteld via het listens van de action, dus mag hier de conditions standaard op {"==": [1,1]}. Deze json logic betekend dat hij altijd afgaat (op het listens event).

Het class veld. Dit geeft aan welke code uitgevoerd gaat worden voor deze action. Voor verschillende bronnen kan dit anders zijn:

De action heeft in de configuratie array een aantal velden wat geconfigureerd moet worden, sommige velden zijn verplicht en andere niet. Het verschilt ook vanuit wat voor type source (zaaksysteem, OpenWoo of OpenConvenant) gesynchroniseerd wordt:

Check altijd ook of de action aan staat met het isEnabled veld. Deze moet op true staan als er gesynchroniseerd moet worden.

De POST van een action voor het zaaksysteem ziet er als volgt uit: { "reference": "https://commongateway.nl/woo.SyncExampleAction.action.json", "name": "SyncExampleCasesAction", "listens": [ "woo.default.listens" ], "conditions": { "==": [ 1, 1 ] }, "class": "CommonGateway\\WOOBundle\\ActionHandler\\SyncXxllncCasesHandler", "configuration": { "oin": "{oinNummer}", "portalUrl": "https://conductionnl.github.io/woo-website-example", "source": "https://commongateway.woo.nl/source/example.zaaksysteem.source.json", "schema": "https://commongateway.nl/woo.publicatie.schema.json", "mapping": "https://commongateway.nl/mapping/woo.xxllncCaseToWoo.mapping.json", "organisatie": "Example", "zaaksysteemSearchEndpoint": "{zaaksysteemZoekEndpoint}", "fileEndpointReference": "https://commongateway.nl/woo.ViewFile.endpoint.json" }, "isEnabled": true }

De POST van een action voor het OpenWoo of OpenConvenant ziet er als volgt uit: { "reference": "https://commongateway.nl/woo.SyncExampleOpenConvenantAction.action.json", "name": "SyncExampleOpenConvenantAction", "listens": [ "woo.default.listens" ], "conditions": { "==": [ 1, 1 ] }, "class": "CommonGateway\\WOOBundle\\ActionHandler\\SyncOpenWooHandler", "configuration": { "oin": "{oinNummer}", "portalUrl": "https://conductionnl.github.io/woo-website-example", "source": "https://commongateway.woo.nl/source/example.openwoo.source.json", "schema": "https://commongateway.nl/woo.publicatie.schema.json", "mapping": "https://commongateway.nl/mapping/woo.openConvenantToWoo.mapping.json", "sourceType": "openWoo", "organisatie": "Exanoke", "sourceEndpoint": "{sourceEndpoint}" }, "isEnabled": true }

Als de action en source aangemaakt/ingeregeld zijn en isEnabled staat op true. Zou de cronjob elke x minuten deze action afvuren en de synchrosatie aftrappen. Check de logs of om te kijken of deze de 1e keer goed gaat.

Bijdragen

Wij verwelkomen bijdragen aan de OpenWoo Service, of het nu gaat om bugrapporten, feature suggesties, of codebijdragen. Zie onze CONTRIBUTING.md voor meer informatie over hoe u kunt bijdragen.

Licentie

De OpenWoo Service is uitgegeven onder de EUPL 1.2 licentie. Voor meer details, zie het LICENSE.md bestand in onze GitHub repository.

Contact

Voor meer informatie over de OpenWoo Service en hoe deze in uw organisatie geïmplementeerd kan worden, kunt u contact met ons opnemen via [email protected].


All versions of pdd-bundle with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
commongateway/corebundle Version ^1.3.18 | <2.0
smalot/pdfparser Version ^2.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package common-gateway/pdd-bundle contains the following files

Loading the files please wait ....