PubPeerFoundation\PublicationDataExtractor\Identifiers\Identifier

Complexity

Total Complexity

7

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	3	1
A	getRelatedResources()	0	3	1
A	__construct()	0	3	1
A	getComplementaryResources()	0	3	1
A	getQueryString()	0	3	1
A	getUrl()	0	3	1
A	__toString()	0	3	1

<?php

namespace PubPeerFoundation\PublicationDataExtractor\Identifiers;

abstract class Identifier
{
    /**
     * The query string.
     *
     * @var string
     */
    private $queryString;

    /**
     * The regex matches.
     *
     * @var array
     */
    protected $matches;

    /**
     * The regex to identify an identifier.
     *
     * @var string
     */
    protected $regex;

    /**
     * Array containing API resources to be fetched.
     *
     * @var array
     */
    protected $resources;

    /**
     * Base resource webpage URL.
     *
     * @var string
     */
    protected $baseUrl;

    /**
     * Identifier constructor.
     *
     * @param string $queryString
     */
    public function __construct(string $queryString)
    {
        $this->queryString = $queryString;
    }

    /**
     * Does the query contain a valid Identifier?
     *
     * @return bool
     */
    public function isValid(): bool
    {
        return (bool) preg_match($this->regex, $this->queryString, $this->matches);
    }

    /**
     * Resources getter.
     *
     * @return array
     */
    public function getRelatedResources(): array
    {
        return $this->resources;
    }

    /**
     * Complementary Resources getter.
     *
     * @return array
     */
    public function getComplementaryResources(): array
    {
        return $this->complementaryResources ?? [];
    }

    /**
     * Return URL to the identifier's publication website.
     *
     * @return string
     */
    public function getUrl()
    {
        return $this->baseUrl.$this->getQueryString();
    }

    /**
     * Class to String.
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->getQueryString();
    }

    /**
     * QueryString getter.
     *
     * @return string
     */
    public function getQueryString()
    {
        return rtrim($this->queryString, ' .');
    }
}