SimplePie\UtilityPack\Parser\AbstractParser

Complexity

Total Complexity

2

Size/Duplication

Total Lines	27
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	readStream()	0	3	1
A	__toString()	0	3	1

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

declare(strict_types=1);

namespace SimplePie\UtilityPack\Parser;

use Psr\Http\Message\StreamInterface;

/**
 * The base parser class that all other parser classes extend from. It handles low-level functionality that is shared
 * across all parser classes.
 */
abstract class AbstractParser implements ParserInterface
{
    /**
     * Returns an opaque string representing the object.
     *
     * Note: Use of MD5 here is not cryptographically significant.
     *
     * @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
     */
    public function __toString(): string
    {
        return \sprintf('<%s: resource %s>', \get_called_class(), \md5(\spl_object_hash($this)));
    }

    /**
     * Reads the contents of the stream resource.
     *
     * @param StreamInterface $stream A PSR-7 `StreamInterface` which is typically returned by the
     *                                `getBody()` method of a `ResponseInterface` class.
     *
     * @throws \RuntimeException
     *
     * @return string The raw contents of the steam resource.
     */
    public function readStream(StreamInterface $stream): string
    {
        return $stream->getContents();
    }
}