GeneratorStream::isSeekable() - Code Metrics - Inspection of "Lazy Rendering" - yiisoft/yii-demo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#59)

unknown

created 2020-02-25 08:42 UTC

GeneratorStream::isSeekable() A

↳ Parent: GeneratorStream

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace App\LazyRendering\Http;

use Generator;
use Psr\Http\Message\StreamInterface;

class GeneratorStream implements StreamInterface
{
    public const READ_MODE_AS_IS = 1;
    public const READ_MODE_FIRST_YIELD = 2;

    private int $readMode = self::READ_MODE_AS_IS;

    private ?Generator $stream;

    private bool $seekable = false;

    private bool $readable = false;

    private bool $writable = false;

    private ?int $size = null;

    private int $caret = 0;

    private bool $started = false;


    public function __construct(Generator $body)
    {
        $this->stream = $body;
        $this->seekable = false;
        $this->readable = true;
        $this->writable = false;
    }

    public function __toString(): string
    {
        try {
            if ($this->isSeekable()) {
                $this->seek(0);
            }

            return $this->getContents();
        } catch (\Exception $e) {
            return '';
        }
    }

    public function close(): void
    {
        if (isset($this->stream)) {
            $this->detach();
        }
    }

    public function detach()
    {
        if (!isset($this->stream)) {
            return null;
        }
        $result = $this->stream;
        unset($this->stream);
        $this->size = null;
        $this->caret = 0;
        $this->started = false;
        $this->readable = $this->writable = $this->seekable = false;
        return $result;

    }

    public function getSize(): ?int
    {
        if (null !== $this->size) {
            return $this->size;
        }

        if (!isset($this->stream)) {
            return null;
        }

        return null;
    }

    public function tell(): int
    {
        return $this->caret;
    }

    public function eof(): bool
    {
        return $this->stream === null || !$this->stream->valid();
    }

    public function isSeekable(): bool
    {
        return $this->seekable;
    }

    public function seek($offset, $whence = \SEEK_SET): void
    {
        if (!$this->seekable) {
            throw new \RuntimeException('Stream is not seekable');
        }
    }

    public function rewind(): void
    {
        $this->stream->rewind();
                       rewind();
        $this->caret = 0;
        $this->started = false;
    }

    public function isWritable(): bool
    {
        return $this->writable;
    }

    public function write($string): int
    {
        if (!$this->writable) {
            throw new \RuntimeException('Cannot write to a non-writable stream');
        }
        return 0;
    }

    public function isReadable(): bool
    {
        return $this->readable;
    }

    public function setReadMode(int $mode): void
    {
        $this->readMode = $mode;
    }

    public function read($length): string
    {
        if (!$this->readable) {
            throw new \RuntimeException('Cannot read from non-readable stream');
        }
        if ($this->eof()) {
            throw new \RuntimeException('Cannot read from ended stream');
        }
        if (!$this->started) {
            $this->started = true;
            $read = (string)$this->stream->current();
            $this->caret += strlen($read);
            return $read;
        }
        if ($this->readMode === self::READ_MODE_FIRST_YIELD) {
            $content = '';
            while (!$this->eof()) {
                $content .= $this->stream->send(null);
            }
            return $content;
        }
        $read = (string)$this->stream->send(null);
        $this->caret += strlen($read);
        if ($this->eof()) {
            $this->size = $this->caret;
        }
        return $read;
    }

    public function getContents(): string
    {
        if (!isset($this->stream)) {
            throw new \RuntimeException('Unable to read stream contents');
        }
        $content = '';
        while (!$this->eof()) {
            $content .= $this->read(PHP_INT_MAX);
        }
        return $content;
    }

    public function getMetadata($key = null)
    {
        if (!isset($this->stream)) {
            return $key ? null : [];
        }

        $meta = [
            'seekable' => $this->seekable,
            'eof' => $this->eof(),
        ];

        if (null === $key) {
            return $meta;
        }

        return $meta[$key] ?? null;
    }
}


yiisoft / yii-demo

Pull Request — master (#59)

GeneratorStream::isSeekable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like