phpmyadmin/libraries/classes/Dbal/TableName.php
Maurício Meneghini Fauth 6792b17e72
Add tryFromValue method to DatabaseName and TableName classes
Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
2022-09-18 16:32:42 -03:00

94 lines
1.9 KiB
PHP

<?php
declare(strict_types=1);
namespace PhpMyAdmin\Dbal;
use Stringable;
use Webmozart\Assert\Assert;
use Webmozart\Assert\InvalidArgumentException;
/**
* @psalm-immutable
*/
final class TableName implements Stringable
{
/**
* @see https://dev.mysql.com/doc/refman/en/identifier-length.html
* @see https://mariadb.com/kb/en/identifier-names/#maximum-length
*/
private const MAX_LENGTH = 64;
/**
* @var string
* @psalm-var non-empty-string
*/
private $name;
/**
* @param mixed $name
*
* @throws InvalidTableName
*/
private function __construct($name)
{
try {
Assert::stringNotEmpty($name);
} catch (InvalidArgumentException $exception) {
throw InvalidTableName::fromEmptyName();
}
try {
Assert::maxLength($name, self::MAX_LENGTH);
} catch (InvalidArgumentException $exception) {
throw InvalidTableName::fromLongName(self::MAX_LENGTH);
}
try {
Assert::notEndsWith($name, ' ');
} catch (InvalidArgumentException $exception) {
throw InvalidTableName::fromNameWithTrailingSpace();
}
$this->name = $name;
}
/**
* @param mixed $name
*
* @throws InvalidTableName
*/
public static function fromValue($name): self
{
return new self($name);
}
/**
* @param mixed $name
*/
public static function tryFromValue($name): ?self
{
try {
return new self($name);
} catch (InvalidTableName $exception) {
return null;
}
}
/**
* @psalm-return non-empty-string
*/
public function getName(): string
{
return $this->name;
}
/**
* @psalm-return non-empty-string
*/
public function __toString(): string
{
return $this->name;
}
}