SimplePie\Middleware\AbstractMiddleware

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	addArrayProperty()	0	4	2
A	get()	0	4	1

<?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\Middleware;

use SimplePie\Configuration as C;
use SimplePie\Mixin as Tr;

/**
 * The base middleware class that all other middleware classes extend from. It handles low-level functionality that is
 * shared across all middleware classes.
 */
abstract class AbstractMiddleware implements C\SetLoggerInterface
{
    use Tr\LoggerTrait;

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

    /**
     * A callable which is used to determine whether or not to run this middleware.
     *
     * @var callable
     */
    protected $fn;

    /**
     * Constructs a new instance of this class.
     *
     * Accepts a callable with the following function signature:
     *
     * ```
     * function () {}
     * ```
     *
     * @param callable|null $fn A callable which is used to determine whether or not to run this
     *                          middleware. A value of `true` means that the middleware should run.
     *                          A value of `false` means that the middleware should NOT run, By
     *                          default, the middleware will run.
     */
    public function __construct(?callable $fn = null)
    {
        $this->fn = $fn ?: static function () {
            return true;
        };
    }

    /**
     * Checks whether or not a particular property exists on an object, and if not, instantiates it as an array.
     *
     * @param mixed  $object   An object that you can add ad-hoc properties to. Preferably a `stdClass` object.
     * @param string $property The name of the property to check and/or add.
     */
    public function addArrayProperty(&$object, string $property): void
    {
        if (!isset($object->{$property})) {
            $object->{$property} = [];
        }
    }

    /**
     * Return the value of an associative array key, if it exists. If not, return $default.
     *
     * @param array  $arr     The associative array to check.
     * @param string $key     The key in the associative array to return the value for.
     * @param mixed  $default The default value to return if there is no value. The default value is `null`.
     */
    public function get(array $arr, string $key, $default = null)
    {
        return $arr[$key]
            ?? $default;
    }
}