SimplePie\Type\Entry

Complexity

Total Complexity

28

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Test Coverage

Coverage

76.67%

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
C	getHandler()	0	43	15
B	getAlias()	0	29	9
A	getNode()	0	3	1
A	__construct()	0	12	2

<?php
/**
 * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
 * Copyright (c) 2017–2019 Contributors.
 *
 * http://opensource.org/licenses/Apache2.0
 */

declare(strict_types=1);

namespace SimplePie\Type;

use DOMNode;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use SimplePie\Configuration as C;
use SimplePie\Exception\SimplePieException;
use SimplePie\Mixin as Tr;
use SimplePie\Parser\Date as DateParser;

/**
 * A type model for an Entry element.
 *
 * @see https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-Atom-1.0#412-the-atomentry-element
 * @see https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-RSS-1.0#535-items
 * @see https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-RSS-1.0#55-item
 * @see https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-RSS-2.0#elements-of-item
 * @see https://github.com/simplepie/simplepie-ng/wiki/Spec%3A-JSON-Feed-v1#items
 *
 * @phpcs:disable Generic.Files.LineLength.MaxExceeded
 *
 * @method array getAuthors(string $namespaceAlias) Returns the Authors associated with this entry.
 * @method array getCategories(string $namespaceAlias) Returns the list of Categories/Tags/Topics associated with this entry.
 * @method SimplePie\Type\Node getContent(string $namespaceAlias) Returns the content of the entry, serialized as TEXT, HTML, or XHTML content.
 * @method array getContributors(string $namespaceAlias) Returns the list of Contributors associated with this entry.
 * @method SimplePie\Type\Node getCopyright(string $namespaceAlias) Alias for `getRights()`.
 * @method SimplePie\Type\Node getGuid(string $namespaceAlias) Alias for `getId()`.
 * @method SimplePie\Type\Node getId(string $namespaceAlias) Returns the ID associated with this entry.
 * @method SimplePie\Type\Node getLang(string $namespaceAlias) Alias for `getLanguage()`.
 * @method SimplePie\Type\Node getLanguage(string $namespaceAlias) Returns the language associated with this entry.
 * @method array getLinks(string $namespaceAlias, string $relFilter) Returns the list of Links associated with this entry.
 * @method \DateTime getPubDate(string $namespaceAlias) Alias for `getPublished()`.
 * @method \DateTime getPublished(string $namespaceAlias) Returns the date that the entry was published.
 * @method SimplePie\Type\Node getRights(string $namespaceAlias) Returns the copyright information associated with this entry.
 * @method SimplePie\Type\Node getSummary(string $namespaceAlias) Returns the summary associated with this entry.
 * @method SimplePie\Type\Node getTitle(string $namespaceAlias) Returns the title associated with this entry.
 * @method \DateTime getUpdated(string $namespaceAlias) Returns the date that the entry was updated.
 *
 * @phpcs:enable
 */
class Entry extends AbstractType implements BranchInterface, C\SetLoggerInterface, NodeInterface
{
    use Tr\DateTrait;
    use Tr\DeepTypeTrait;
    use Tr\LoggerTrait;

The type SimplePie\Mixin\LoggerTrait was not found. Maybe you did not declare it correctly or list all dependencies?

    /**
     * The DOMNode element to parse.
     *
     * @var DOMNode
     */
    protected $node;

    /**
     * The preferred namespace alias for a given XML namespace URI. Should be
     * the result of a call to `SimplePie\Util\Ns`.
     *
     * @var string
     */
    protected $namespaceAlias;

    /**
     * Constructs a new instance of this class.
     *
     * @param string          $namespaceAlias [description]
     * @param DOMNode|null    $node           The `DOMNode` element to parse.
     * @param LoggerInterface $logger         The PSR-3 logger.
     *
     * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
     */
    public function __construct(
        string $namespaceAlias,
        ?DOMNode $node = null,
        LoggerInterface $logger = null
    ) {
        // @phpcs:enable

        $this->namespaceAlias = $namespaceAlias;

        if ($node) {
            $this->logger = $logger ?? new NullLogger();

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

            $this->node   = $node;
        }
    }

    /**
     * Converts this object into a string representation.
     */
    public function __toString(): string
    {
        return \sprintf('<%s: resource %s>', \get_called_class(), \md5(\spl_object_hash($this)));
    }

    /**
     * Gets the DOMNode element.
     */
    public function getNode(): ?DOMNode
    {
        return $this->node;
    }

    /**
     * Finds the common internal alias for a given method name.
     *
     * @param string $nodeName The name of the method being called.
     */
    public function getAlias(string $nodeName): string
    {
        switch ($nodeName) {
            case 'authors':
                return 'author';

            case 'categories':
                return 'category';

            case 'contributors':
                return 'contributor';

            case 'copyright':
                return 'rights';

            case 'guid':
                return 'id';

            case 'language':
                return 'lang';

            case 'links':
                return 'link';

            case 'pubDate':
                return 'published';

            default:
                return $nodeName;
        }
    }

    /**
     * Get the correct handler for a whitelisted method name.
     *
     * @param string $nodeName The name of the method being called.
     * @param array  $args     Any arguments passed into that method.
     *
     * @throws SimplePieException
     *
     * @phpcs:disable Generic.Metrics.CyclomaticComplexity.MaxExceeded
     */
    public function getHandler(string $nodeName, array $args = [])
    {
        switch ($nodeName) {
            case 'base':
            case 'content':
            case 'id':
            case 'lang':
            case 'rights':
            case 'summary':
            case 'title':
                return $this->getScalarSingleValue($this, $nodeName, $args[0]);

            case 'published':
            case 'updated':
                return (new DateParser(
                    $this->getScalarSingleValue($this, $nodeName, $args[0])->getValue(),
                    $this->outputTimezone,
                    $this->createFromFormat
                ))->getDateTime();

            case 'author':
            case 'category':
            case 'contributor':
                return $this->getComplexMultipleValues($this, $nodeName, $args[0]);

            case 'link':
                $links = $this->getComplexMultipleValues($this, $nodeName, $args[0]);

                if (isset($args[1])) {
                    $relFilter = $args[1];

                    return \array_values(
                        \array_filter($links, static function (Link $link) use ($relFilter) {
                            return $relFilter === $link->getRel()->getValue();
                        })
                    );
                }

                return $links;

            default:
                throw new SimplePieException(
                    $this->getUnresolvableMessage($nodeName)
                );
        }
    }

    // @phpcs:enable
}