Char.php

Go to the documentation of this file.

<?php
 
namespace PlanetTeamSpeak\TeamSpeak3Framework\Helper;
 
use PlanetTeamSpeak\TeamSpeak3Framework\Exception\HelperException;

class Char
{
    protected string $char;

    public function __construct(string $char)
    {
        if (strlen($char) != 1) {
            throw new HelperException("char parameter may not contain more or less than one character");
        }
 
        $this->char = $char;
    }

    public function isLetter(): bool
    {
        return ctype_alpha($this->char);
    }

    public function isDigit(): bool
    {
        return ctype_digit($this->char);
    }

    public function isSpace(): bool
    {
        return ctype_space($this->char);
    }

    public function isMark(): bool
    {
        return ctype_punct($this->char);
    }

    public function isControl(): bool
    {
        return ctype_cntrl($this->char);
    }

    public function isPrintable(): bool
    {
        return ctype_print($this->char);
    }

    public function isNull(): bool
    {
        return $this->char === "\0";
    }

    public function isUpper(): bool
    {
        return $this->char === strtoupper($this->char);
    }

    public function isLower(): bool
    {
        return $this->char === strtolower($this->char);
    }

    public function toUpper(): Char
    {
        return ($this->isUpper()) ? $this : new self(strtoupper($this));
    }

    public function toLower(): Char
    {
        return ($this->isLower()) ? $this : new self(strtolower($this));
    }

    public function toAscii(): int
    {
        return ord($this->char);
    }

    public function toUnicode(): int
    {
        $h = ord($this->char[0]);
 
        if ($h <= 0x7F) {
            return $h;
        } elseif ($h < 0xC2) {
            return false;
        } elseif ($h <= 0xDF) {
            return ($h & 0x1F) << 6 | (ord($this->char[1]) & 0x3F);
        } elseif ($h <= 0xEF) {
            return ($h & 0x0F) << 12 | (ord($this->char[1]) & 0x3F) << 6 | (ord($this->char[2]) & 0x3F);
        } elseif ($h <= 0xF4) {
            return ($h & 0x0F) << 18 | (ord($this->char[1]) & 0x3F) << 12 | (ord($this->char[2]) & 0x3F) << 6 | (ord($this->char[3]) & 0x3F);
        } else {
            return -1;
        }
    }

    public function toHex(): string
    {
        return strtoupper(dechex($this->toAscii()));
    }

    public static function fromHex(string $hex): Char
    {
        if (strlen($hex) != 2) {
            throw new HelperException("given parameter '" . $hex . "' is not a valid hexadecimal number");
        }
 
        return new self(chr(hexdec($hex)));
    }

    public function toString(): string
    {
        return $this->char;
    }

    public function toInt(): int
    {
        return intval($this->char);
    }

    public function __toString()
    {
        return $this->char;
    }
}