src/Identifiers/TableName.php

   1 <?php
   2
   3 declare(strict_types=1);
   4
   5 namespace PhpMyAdmin\Identifiers;
   6
   7 use Webmozart\Assert\Assert;
   8 use Webmozart\Assert\InvalidArgumentException;
   9
  10 /** @psalm-immutable */
  11 final class TableName implements Identifier
  12 {
  13     /**
  14      * @see https://dev.mysql.com/doc/refman/en/identifier-length.html
  15      * @see https://mariadb.com/kb/en/identifier-names/#maximum-length
  16      */
  17     private const MAX_LENGTH = 64;
  18
  19     /** @psalm-var non-empty-string */
  20     private string $name;
  21
  22     /** @throws InvalidTableName */
  23     private function __construct(mixed $name)
  24     {
  25         try {
  26             Assert::stringNotEmpty($name);
  27         } catch (InvalidArgumentException) {
  28             throw InvalidTableName::fromEmptyName();
  29         }
  30
  31         try {
  32             Assert::maxLength($name, self::MAX_LENGTH);
  33         } catch (InvalidArgumentException) {
  34             throw InvalidTableName::fromLongName(self::MAX_LENGTH);
  35         }
  36
  37         try {
  38             Assert::notEndsWith($name, ' ');
  39         } catch (InvalidArgumentException) {
  40             throw InvalidTableName::fromNameWithTrailingSpace();
  41         }
  42
  43         $this->name = $name;
  44     }
  45
  46     /**
  47      * @throws InvalidTableName
  48      *
  49      * @psalm-assert non-empty-string $name
  50      */
  51     public static function from(mixed $name): static
  52     {
  53         return new self($name);
  54     }
  55
  56     public static function tryFrom(mixed $name): static|null
  57     {
  58         try {
  59             return new self($name);
  60         } catch (InvalidTableName) {
  61             return null;
  62         }
  63     }
  64
  65     /** @psalm-return non-empty-string */
  66     public function getName(): string
  67     {
  68         return $this->name;
  69     }
  70
  71     /** @psalm-return non-empty-string */
  72     public function __toString(): string
  73     {
  74         return $this->name;
  75     }
  76 }