PHP download

Download the PHP package acdh-oeaw/arche-oaipmh without Composer

On this page you can find all versions of the php package acdh-oeaw/arche-oaipmh. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download acdh-oeaw/arche-oaipmh
More information about acdh-oeaw/arche-oaipmh
Files in acdh-oeaw/arche-oaipmh

Vendor acdh-oeaw
Package arche-oaipmh
Short Description OAI-PMH service for the ACDH repo solution
License MIT
Homepage https://github.com/acdh-oeaw/arche-oaipmh

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 arche-oaipmh

OAI-PMH service for arche-core

The main aim was to keep it flexible:

It doesn't enforce any metadata schema. RDF metadata to OAI-PMH facets (id, date, set) mappings are provided in a configuration file.
It's shipped with classes implementing various OAI-PMH metadata generation scenarios, e.g.:
- Using Dublin Core and Dublin Core terms contained in the repository resource RDF metadata.
- Serializing whole repository resource RDF metadata to XML.
- Serving another linked repository resource as the OAI-PMH metadata.
- By filling an XML template with repository resource RDF metadata.
It's easy to extend
- implement your own metadata sources
- implement your own search class
- implement your own sets

Installation

Run in your webroot:
Adjust config.yaml according to comments in the file.

Required repository structure

Much attention was paid to make the service flexible. To achieve that different implementations were provided for each of main components (set handling component, metadata source component). These implementations provide various features and put various requirements on your repository structure. Please read the documentation provided in the config-sample.yaml and, if needed, the documentation of particular classes to get more information.

Architecture

Source code documentation can be found at https://acdh-oeaw.github.io/arche-docs/devdocs/namespaces/acdhoeaw-arche-oaipmh.html

Oai

The main class is acdhOeaw\oai\Oai which works as a controller. It:

checks OAI-PMH requests correctness,
handles OAI-PMH identify and ListMetadataFormats commands
- the deletedRecord field value of the identify request response is fetched using the DeletedInterface
delegates OAI-PMH GetRecord, ListIdentifiers and ListRecords commands to a chosen class implementing the acdhOeaw\oai\search\SearchInterface
delegates OAI-PMH ListSets command to a chosen class extending the acdhOeaw\oai\set\SetInterface class.
generates OAI-PMH compliant output from results of above mentioned actions
catches errors and generates OAI-PMH compliant error responses

Until you want to implement the resumption tokens there should be no need to alter this class.

SetInterface

The acdhOeaw\oai\set\SetInterface provides an API:

for the Oai class to handle the ListSets OAI-PMH requests
for the SearchInterface implementations to include set information in searches

Currenlty there are three implementations of the SetInterface:

acdhOeaw\oai\set\NoSet simply throwing the noSetHierarchy OAI-PMH error
acdhOeaw\oai\set\Simple where set membership is fetched from a given RDF metadata property. This property value is taken as both <setSpec> and <setName> values and no <setDescription> is provided.
acdhOeaw\oai\set\Complex where a given RDF metadata property points to another repository resource describing the set.

If exsisting implementations don't fulfil your needs, you need to write your own class extending the acdhOeaw\oai\set\SetInterface one and set the oaiSetClass in the config.ini file to your class name.

DeletedInterface

The acdhOeaw\oai\deleted\DeletedInterface provides an API:

for the Oai class to get the deletedRecord field value to be reported in the OAI-PMH identify response
for the SearchInterface implementations to include information on resource deletion

Currently there are two implementations of the DeletedInterface:

acdhOeaw\oai\deleted\No reporting no support for deleted resources
acdhOeaw\oai\deleted\RdfProeprty where a resource having a given metadata property (no matter its value) is assumed to be deleted

If exsisting implementations don't fulfil your needs, you need to write your own class extending the acdhOeaw\oai\deleted\DeletedInterface one and set the oaiDeletedClass in the config.ini file to your class name.

SearchInterface

The acdhOeaw\oai\search\SearchInterface provides an API for the Oai class to:

Perform search for resources.
Get basic resource metadata required to serve the ListIdentifiers OAI-PMH request.
Data for each resource are returned as acdhOeaw\oai\data\Headerdata objects.
Get full resource metadata required to serve ListResources and GetRecord OAI-PMH requests.
Data for each resource are returned as acdhOeaw\oai\metadata\MetadataInterface objects.

The SearchInterface implementations depend on three other interfaces:

SetInterface for getting SPARQL search query extensions for including information and/or filters on sets.
DeletedInterface for including information on resources deletion.
MetadataInterface for getting the full resource metadata required to serve ListResources and GetRecord OAI-PMH requests.

The current implementation (acdhOeaw\oai\search\BasicSearch) is quite flexible:

takes OAI-PMH identifier and datestamp mappings from the configuration file (oaiIdProp and oaiDateProp)
honors set, deleted and metadata format SPARQL search query extensions provided by the SetInterface, DeletedInterface and MetadataInterface

Until you don't need to alter the way identifier and datestamp are fetched there should be no need to develop an alternative implementation (possibly with additional filters).

MetadataInterface

The acdhOeaw\oai\metadata\MetadataInterface provides a common API for fetching full OAI-PMH metadata from different sources, e.g. the repository resource metadata (by applying different mappings) or other repository resource.

To make it as flexible as possible:

It allows to extend SPARQL search queries performed by the SearchInterface implementations.
The MetadataInterface object constructor is provided with repository resource object, the metadata format description and full set of SPARQL search query data describing a given resource.

Existing implementations are:

acdhOeaw\oai\metadata\RdfXml serializes all resource's RDF metadata into XML.
acdhOeaw\oai\metadata\DcMetadata like the RdfXml but returns only Dublin Core and Dublin Core Terms metadata properties.
acdhOeaw\oai\metadata\ResMetadata uses another (linked trough metadata) resource's binary payload as the OAI-PMH metadata.
acdhOeaw\oai\metadata\CmdiMetadata a specialization of the ResMetadata additionaly checking for the binary resource content schema.
acdhOeaw\oai\metadata\TemplateMetadata creates metadata based on flexible XML templates. More detailed description can be found here.

It's possible that you'll need to generate OAI-PMH metadata in (yet) another way. In such a case you must develop your own class implementing the MetadataInterface. Taking look at already existing implementations should be a good starting point.

All versions of arche-oaipmh with dependencies

PHP Build Version

Package Version

Version 5.2.3 Release 04. Oct 2024
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of arche-oaipmh from vendor acdh-oeaw

Requires acdh-oeaw/arche-lib Version ^7
zozlak/logging Version ^1
zozlak/query-part Version ^2.1

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 acdh-oeaw/arche-oaipmh contains the following files

Loading the files please wait ....