oai-pmh2/src/Middleware/ListMetadataFormats.php

91 lines
2.9 KiB
PHP
Raw Normal View History

2024-01-03 16:54:13 +01:00
<?php
/**
* OAI-PMH 2.0 Data Provider
2024-01-22 15:06:07 +01:00
* Copyright (C) 2024 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
2024-01-03 16:54:13 +01:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2024-01-22 15:06:07 +01:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2024-01-03 16:54:13 +01:00
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
2024-01-22 15:06:07 +01:00
* along with this program. If not, see <http://www.gnu.org/licenses/>.
2024-01-03 16:54:13 +01:00
*/
declare(strict_types=1);
namespace OCC\OaiPmh2\Middleware;
use OCC\OaiPmh2\Middleware;
2024-09-30 19:37:29 +02:00
use OCC\OaiPmh2\Response;
2024-01-03 16:54:13 +01:00
use Psr\Http\Message\ServerRequestInterface;
/**
* Process the "ListMetadataFormats" request.
2024-09-30 19:37:29 +02:00
*
2024-01-03 16:54:13 +01:00
* @see https://www.openarchives.org/OAI/openarchivesprotocol.html#ListMetadataFormats
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
2024-07-13 18:49:54 +02:00
* @package OAIPMH2
2024-01-03 16:54:13 +01:00
*/
class ListMetadataFormats extends Middleware
{
/**
* Prepare the response body for verb "ListMetadataFormats".
*
* @param ServerRequestInterface $request The incoming request
*
* @return void
*/
protected function prepareResponse(ServerRequestInterface $request): void
{
2024-10-14 14:51:42 +02:00
$formats = $this->em->getMetadataFormats($this->arguments['identifier']);
2024-01-03 16:54:13 +01:00
if (count($formats) === 0) {
2024-09-30 19:37:29 +02:00
if (
!isset($this->arguments['identifier'])
2024-10-14 14:51:42 +02:00
|| $this->em->isValidRecordIdentifier($this->arguments['identifier'])
2024-09-30 19:37:29 +02:00
) {
2024-10-14 14:51:42 +02:00
ErrorHandler::getInstance()->withError('noMetadataFormats');
2024-01-03 16:54:13 +01:00
} else {
2024-10-14 14:51:42 +02:00
ErrorHandler::getInstance()->withError('idDoesNotExist');
2024-01-03 16:54:13 +01:00
}
return;
}
2024-10-14 14:51:42 +02:00
$response = new Response($request);
$listMetadataFormats = $response->createElement('ListMetadataFormats', '', true);
2024-01-03 16:54:13 +01:00
foreach ($formats as $oaiFormat) {
2024-10-14 14:51:42 +02:00
$metadataFormat = $response->createElement('metadataFormat');
$listMetadataFormats->appendChild($metadataFormat);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$metadataPrefix = $response->createElement(
2024-10-14 14:51:42 +02:00
'metadataPrefix',
$oaiFormat->getPrefix()
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$metadataFormat->appendChild($metadataPrefix);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$schema = $response->createElement(
2024-10-14 14:51:42 +02:00
'schema',
$oaiFormat->getSchema()
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$metadataFormat->appendChild($schema);
2024-01-03 16:54:13 +01:00
2024-09-30 19:37:29 +02:00
$metadataNamespace = $response->createElement(
2024-10-14 14:51:42 +02:00
'metadataNamespace',
$oaiFormat->getNamespace()
2024-09-30 19:37:29 +02:00
);
2024-10-14 14:51:42 +02:00
$metadataFormat->appendChild($metadataNamespace);
2024-01-03 16:54:13 +01:00
}
2024-09-30 19:37:29 +02:00
$this->preparedResponse = $response;
2024-01-03 16:54:13 +01:00
}
}