oai-pmh2/src/Entity.php

117 lines
3.3 KiB
PHP

<?php
/**
* OAI-PMH 2.0 Data Provider
* Copyright (C) 2024 Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
*
* 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
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace OCC\OaiPmh2;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Exception\ValidationFailedException;
use Symfony\Component\Validator\Validation;
/**
* Base class for all Doctrine/ORM entities.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package opencultureconsulting/oai-pmh2
*/
abstract class Entity
{
/**
* Check if a string is a valid URL.
*
* @param string $url The URL
*
* @return string The validated URL
*
* @throws ValidationFailedException
*/
protected function validateUrl(string $url): string
{
$url = trim($url);
$validator = Validation::createValidator();
$violations = $validator->validate(
$url,
[
new Assert\Url(),
new Assert\NotBlank()
]
);
if ($violations->count() > 0) {
throw new ValidationFailedException(null, $violations);
}
return $url;
}
/**
* Check if a string matches a given regular expression.
*
* @param string $string The string
* @param string $regEx The regular expression
*
* @return string The validated string
*
* @throws ValidationFailedException
*/
protected function validateRegEx(string $string, string $regEx): string
{
$validator = Validation::createValidator();
$violations = $validator->validate(
$string,
[
new Assert\Regex([
'pattern' => $regEx,
'message' => 'This value does not match the regular expression "{{ pattern }}".'
])
]
);
if ($violations->count() > 0) {
throw new ValidationFailedException(null, $violations);
}
return $string;
}
/**
* Check if a string is well-formed XML.
*
* @param string $xml The XML string
*
* @return string The validated XML string
*
* @throws ValidationFailedException
*/
protected function validateXml(string $xml): string
{
$validator = Validation::createValidator();
$violations = $validator->validate(
$xml,
[
new Assert\Type('string'),
new Assert\NotBlank()
]
);
if ($violations->count() > 0
or simplexml_load_string($xml) === false) {
throw new ValidationFailedException(null, $violations);
}
return $xml;
}
}