LineStream.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\TypoScript\Tokenizer\Line;
 
final class ‪LineStream
{
    private array ‪$lines = [];
    protected int ‪$currentIndex = -1;
 
    public function ‪__toString(): string
    {
        $source = '';
        foreach ($this->‪getNextLine() as $line) {
            // We do *not* implement __toString() on lines since this is a
            // backend thing only, and we do not want to accidentally stringify
            // lines based on the full stream anywhere.
            $source .= $line->getTokenStream()->reset();
        }
        return $source;
    }
 
    final public function ‪__serialize(): array
    {
        return [
            'lines' => ‪$this->lines,
        ];
    }
 
    public function ‪append(‪LineInterface $line): self
    {
        $this->lines[] = $line;
        return $this;
    }
 
    public function ‪isEmpty(): bool
    {
        return empty($this->lines);
    }
 
    public function ‪getNextLine(): iterable
    {
        foreach ($this->lines as $child) {
            yield $child;
        }
    }
 
    public function ‪reset(): self
    {
        $this->currentIndex = -1;
        return $this;
    }
 
    public function ‪getNext(): ?‪LineInterface
    {
        $this->currentIndex++;
        return $this->lines[‪$this->currentIndex] ?? null;
    }
 
    public function ‪peekNext(): ?‪LineInterface
    {
        return $this->lines[$this->currentIndex + 1] ?? null;
    }
}