SimplePie\Mixin\DeepTypeTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Test Coverage

Coverage

80%

Importance

Changes	4
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getComplexMultipleValues()	0	14	2
A	getComplexSingleValue()	0	15	2
A	getScalarSingleValue()	0	14	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\Mixin;

use SimplePie\Type\Node;
use SimplePie\Type\TypeInterface;
use Skyzyx\UtilityPack\Types;

The type Skyzyx\UtilityPack\Types was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Shared code for working with deeply-nested elements for types.
 */
trait DeepTypeTrait
{
    /**
     * The preferred alias for a particular XML Namespace URI.
     *
     * @var string
     */
    protected $namespaceAlias;

    /**
     * Retrieves nodes that are simple scalars, and there is only one allowed value.
     *
     * @param object      $root           The root node for performing the lookup. Expected to be either a `stdClass`
     *                                    (for `Feed`), or an `SimplePie\Type\Entry` instance.
     * @param string      $nodeName       The name of the tree node to retrieve. Available tree nodes can be viewed by
     *                                    looking at the response from `getRoot()`.
     * @param string|null $namespaceAlias The XML namespace alias to apply.
     *
     * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
     */
    protected function getScalarSingleValue(
        object $root,
        string $nodeName,
        ?string $namespaceAlias = null
    ): Node {
        // @phpcs:enable

        $alias = $namespaceAlias ?? $this->namespaceAlias;

        if (isset($root->{$nodeName}[$alias])) {
            return $root->{$nodeName}[$alias];
        }

        return new Node();
    }

    /**
     * Retrieves nodes that are complex types, and there is only one allowed value.
     *
     * @param object      $root           The root node for performing the lookup. Expected to be either a `stdClass`
     *                                    (for `Feed`), or an `SimplePie\Type\Entry` instance.
     * @param string      $nodeName       The name of the tree node to retrieve. Available tree nodes can be viewed by
     *                                    looking at the response from `getRoot()`.
     * @param string      $className      The class name to instantiate when there is not a defined value.
     * @param string|null $namespaceAlias The XML namespace alias to apply.
     *
     * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
     */
    protected function getComplexSingleValue(
        object $root,
        string $nodeName,
        string $className,
        ?string $namespaceAlias = null
    ): TypeInterface {
        // @phpcs:enable

        $alias = $namespaceAlias ?? $this->namespaceAlias;

        if (isset($root->{$nodeName}[$alias])) {
            return new $className($root->{$nodeName}[$alias]->getNode());
        }

        return new $className();
    }

    /**
     * Retrieves nodes that are complex types, and there may be are more than one value.
     *
     * @param object      $root           The root node for performing the lookup. Expected to be either a `stdClass`
     *                                    (for `Feed`), or an `SimplePie\Type\Entry` instance.
     * @param string      $nodeName       The name of the tree node to retrieve. Available tree nodes can be viewed by
     *                                    looking at the response from `getRoot()`.
     * @param string|null $namespaceAlias The XML namespace alias to apply.
     *
     * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
     */
    protected function getComplexMultipleValues(
        object $root,
        string $nodeName,
        ?string $namespaceAlias = null
    ): iterable {
        // @phpcs:enable

        $alias = $namespaceAlias ?? $this->namespaceAlias;

        if (isset($root->{$nodeName}[$alias])) {
            return $root->{$nodeName}[$alias];
        }

        return [];
    }
}