Weave Code
Oai Bundle Laravel Package
subugoe/oai-bundle
Symfony bundle that adds an OAI-PMH 2.0 endpoint to your application, exposing repository records as Dublin Core and other metadata formats for harvesting by aggregators and discovery services. Includes configurable sets, resumption tokens, and standard error responses.
subugoe/oai-bundle is a Symfony bundle that adds an OAI-PMH 2.0 interface to your application, exposing repository records to external harvesters through the standard protocol verbs. It handles request parsing, validation, and XML response generation, so you can focus on mapping your domain data to OAI records.
- Configurable metadata formats, including Dublin Core
- Pluggable record providers backed by your own repositories
- Resumption tokens and pagination for large result sets
- OAI-compliant error handling and responses
- Seamless Symfony routing and service integration
Frequently asked questions about Oai Bundle
- Is subugoe/oai-bundle a Laravel package?
- No. subugoe/oai-bundle is a Symfony bundle from the Göttingen State and University Library that implements an OAI-PMH 2.0 data-provider endpoint. It registers through Symfony's bundle system and service container, not a Laravel service provider. In a Laravel codebase it will not auto-register and should be treated as a Symfony component to bridge, vendor, or run separately.
- Can I install subugoe/oai-bundle with Composer in a Laravel app?
- Composer may resolve and download it, but installation is not integration. The bundle depends on Symfony HTTP kernel, routing, event dispatching, and dependency injection abstractions that Laravel does not provide. There is no published Laravel integration, so expect to build a shim or choose a different integration shape.
- What license does subugoe/oai-bundle use, and can I use it in a SaaS product?
- The dominant risk noted in the evaluation is AGPL-3.0. Because an OAI-PMH endpoint is a network service, AGPL section 13 can oblige you to disclose the source of the entire application serving that endpoint to network users. For commercial or SaaS products this is often a hard blocker, so confirm with legal before building a proof of concept.
- Which Symfony and PHP versions does subugoe/oai-bundle support?
- The exact constraints are not stated in the provided context, so inspect the current composer.json before committing. The only release is dated 2023-04-03, which predates current Symfony LTS lines. Verify that the supported PHP and Symfony versions still receive security patches for your production environment.
- Does subugoe/oai-bundle pass the official OAI-PMH validator?
- There is no evidence in the evaluation that it is conformance-tested. OAI-PMH has strict requirements for the six verbs, error codes, resumption tokens, and date granularity, and a low-adoption implementation may not be validated. Test against the official OAI-PMH 2.0 validator and real harvesters such as BASE, OpenAIRE, and Europeana before relying on it.
- What metadata formats does subugoe/oai-bundle support?
- The provided context does not list the supported formats, only that sets, metadata formats, and record sources are configurable. OAI-PMH requires at least oai_dc, but you may need MARC, METS, ESE, DNB, or another format. Check the README and API surface to confirm whether your required format ships or a custom serializer is needed.
- How do I add an OAI-PMH endpoint to a Laravel application?
- The evaluation ranks three paths. Running the bundle in a minimal Symfony sidecar service and reverse-proxying /oai from Laravel is recommended for time-to-value because it preserves upstream code and isolates the Symfony dependency tree. Alternatively, vendor the OAI-PMH response-building classes and wrap them in Laravel controllers for long-term ownership, or accept a Symfony-hosted service. Each path has meaningfully different effort.
- Is subugoe/oai-bundle actively maintained?
- The signals are weak: one star, zero dependents, a single release on 2023-04-03, and a low package score. This looks like an internal library that was open-sourced rather than a community-maintained package. Bus factor is low, so you should expect to inherit maintenance and ask upstream about its security-fix posture and SLA.
- What are the alternatives to subugoe/oai-bundle for OAI-PMH in Laravel?
- The evaluation does not name specific alternatives, and no Laravel-native OAI-PMH package is mentioned. Realistic options are implementing the OAI-PMH 2.0 verbs in Laravel under a permissive license, adapting the bundle's core classes behind Laravel controllers, or using a separate repository platform that already exposes OAI-PMH. Weigh each against the AGPL-3.0 and maintenance risks of this bundle.
- How should I test an OAI-PMH endpoint built with subugoe/oai-bundle?
- Validate responses with the official OAI-PMH 2.0 validator and exercise all six verbs, including error codes, resumption tokens, and date granularity. Harvest the endpoint with real aggregators such as BASE, OpenAIRE, and Europeana to catch conformance gaps. Also test through your chosen integration shape, whether that is a Symfony sidecar behind a proxy or adapter-wrapped classes in Laravel.
Weaver
How can I help you explore Laravel packages today?