mirror of
https://github.com/ramsey/uuid.git
synced 2026-06-24 17:35:57 +03:00
Brandon Morrison
aa18ce15d5
Coming from https://github.com/ramsey/uuid/pull/603, this is an attempt to fix the errors raised by the current phpstan settings. I went through each of the errors raised by phpstan with the following approach. - If a method is part of an `@immutable` class, we can consider it pure, assuming it only affects internal variables. - If a potentially pure method is calling a class's method that is only swapped during testing (and not during normal usage), then we can consider the calling method pure. - If a class is marked deprecated, don't bother with attempting to mark it pure or immutable.
122 lines
3.1 KiB
PHP
122 lines
3.1 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of the ramsey/uuid library
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*
|
|
* @copyright Copyright (c) Ben Ramsey <ben@benramsey.com>
|
|
* @license http://opensource.org/licenses/MIT MIT
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Ramsey\Uuid\Codec;
|
|
|
|
use Ramsey\Uuid\Builder\UuidBuilderInterface;
|
|
use Ramsey\Uuid\Exception\InvalidArgumentException;
|
|
use Ramsey\Uuid\Exception\InvalidUuidStringException;
|
|
use Ramsey\Uuid\Uuid;
|
|
use Ramsey\Uuid\UuidInterface;
|
|
|
|
use function bin2hex;
|
|
use function hex2bin;
|
|
use function implode;
|
|
use function sprintf;
|
|
use function str_replace;
|
|
use function strlen;
|
|
use function substr;
|
|
|
|
/**
|
|
* StringCodec encodes and decodes RFC 9562 (formerly RFC 4122) UUIDs
|
|
*
|
|
* @immutable
|
|
*/
|
|
class StringCodec implements CodecInterface
|
|
{
|
|
/**
|
|
* Constructs a StringCodec
|
|
*
|
|
* @param UuidBuilderInterface $builder The builder to use when encoding UUIDs
|
|
*/
|
|
public function __construct(private UuidBuilderInterface $builder)
|
|
{
|
|
}
|
|
|
|
public function encode(UuidInterface $uuid): string
|
|
{
|
|
/** @phpstan-ignore possiblyImpure.methodCall */
|
|
$hex = bin2hex($uuid->getFields()->getBytes());
|
|
|
|
/** @var non-empty-string */
|
|
return sprintf(
|
|
'%08s-%04s-%04s-%04s-%012s',
|
|
substr($hex, 0, 8),
|
|
substr($hex, 8, 4),
|
|
substr($hex, 12, 4),
|
|
substr($hex, 16, 4),
|
|
substr($hex, 20),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return non-empty-string
|
|
*/
|
|
public function encodeBinary(UuidInterface $uuid): string
|
|
{
|
|
/** @phpstan-ignore-next-line PHPStan complains that this is not a non-empty-string. */
|
|
return $uuid->getFields()->getBytes();
|
|
}
|
|
|
|
/**
|
|
* @throws InvalidUuidStringException
|
|
*
|
|
* @inheritDoc
|
|
*/
|
|
public function decode(string $encodedUuid): UuidInterface
|
|
{
|
|
/** @phpstan-ignore possiblyImpure.methodCall */
|
|
return $this->builder->build($this, $this->getBytes($encodedUuid));
|
|
}
|
|
|
|
public function decodeBytes(string $bytes): UuidInterface
|
|
{
|
|
if (strlen($bytes) !== 16) {
|
|
throw new InvalidArgumentException('$bytes string should contain 16 characters.');
|
|
}
|
|
|
|
return $this->builder->build($this, $bytes);
|
|
}
|
|
|
|
/**
|
|
* Returns the UUID builder
|
|
*/
|
|
protected function getBuilder(): UuidBuilderInterface
|
|
{
|
|
return $this->builder;
|
|
}
|
|
|
|
/**
|
|
* Returns a byte string of the UUID
|
|
*/
|
|
protected function getBytes(string $encodedUuid): string
|
|
{
|
|
$parsedUuid = str_replace(['urn:', 'uuid:', 'URN:', 'UUID:', '{', '}', '-'], '', $encodedUuid);
|
|
|
|
$components = [
|
|
substr($parsedUuid, 0, 8),
|
|
substr($parsedUuid, 8, 4),
|
|
substr($parsedUuid, 12, 4),
|
|
substr($parsedUuid, 16, 4),
|
|
substr($parsedUuid, 20),
|
|
];
|
|
|
|
if (!Uuid::isValid(implode('-', $components))) {
|
|
throw new InvalidUuidStringException('Invalid UUID string: ' . $encodedUuid);
|
|
}
|
|
|
|
return (string) hex2bin($parsedUuid);
|
|
}
|
|
}
|