SignText.php

<?php
 
/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */
 
declare(strict_types=1);
 
namespace pocketmine\block\utils;
 
use pocketmine\color\Color;
use pocketmine\utils\Utils;
use function array_fill;
use function array_pad;
use function array_slice;
use function count;
use function explode;
use function is_int;
use function str_contains;
 
class SignText{
    public const LINE_COUNT = 4;
 
    private array $lines;
    private Color $baseColor;
    private bool $glowing;
 
    public function __construct(?array $lines = null, ?Color $baseColor = null, bool $glowing = false){
        $this->lines = array_fill(0, self::LINE_COUNT, "");
        if($lines !== null){
            if(count($lines) > self::LINE_COUNT){
                throw new \InvalidArgumentException("Expected at most 4 lines, got " . count($lines));
            }
            foreach($lines as $k => $line){
                $this->checkLineIndex($k);
                Utils::checkUTF8($line);
                if(str_contains($line, "\n")){
                    throw new \InvalidArgumentException("Line must not contain newlines");
                }
                //TODO: add length checks
                $this->lines[$k] = $line;
            }
        }
        $this->baseColor = $baseColor ?? new Color(0, 0, 0);
        $this->glowing = $glowing;
    }
 
    public static function fromBlob(string $blob, ?Color $baseColor = null, bool $glowing = false) : SignText{
        return new self(array_slice(array_pad(explode("\n", $blob), self::LINE_COUNT, ""), 0, self::LINE_COUNT), $baseColor, $glowing);
    }
 
    public function getLines() : array{
        return $this->lines;
    }
 
    private function checkLineIndex(int|string $index) : void{
        if(!is_int($index)){
            throw new \InvalidArgumentException("Index must be an integer");
        }
        if($index < 0 || $index >= self::LINE_COUNT){
            throw new \InvalidArgumentException("Line index is out of bounds");
        }
    }
 
    public function getLine(int $index) : string{
        $this->checkLineIndex($index);
        return $this->lines[$index];
    }
 
    public function getBaseColor() : Color{
        return $this->baseColor;
    }
 
    public function isGlowing() : bool{
        return $this->glowing;
    }
}