AbstractTokenStream.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\Token;
 
abstract class ‪AbstractTokenStream implements ‪TokenStreamInterface
{
    protected array ‪$tokens = [];
    protected int ‪$currentIndex = -1;
 
    public function ‪__toString(): string
    {
        $source = '';
        $this->‪reset();
        while ($token = $this->‪getNext()) {
            $source .= $token;
        }
        return $source;
    }
 
    final public function ‪__serialize(): array
    {
        return $this->‪serialize();
    }
 
    protected function ‪serialize(): array
    {
        $result['tokens'] = ‪$this->tokens;
        return $result;
    }
 
    public function ‪append(‪TokenInterface $token): self
    {
        $this->tokens[] = $token;
        return $this;
    }
 
    public function ‪isEmpty(): bool
    {
        return empty($this->tokens);
    }
 
    public function ‪reset(): static
    {
        $this->currentIndex = -1;
        return $this;
    }
 
    public function ‪getNext(): ?‪TokenInterface
    {
        $this->currentIndex++;
        return $this->tokens[‪$this->currentIndex] ?? null;
    }
 
    public function ‪peekNext(): ?‪TokenInterface
    {
        return $this->tokens[$this->currentIndex + 1] ?? null;
    }
 
    public function ‪getAll(): array
    {
        return ‪$this->tokens;
    }
 
    public function ‪setAll(array ‪$tokens): self
    {
        $this->tokens = ‪$tokens;
        return $this;
    }
}