Kitodo\Dlf\Api\Orcid\Profile

Complexity

Total Complexity

12

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getFullName()	0	11	2
A	__construct()	0	3	1
A	getAddress()	0	9	2
A	getData()	0	12	2
A	getRaw()	0	6	3
A	getEmail()	0	9	2

<?php

/**
 * (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace Kitodo\Dlf\Api\Orcid;

use Kitodo\Dlf\Common\Helper;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use TYPO3\CMS\Core\Http\RequestFactory;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * ORCID profile API class
 **/
class Profile implements LoggerAwareInterface
{
    use LoggerAwareTrait;

    /**
     * The raw ORCID profile
     *
     * @var SimpleXmlElement

The type Kitodo\Dlf\Api\Orcid\SimpleXmlElement was not found. Did you mean SimpleXmlElement? If so, make sure to prefix the type with \.

     **/
    private $raw = null;

    /**
     * Constructs client instance
     *
     * @param string $orcid: the ORCID to search for
     *
     * @return void
     **/
    public function __construct($orcid)
    {
        $this->client = new Client($orcid, GeneralUtility::makeInstance(RequestFactory::class));

The property client does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    /**
     * Get the ORCID profile data
     *
     * @return  object
     **/
    public function getData()
    {
        $this->getRaw('person');
        if (!empty($this->raw)) {
            $data = [];
            $data['address'] = $this->getAddress();
            $data['email'] = $this->getEmail();
            $data['fullName'] = $this->getFullName();
            return $data;

The expression return $data returns the type array which is incompatible with the documented return type object.

        } else {
            $this->logger->warning('No data found for given ORCID');
            return false;

The expression return false returns the type false which is incompatible with the documented return type object.

        }
    }

    /**
     * Get the address
     * 
     * @return  string
     **/
    public function getAddress()
    {
        $this->getRaw('address');
        if (!empty($this->raw)) {
            $this->raw->registerXPathNamespace('address', 'http://www.orcid.org/ns/address');
            return (string) $this->raw->xpath('./address:address/address:country')[0];
        } else {
            $this->logger->warning('No address found for given ORCID');
            return false;

The expression return false returns the type false which is incompatible with the documented return type string.

        }
    }

    /**
     * Get the email
     * 
     * @return  string
     **/
    public function getEmail()
    {
        $this->getRaw('email');
        if (!empty($this->raw)) {
            $this->raw->registerXPathNamespace('email', 'http://www.orcid.org/ns/email');
            return (string) $this->raw->xpath('./email:email/email:email')[0];
        } else {
            $this->logger->warning('No email found for given ORCID');
            return false;

The expression return false returns the type false which is incompatible with the documented return type string.

        }
    }

    /**
     * Get the full name
     * 
     * @return  string
     **/
    public function getFullName()
    {
        $this->getRaw('personal-details');
        if (!empty($this->raw)) {
            $this->raw->registerXPathNamespace('personal-details', 'http://www.orcid.org/ns/personal-details');
            $givenNames = $this->raw->xpath('./personal-details:name/personal-details:given-names');
            $familyName = $this->raw->xpath('./personal-details:name/personal-details:family-name');
            return (string) $givenNames[0] . ' ' . (string) $familyName[0];
        } else {
            $this->logger->warning('No name found for given ORCID');
            return false;

The expression return false returns the type false which is incompatible with the documented return type string.

        }
    }

    /**
     * Get the ORCID part of profile data for given endpoint
     *
     * @return void
     **/
    protected function getRaw($endpoint)
    {
        $this->client->setEndpoint($endpoint);
        $data = $this->client->getData();
        if (!isset($this->raw) && $data != false) {
            $this->raw = Helper::getXmlFileAsString($data);

It seems like Kitodo\Dlf\Common\Helper::getXmlFileAsString($data) of type false is incompatible with the declared type Kitodo\Dlf\Api\Orcid\SimpleXmlElement of property $raw.

        }
    }
}