contrib/php-uuid
1
0
Fork 0
mirror of https://github.com/ramsey/uuid.git synced 2026-06-13 15:46:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore(deps-dev): remove Psalm

Browse Source
This commit is contained in:
Ben Ramsey
2025-05-25 14:53:53 -05:00
parent c60d906a39
commit 691c2c816e
90 changed files with 153 additions and 1741 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitattributes
-2
View File
@@ -19,8 +19,6 @@
/phpstan-tests.neon export-ignore
/phpstan.neon.dist export-ignore
/phpunit.xml.dist export-ignore
/psalm-baseline.xml export-ignore
/psalm.xml export-ignore
/resources/ export-ignore
/SECURITY.md export-ignore
/tests/ export-ignore
.github/workflows/continuous-integration.yml
-3
View File
@@ -63,9 +63,6 @@ jobs:
- name: "Statically analyze code (PHPStan)"
run: "composer phpstan -- --ansi"
- name: "Statically analyze code (Psalm)"
run: "composer psalm -- --shepherd"
benchmark:
name: "Benchmark"
needs: ["coding-standards", "static-analysis"]
CONTRIBUTING.md
+2 -3
View File
@@ -129,9 +129,8 @@ composer phpcbf
### Static Analysis
This project uses a combination of [PHPStan](https://github.com/phpstan/phpstan)
and [Psalm](https://github.com/vimeo/psalm) to provide static analysis of PHP
code.
This project uses [PHPStan](https://github.com/phpstan/phpstan) to provide
static analysis of PHP code.
CaptainHook will run static analysis checks before committing.
README.md
-1
View File
@@ -11,7 +11,6 @@
<a href="https://github.com/ramsey/uuid/blob/4.x/LICENSE"><img src="https://img.shields.io/packagist/l/ramsey/uuid.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a>
<a href="https://github.com/ramsey/uuid/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/actions/workflow/status/ramsey/uuid/continuous-integration.yml?branch=4.x&logo=github&style=flat-square" alt="Build Status"></a>
<a href="https://app.codecov.io/gh/ramsey/uuid/branch/4.x"><img src="https://img.shields.io/codecov/c/github/ramsey/uuid/4.x?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
<a href="https://shepherd.dev/github/ramsey/uuid"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fuuid%2Fcoverage" alt="Psalm Type Coverage"></a>
</p>
ramsey/uuid is a PHP library for generating and working with universally unique
composer.json
+2 -8
View File
@@ -32,8 +32,7 @@
"phpstan/phpstan-phpunit": "^1.1",
"phpunit/phpunit": "^8.5 || ^9",
"slevomat/coding-standard": "^8.4",
"squizlabs/php_codesniffer": "^3.5",
"vimeo/psalm": "^4.9"
"squizlabs/php_codesniffer": "^3.5"
},
"replace": {
"rhumsaa/uuid": "self.version"
@@ -77,10 +76,7 @@
}
},
"scripts": {
"analyze": [
"@phpstan",
"@psalm"
],
"analyze": "@phpstan",
"build:clean": "git clean -fX build/",
"lint": "parallel-lint src tests",
"lint:paths": "parallel-lint",
@@ -93,13 +89,11 @@
],
"phpunit": "phpunit --verbose --colors=always",
"phpunit-coverage": "phpunit --verbose --colors=always --coverage-html build/coverage",
"psalm": "psalm --show-info=false --config=psalm.xml",
"test": [
"@lint",
"@phpbench",
"@phpcs",
"@phpstan",
"@psalm",
"@phpunit"
]
}
composer.lock
Generated
+1 -1050
View File
File diff suppressed because it is too large Load Diff
psalm-baseline.xml
-175
View File
@@ -1,175 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<files psalm-version="4.27.0@faf106e717c37b8c81721845dba9de3d8deed8ff">
<file src="src/Builder/DegradedUuidBuilder.php">
<DeprecatedClass occurrences="3">
<code>DegradedUuid</code>
<code>new DegradedTimeConverter()</code>
</DeprecatedClass>
<ImpureVariable occurrences="2">
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Builder/FallbackBuilder.php">
<ImpureMethodCall occurrences="1"/>
<ImpureVariable occurrences="1">
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Converter/Number/BigNumberConverter.php">
<ImpureVariable occurrences="2">
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Converter/Number/DegradedNumberConverter.php">
<DeprecatedClass occurrences="1">
<code>BigNumberConverter</code>
</DeprecatedClass>
</file>
<file src="src/Converter/Number/GenericNumberConverter.php">
<ImpureVariable occurrences="2">
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Converter/Time/DegradedTimeConverter.php">
<DeprecatedClass occurrences="1">
<code>BigNumberTimeConverter</code>
</DeprecatedClass>
</file>
<file src="src/FeatureSet.php">
<PropertyNotSetInConstructor occurrences="5">
<code>$calculator</code>
<code>$dceSecurityGenerator</code>
<code>$numberConverter</code>
<code>$timeConverter</code>
<code>$timeGenerator</code>
</PropertyNotSetInConstructor>
</file>
<file src="src/Generator/PeclUuidNameGenerator.php">
<ImpureFunctionCall occurrences="3">
<code>uuid_generate_md5</code>
<code>uuid_generate_sha1</code>
<code>uuid_parse</code>
</ImpureFunctionCall>
</file>
<file src="src/Guid/GuidBuilder.php">
<ImpureVariable occurrences="3">
<code>$this</code>
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Nonstandard/UuidBuilder.php">
<ImpureVariable occurrences="3">
<code>$this</code>
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Provider/Dce/SystemDceSecurityProvider.php">
<ForbiddenCode occurrences="5">
<code>shell_exec('id -g')</code>
<code>shell_exec('id -u')</code>
<code>shell_exec('net user %username% | findstr /b /i "Local Group Memberships"')</code>
<code>shell_exec('whoami /user /fo csv /nh')</code>
<code>shell_exec('wmic group get name,sid | findstr /b /i ' . escapeshellarg($firstGroup))</code>
</ForbiddenCode>
</file>
<file src="src/Provider/Node/SystemNodeProvider.php">
<MixedArgument occurrences="1">
<code>$macs</code>
</MixedArgument>
<MixedArrayAssignment occurrences="1">
<code>$macs[]</code>
</MixedArrayAssignment>
</file>
<file src="src/Rfc4122/UuidBuilder.php">
<ImpureVariable occurrences="21">
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
<file src="src/Rfc4122/UuidV6.php">
<DeprecatedClass occurrences="1">
<code>NonstandardUuidV6</code>
</DeprecatedClass>
</file>
<file src="src/Type/Hexadecimal.php">
<UnusedMethodCall occurrences="1">
<code>unserialize</code>
</UnusedMethodCall>
</file>
<file src="src/Type/Integer.php">
<UnusedMethodCall occurrences="1">
<code>unserialize</code>
</UnusedMethodCall>
</file>
<file src="src/Type/Time.php">
<UnusedMethodCall occurrences="1">
<code>__construct</code>
</UnusedMethodCall>
</file>
<file src="src/Uuid.php">
<DeprecatedTrait occurrences="1">
<code>DeprecatedUuidMethodsTrait</code>
</DeprecatedTrait>
<ImpureMethodCall occurrences="6">
<code>getFactory</code>
<code>getFactory</code>
<code>getFactory</code>
<code>getFactory</code>
<code>getFactory</code>
<code>getFactory</code>
</ImpureMethodCall>
<UnusedMethodCall occurrences="1">
<code>unserialize</code>
</UnusedMethodCall>
</file>
<file src="src/UuidFactory.php">
<ImpurePropertyFetch occurrences="7">
<code>$this-&gt;codec</code>
<code>$this-&gt;codec</code>
<code>$this-&gt;codec</code>
<code>$this-&gt;isDefaultFeatureSet</code>
<code>$this-&gt;nameGenerator</code>
<code>$this-&gt;numberConverter</code>
<code>$this-&gt;uuidBuilder</code>
</ImpurePropertyFetch>
<ImpureVariable occurrences="13">
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
<code>$this</code>
</ImpureVariable>
</file>
</files>
psalm.xml
-22
View File
@@ -1,22 +0,0 @@
<?xml version="1.0"?>
<psalm xmlns="https://getpsalm.org/schema/config"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
errorLevel="1"
cacheDirectory="./build/cache/psalm"
errorBaseline="psalm-baseline.xml"
phpVersion="8.1">
<projectFiles>
<directory name="./src" />
<directory name="./tests/static-analysis"/>
<ignoreFiles>
<file name="./tests/static-analysis/stubs.php"/>
</ignoreFiles>
</projectFiles>
<stubs>
<file name="./tests/static-analysis/stubs.php"/>
</stubs>
</psalm>
src/BinaryUtils.php
-4
View File
@@ -28,8 +28,6 @@ class BinaryUtils
* variant is applied
*
* @return int The 16-bit clock sequence multiplexed with the UUID variant
*
* @psalm-pure
*/
public static function applyVariant(int $clockSeq): int
{
@@ -50,8 +48,6 @@ class BinaryUtils
*
* @return int The 16-bit time_hi field of the timestamp multiplexed with
* the UUID version number
*
* @psalm-pure
*/
public static function applyVersion(int $timeHi, int $version): int
{
src/Builder/BuilderCollection.php
+1 -9
View File
@@ -27,7 +27,7 @@ use Traversable;
/**
* A collection of UuidBuilderInterface objects
*
* @deprecated this class has been deprecated, and will be removed in 5.0.0. The use-case for this class comes from
* @deprecated this class has been deprecated and will be removed in 5.0.0. The use-case for this class comes from
* a pre-`phpstan/phpstan` and pre-`vimeo/psalm` ecosystem, in which type safety had to be mostly enforced
* at runtime: that is no longer necessary, now that you can safely verify your code to be correct, and use
* more generic types like `iterable<T>` instead.
@@ -41,11 +41,6 @@ class BuilderCollection extends AbstractCollection
return UuidBuilderInterface::class;
}
/**
* @psalm-mutation-free
* @psalm-suppress ImpureMethodCall
* @psalm-suppress InvalidTemplateParam
*/
public function getIterator(): Traversable
{
return parent::getIterator();
@@ -56,9 +51,6 @@ class BuilderCollection extends AbstractCollection
*
* @param string $serialized The serialized PHP string to unserialize into
* a UuidInterface instance
*
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @psalm-suppress RedundantConditionGivenDocblockType
*/
public function unserialize($serialized): void
{
src/Builder/DefaultUuidBuilder.php
+1 -1
View File
@@ -19,7 +19,7 @@ use Ramsey\Uuid\Rfc4122\UuidBuilder as Rfc4122UuidBuilder;
/**
* @deprecated Transition to {@see Rfc4122UuidBuilder}.
*
* @psalm-immutable
* @immutable
*/
class DefaultUuidBuilder extends Rfc4122UuidBuilder
{
src/Builder/DegradedUuidBuilder.php
+1 -3
View File
@@ -26,7 +26,7 @@ use Ramsey\Uuid\UuidInterface;
* @deprecated DegradedUuid instances are no longer necessary to support 32-bit
* systems. Transition to {@see DefaultUuidBuilder}.
*
* @psalm-immutable
* @immutable
*/
class DegradedUuidBuilder implements UuidBuilderInterface
{
@@ -52,8 +52,6 @@ class DegradedUuidBuilder implements UuidBuilderInterface
* @param string $bytes The byte string from which to construct a UUID
*
* @return DegradedUuid The DegradedUuidBuild returns an instance of Ramsey\Uuid\DegradedUuid
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface
{
src/Builder/FallbackBuilder.php
+1 -3
View File
@@ -23,7 +23,7 @@ use Ramsey\Uuid\UuidInterface;
* FallbackBuilder builds a UUID by stepping through a list of UUID builders
* until a UUID can be constructed without exceptions
*
* @psalm-immutable
* @immutable
*/
class FallbackBuilder implements UuidBuilderInterface
{
@@ -42,8 +42,6 @@ class FallbackBuilder implements UuidBuilderInterface
* @param string $bytes The byte string from which to construct a UUID
*
* @return UuidInterface an instance of a UUID object
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface
{
src/Builder/UuidBuilderInterface.php
+1 -3
View File
@@ -20,7 +20,7 @@ use Ramsey\Uuid\UuidInterface;
/**
* A UUID builder builds instances of UuidInterface
*
* @psalm-immutable
* @immutable
*/
interface UuidBuilderInterface
{
@@ -32,8 +32,6 @@ interface UuidBuilderInterface
*
* @return UuidInterface Implementations may choose to return more specific
* instances of UUIDs that implement UuidInterface
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface;
}
src/Codec/CodecInterface.php
+3 -7
View File
@@ -19,7 +19,7 @@ use Ramsey\Uuid\UuidInterface;
/**
* A codec encodes and decodes a UUID according to defined rules
*
* @psalm-immutable
* @immutable
*/
interface CodecInterface
{
@@ -29,9 +29,7 @@ interface CodecInterface
* @param UuidInterface $uuid The UUID for which to create a hexadecimal
* string representation
*
* @return string Hexadecimal string representation of a UUID
*
* @psalm-return non-empty-string
* @return non-empty-string Hexadecimal string representation of a UUID
*/
public function encode(UuidInterface $uuid): string;
@@ -41,9 +39,7 @@ interface CodecInterface
* @param UuidInterface $uuid The UUID for which to create a binary string
* representation
*
* @return string Binary string representation of a UUID
*
* @psalm-return non-empty-string
* @return non-empty-string Binary string representation of a UUID
*/
public function encodeBinary(UuidInterface $uuid): string;
src/Codec/GuidStringCodec.php
+1 -1
View File
@@ -26,7 +26,7 @@ use function substr;
*
* @see Guid
*
* @psalm-immutable
* @immutable
*/
class GuidStringCodec extends StringCodec
{
src/Codec/OrderedTimeCodec.php
+3 -6
View File
@@ -41,7 +41,7 @@ use function substr;
*
* @link https://www.percona.com/blog/2014/12/19/store-uuid-optimized-way/ Storing UUID Values in MySQL
*
* @psalm-immutable
* @immutable
*/
class OrderedTimeCodec extends StringCodec
{
@@ -49,10 +49,7 @@ class OrderedTimeCodec extends StringCodec
* Returns a binary string representation of a UUID, with the timestamp
* fields rearranged for optimized storage
*
* @inheritDoc
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function encodeBinary(UuidInterface $uuid): string
{
@@ -67,7 +64,7 @@ class OrderedTimeCodec extends StringCodec
$bytes = $uuid->getFields()->getBytes();
/** @phpstan-ignore-next-line PHPStan complains that this is not a non-empty-string. */
/** @var non-empty-string */
return $bytes[6] . $bytes[7]
. $bytes[4] . $bytes[5]
. $bytes[0] . $bytes[1] . $bytes[2] . $bytes[3]
src/Codec/StringCodec.php
+2 -4
View File
@@ -33,7 +33,7 @@ use function substr;
*
* @link http://tools.ietf.org/html/rfc4122
*
* @psalm-immutable
* @immutable
*/
class StringCodec implements CodecInterface
{
@@ -62,9 +62,7 @@ class StringCodec implements CodecInterface
}
/**
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function encodeBinary(UuidInterface $uuid): string
{
src/Codec/TimestampFirstCombCodec.php
+3 -7
View File
@@ -46,14 +46,12 @@ use function substr_replace;
*
* @link https://www.informit.com/articles/printerfriendly/25862 The Cost of GUIDs as Primary Keys
*
* @psalm-immutable
* @immutable
*/
class TimestampFirstCombCodec extends StringCodec
{
/**
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function encode(UuidInterface $uuid): string
{
@@ -70,9 +68,7 @@ class TimestampFirstCombCodec extends StringCodec
}
/**
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function encodeBinary(UuidInterface $uuid): string
{
src/Codec/TimestampLastCombCodec.php
+1 -1
View File
@@ -44,7 +44,7 @@ namespace Ramsey\Uuid\Codec;
*
* @link https://www.informit.com/articles/printerfriendly/25862 The Cost of GUIDs as Primary Keys
*
* @psalm-immutable
* @immutable
*/
class TimestampLastCombCodec extends StringCodec
{
src/Converter/Number/BigNumberConverter.php
+1 -9
View File
@@ -23,7 +23,7 @@ use Ramsey\Uuid\Math\BrickMathCalculator;
*
* @deprecated Transition to {@see GenericNumberConverter}.
*
* @psalm-immutable
* @immutable
*/
class BigNumberConverter implements NumberConverterInterface
{
@@ -34,19 +34,11 @@ class BigNumberConverter implements NumberConverterInterface
$this->converter = new GenericNumberConverter(new BrickMathCalculator());
}
/**
* @inheritDoc
* @psalm-pure
*/
public function fromHex(string $hex): string
{
return $this->converter->fromHex($hex);
}
/**
* @inheritDoc
* @psalm-pure
*/
public function toHex(string $number): string
{
return $this->converter->toHex($number);
src/Converter/Number/DegradedNumberConverter.php
+1 -1
View File
@@ -18,7 +18,7 @@ namespace Ramsey\Uuid\Converter\Number;
* @deprecated DegradedNumberConverter is no longer necessary for converting
* numbers on 32-bit systems. Transition to {@see GenericNumberConverter}.
*
* @psalm-immutable
* @immutable
*/
class DegradedNumberConverter extends BigNumberConverter
{
src/Converter/Number/GenericNumberConverter.php
+1 -15
View File
@@ -22,7 +22,7 @@ use Ramsey\Uuid\Type\Integer as IntegerObject;
* GenericNumberConverter uses the provided calculator to convert decimal
* numbers to and from hexadecimal values
*
* @psalm-immutable
* @immutable
*/
class GenericNumberConverter implements NumberConverterInterface
{
@@ -30,25 +30,11 @@ class GenericNumberConverter implements NumberConverterInterface
{
}
/**
* @inheritDoc
* @psalm-pure
* @psalm-return numeric-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
*/
public function fromHex(string $hex): string
{
return $this->calculator->fromBase($hex, 16)->toString();
}
/**
* @inheritDoc
* @psalm-pure
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
*/
public function toHex(string $number): string
{
/** @phpstan-ignore-next-line PHPStan complains that this is not a non-empty-string. */
src/Converter/NumberConverterInterface.php
+5 -13
View File
@@ -18,24 +18,20 @@ namespace Ramsey\Uuid\Converter;
* A number converter converts UUIDs from hexadecimal characters into
* representations of integers and vice versa
*
* @psalm-immutable
* @immutable
*/
interface NumberConverterInterface
{
/**
* Converts a hexadecimal number into an string integer representation of
* Converts a hexadecimal number into a string integer representation of
* the number
*
* The integer representation returned is a string representation of the
* integer, to accommodate unsigned integers greater than PHP_INT_MAX.
* integer to accommodate unsigned integers greater than PHP_INT_MAX.
*
* @param string $hex The hexadecimal string representation to convert
*
* @return string String representation of an integer
*
* @psalm-return numeric-string
*
* @psalm-pure
* @return numeric-string String representation of an integer
*/
public function fromHex(string $hex): string;
@@ -47,11 +43,7 @@ interface NumberConverterInterface
* must be a numeric string to accommodate unsigned integers greater
* than PHP_INT_MAX.
*
* @return string Hexadecimal string
*
* @psalm-return non-empty-string
*
* @psalm-pure
* @return non-empty-string Hexadecimal string
*/
public function toHex(string $number): string;
}
src/Converter/Time/BigNumberTimeConverter.php
+1 -1
View File
@@ -25,7 +25,7 @@ use Ramsey\Uuid\Type\Time;
*
* @deprecated Transition to {@see GenericTimeConverter}.
*
* @psalm-immutable
* @immutable
*/
class BigNumberTimeConverter implements TimeConverterInterface
{
src/Converter/Time/DegradedTimeConverter.php
+1 -1
View File
@@ -18,7 +18,7 @@ namespace Ramsey\Uuid\Converter\Time;
* @deprecated DegradedTimeConverter is no longer necessary for converting
* time on 32-bit systems. Transition to {@see GenericTimeConverter}.
*
* @psalm-immutable
* @immutable
*/
class DegradedTimeConverter extends BigNumberTimeConverter
{
src/Converter/Time/GenericTimeConverter.php
+1 -1
View File
@@ -30,7 +30,7 @@ use const STR_PAD_LEFT;
* GenericTimeConverter uses the provided calculator to calculate and convert
* time values
*
* @psalm-immutable
* @immutable
*/
class GenericTimeConverter implements TimeConverterInterface
{
src/Converter/Time/PhpTimeConverter.php
+1 -2
View File
@@ -38,7 +38,7 @@ use const STR_PAD_RIGHT;
* available to the PHP programming language to provide facilities for
* converting parts of time into representations that may be used in UUIDs
*
* @psalm-immutable
* @immutable
*/
class PhpTimeConverter implements TimeConverterInterface
{
@@ -92,7 +92,6 @@ class PhpTimeConverter implements TimeConverterInterface
// Check to see whether we've overflowed the max/min integer size.
// If so, we will default to a different time converter.
/** @psalm-suppress RedundantCondition */
if (!is_int($uuidTime)) {
return $this->fallbackConverter->calculateTime(
$seconds->toString(),
src/Converter/Time/UnixTimeConverter.php
+1 -1
View File
@@ -30,7 +30,7 @@ use const STR_PAD_LEFT;
* UnixTimeConverter converts Unix Epoch timestamps to/from hexadecimal values
* consisting of milliseconds elapsed since the Unix Epoch
*
* @psalm-immutable
* @immutable
*/
class UnixTimeConverter implements TimeConverterInterface
{
src/Converter/TimeConverterInterface.php
+1 -5
View File
@@ -21,7 +21,7 @@ use Ramsey\Uuid\Type\Time;
* A time converter converts timestamps into representations that may be used
* in UUIDs
*
* @psalm-immutable
* @immutable
*/
interface TimeConverterInterface
{
@@ -38,8 +38,6 @@ interface TimeConverterInterface
* associated with the time to calculate
*
* @return Hexadecimal The full UUID timestamp as a Hexadecimal value
*
* @psalm-pure
*/
public function calculateTime(string $seconds, string $microseconds): Hexadecimal;
@@ -51,8 +49,6 @@ interface TimeConverterInterface
* since UTC 00:00:00.00, 15 October 1582.
*
* @return Time An instance of {@see Time}
*
* @psalm-pure
*/
public function convertTime(Hexadecimal $uuidTimestamp): Time;
}
src/DegradedUuid.php
+1 -1
View File
@@ -18,7 +18,7 @@ namespace Ramsey\Uuid;
* @deprecated DegradedUuid is no longer necessary to represent UUIDs on 32-bit
* systems. Transition typehints to {@see UuidInterface}.
*
* @psalm-immutable
* @immutable
*/
class DegradedUuid extends Uuid
{
src/DeprecatedUuidInterface.php
+1 -1
View File
@@ -20,7 +20,7 @@ use Ramsey\Uuid\Converter\NumberConverterInterface;
/**
* This interface encapsulates deprecated methods for ramsey/uuid
*
* @psalm-immutable
* @immutable
*/
interface DeprecatedUuidInterface
{
src/DeprecatedUuidMethodsTrait.php
+1 -1
View File
@@ -32,7 +32,7 @@ use const STR_PAD_LEFT;
*
* @deprecated This trait and its methods will be removed in ramsey/uuid 5.0.0.
*
* @psalm-immutable
* @immutable
*/
trait DeprecatedUuidMethodsTrait
{
src/FeatureSet.php
-1
View File
@@ -212,7 +212,6 @@ class FeatureSet
$this->numberConverter = $this->buildNumberConverter($calculator);
$this->timeConverter = $this->buildTimeConverter($calculator);
/** @psalm-suppress RedundantPropertyInitializationCheck */
if (isset($this->timeProvider)) {
$this->timeGenerator = $this->buildTimeGenerator($this->timeProvider);
}
src/Fields/FieldsInterface.php
+2 -2
View File
@@ -17,11 +17,11 @@ namespace Ramsey\Uuid\Fields;
use Serializable;
/**
* UUIDs are comprised of unsigned integers, the bytes of which are separated
* UUIDs consist of unsigned integers, the bytes of which are separated
* into fields and arranged in a particular layout defined by the specification
* for the variant
*
* @psalm-immutable
* @immutable
*/
interface FieldsInterface extends Serializable
{
src/Fields/SerializableFieldsTrait.php
+1 -5
View File
@@ -23,7 +23,7 @@ use function strlen;
/**
* Provides common serialization functionality to fields
*
* @psalm-immutable
* @immutable
*/
trait SerializableFieldsTrait
{
@@ -57,8 +57,6 @@ trait SerializableFieldsTrait
* Constructs the object from a serialized string representation
*
* @param string $data The serialized string representation of the object
*
* @psalm-suppress UnusedMethodCall
*/
public function unserialize(string $data): void
{
@@ -71,8 +69,6 @@ trait SerializableFieldsTrait
/**
* @param array{bytes?: string} $data
*
* @psalm-suppress UnusedMethodCall
*/
public function __unserialize(array $data): void
{
src/Generator/DefaultNameGenerator.php
-1
View File
@@ -26,7 +26,6 @@ use function hash;
*/
class DefaultNameGenerator implements NameGeneratorInterface
{
/** @psalm-pure */
public function generate(UuidInterface $ns, string $name, string $hashAlgorithm): string
{
try {
src/Generator/NameGeneratorInterface.php
-2
View File
@@ -31,8 +31,6 @@ interface NameGeneratorInterface
* @param string $hashAlgorithm The hashing algorithm to use
*
* @return string A binary string
*
* @psalm-pure
*/
public function generate(UuidInterface $ns, string $name, string $hashAlgorithm): string;
}
src/Generator/PeclUuidNameGenerator.php
-1
View File
@@ -30,7 +30,6 @@ use function uuid_parse;
*/
class PeclUuidNameGenerator implements NameGeneratorInterface
{
/** @psalm-pure */
public function generate(UuidInterface $ns, string $name, string $hashAlgorithm): string
{
$uuid = match ($hashAlgorithm) {
src/Guid/Fields.php
+1 -1
View File
@@ -41,7 +41,7 @@ use const STR_PAD_LEFT;
*
* @see Guid
*
* @psalm-immutable
* @immutable
*/
final class Fields implements FieldsInterface
{
src/Guid/Guid.php
+1 -1
View File
@@ -46,7 +46,7 @@ use Ramsey\Uuid\Uuid;
* @link https://docs.microsoft.com/en-us/dotnet/api/system.guid .NET Guid Struct
* @link https://docs.microsoft.com/en-us/dotnet/api/system.guid.tobytearray .NET Guid.ToByteArray Method
*
* @psalm-immutable
* @immutable
*/
final class Guid extends Uuid
{
src/Guid/GuidBuilder.php
+1 -3
View File
@@ -27,7 +27,7 @@ use Throwable;
*
* @see Guid
*
* @psalm-immutable
* @immutable
*/
class GuidBuilder implements UuidBuilderInterface
{
@@ -50,8 +50,6 @@ class GuidBuilder implements UuidBuilderInterface
* @param string $bytes The byte string from which to construct a UUID
*
* @return Guid The GuidBuilder returns an instance of Ramsey\Uuid\Guid\Guid
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface
{
src/Lazy/LazyUuidFromString.php
+39 -147
View File
@@ -41,16 +41,13 @@ use function substr;
* @internal this type is used internally for performance reasons, and is not supposed to be directly referenced
* in consumer libraries.
*
* @psalm-immutable
* @immutable
*
* Note: the {@see FieldsInterface} does not declare methods that deprecated API
* relies upon: the API has been ported from the {@see \Ramsey\Uuid\Uuid} definition,
* and is deprecated anyway.
* Note: the deprecated API from {@see \Ramsey\Uuid\Uuid} is in use here (on purpose): it will be removed
* once the deprecated API is gone from this class too.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
*/
final class LazyUuidFromString implements UuidInterface
{
@@ -59,13 +56,12 @@ final class LazyUuidFromString implements UuidInterface
private ?UuidInterface $unwrapped = null;
/**
* @psalm-param non-empty-string $uuid
* @param non-empty-string $uuid
*/
public function __construct(private string $uuid)
{
}
/** @psalm-pure */
public static function fromBytes(string $bytes): self
{
$base16Uuid = bin2hex($bytes);
@@ -89,9 +85,7 @@ final class LazyUuidFromString implements UuidInterface
}
/**
* @return array{string: string}
*
* @psalm-return array{string: non-empty-string}
* @return array{string: non-empty-string}
*/
public function __serialize(): array
{
@@ -101,9 +95,7 @@ final class LazyUuidFromString implements UuidInterface
/**
* {@inheritDoc}
*
* @param string $data
*
* @psalm-param non-empty-string $data
* @param non-empty-string $data
*/
public function unserialize(string $data): void
{
@@ -111,10 +103,7 @@ final class LazyUuidFromString implements UuidInterface
}
/**
* @param array{string?: string} $data
*
* @psalm-param array{string?: non-empty-string} $data
* @psalm-suppress UnusedMethodCall
* @param array{string?: non-empty-string} $data
*/
public function __unserialize(array $data): void
{
@@ -127,7 +116,6 @@ final class LazyUuidFromString implements UuidInterface
$this->unserialize($data['string']);
}
/** @psalm-suppress DeprecatedMethod */
public function getNumberConverter(): NumberConverterInterface
{
return ($this->unwrapped ?? $this->unwrap())
@@ -135,9 +123,7 @@ final class LazyUuidFromString implements UuidInterface
}
/**
* {@inheritDoc}
*
* @psalm-suppress DeprecatedMethod
* @inheritDoc
*/
public function getFieldsHex(): array
{
@@ -145,98 +131,84 @@ final class LazyUuidFromString implements UuidInterface
->getFieldsHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getClockSeqHiAndReservedHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getClockSeqHiAndReservedHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getClockSeqLowHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getClockSeqLowHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getClockSequenceHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getClockSequenceHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getDateTime(): DateTimeInterface
{
return ($this->unwrapped ?? $this->unwrap())
->getDateTime();
}
/** @psalm-suppress DeprecatedMethod */
public function getLeastSignificantBitsHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getLeastSignificantBitsHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getMostSignificantBitsHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getMostSignificantBitsHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getNodeHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getNodeHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getTimeHiAndVersionHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getTimeHiAndVersionHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getTimeLowHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getTimeLowHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getTimeMidHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getTimeMidHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getTimestampHex(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getTimestampHex();
}
/** @psalm-suppress DeprecatedMethod */
public function getUrn(): string
{
return ($this->unwrapped ?? $this->unwrap())
->getUrn();
}
/** @psalm-suppress DeprecatedMethod */
public function getVariant(): ?int
{
return ($this->unwrapped ?? $this->unwrap())
->getVariant();
}
/** @psalm-suppress DeprecatedMethod */
public function getVersion(): ?int
{
return ($this->unwrapped ?? $this->unwrap())
@@ -258,16 +230,9 @@ final class LazyUuidFromString implements UuidInterface
return $this->uuid === $other->toString();
}
/**
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificReturnType
* @psalm-suppress LessSpecificReturnStatement we know that {@see self::$uuid} is a non-empty string, so
* we know that {@see hex2bin} will retrieve a non-empty string too.
*/
public function getBytes(): string
{
/** @phpstan-ignore-next-line PHPStan complains that this is not a non-empty-string. */
/** @var non-empty-string */
return (string) hex2bin(str_replace('-', '', $this->uuid));
}
@@ -310,22 +275,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getClockSeqHiAndReserved()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getClockSeqHiAndReserved(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getClockSeqHiAndReserved()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getClockSeqHiAndReserved()->toString());
}
/**
@@ -334,22 +292,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getClockSeqLow()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getClockSeqLow(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getClockSeqLow()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getClockSeqLow()->toString());
}
/**
@@ -358,33 +309,21 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getClockSeq()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getClockSequence(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getClockSeq()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getClockSeq()->toString());
}
/**
* @deprecated This method will be removed in 5.0.0. There is no direct
* alternative, but the same information may be obtained by splitting
* in half the value returned by {@see UuidInterface::getHex()}.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getLeastSignificantBits(): string
{
@@ -398,11 +337,6 @@ final class LazyUuidFromString implements UuidInterface
* @deprecated This method will be removed in 5.0.0. There is no direct
* alternative, but the same information may be obtained by splitting
* in half the value returned by {@see UuidInterface::getHex()}.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getMostSignificantBits(): string
{
@@ -418,22 +352,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getNode()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getNode(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getNode()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getNode()->toString());
}
/**
@@ -442,22 +369,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getTimeHiAndVersion()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getTimeHiAndVersion(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getTimeHiAndVersion()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getTimeHiAndVersion()->toString());
}
/**
@@ -466,22 +386,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getTimeLow()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getTimeLow(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getTimeLow()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getTimeLow()->toString());
}
/**
@@ -490,22 +403,15 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getTimeMid()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getTimeMid(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
return $instance->getNumberConverter()
->fromHex(
$instance->getFields()
->getTimeMid()
->toString()
);
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
return $instance->getNumberConverter()->fromHex($fields->getTimeMid()->toString());
}
/**
@@ -514,23 +420,19 @@ final class LazyUuidFromString implements UuidInterface
* instance, you may call {@see Rfc4122FieldsInterface::getTimestamp()}
* and use the arbitrary-precision math library of your choice to
* convert it to a string integer.
*
* @psalm-suppress UndefinedInterfaceMethod
* @psalm-suppress DeprecatedMethod
* @psalm-suppress MixedArgument
* @psalm-suppress MixedMethodCall
*/
public function getTimestamp(): string
{
$instance = ($this->unwrapped ?? $this->unwrap());
$fields = $instance->getFields();
assert($fields instanceof \Ramsey\Uuid\Rfc4122\FieldsInterface);
if ($fields->getVersion() !== 1) {
throw new UnsupportedOperationException('Not a time-based UUID');
}
return $instance->getNumberConverter()
->fromHex($fields->getTimestamp()->toString());
return $instance->getNumberConverter()->fromHex($fields->getTimestamp()->toString());
}
public function toUuidV1(): UuidV1
@@ -555,18 +457,8 @@ final class LazyUuidFromString implements UuidInterface
return $instance;
}
/**
* @psalm-suppress ImpureMethodCall the retrieval of the factory is a clear violation of purity here: this is a
* known pitfall of the design of this library, where a value object contains
* a mutable reference to a factory. We use a fixed factory here, so the violation
* will not have real-world effects, as this object is only instantiated with the
* default factory settings/features.
* @psalm-suppress InaccessibleProperty property {@see $unwrapped} is used as a cache: we don't expose it to the
* outside world, so we should be fine here.
*/
private function unwrap(): UuidInterface
{
return $this->unwrapped = (new UuidFactory())
->fromString($this->uuid);
return $this->unwrapped = (new UuidFactory())->fromString($this->uuid);
}
}
src/Math/BrickMathCalculator.php
+1 -1
View File
@@ -27,7 +27,7 @@ use Ramsey\Uuid\Type\NumberInterface;
/**
* A calculator using the brick/math library for arbitrary-precision arithmetic
*
* @psalm-immutable
* @immutable
*/
final class BrickMathCalculator implements CalculatorInterface
{
src/Math/CalculatorInterface.php
+1 -1
View File
@@ -21,7 +21,7 @@ use Ramsey\Uuid\Type\NumberInterface;
/**
* A calculator performs arithmetic operations on numbers
*
* @psalm-immutable
* @immutable
*/
interface CalculatorInterface
{
src/Nonstandard/Fields.php
+1 -1
View File
@@ -40,7 +40,7 @@ use const STR_PAD_LEFT;
* Internally, this class represents the fields together as a 16-byte binary
* string.
*
* @psalm-immutable
* @immutable
*/
final class Fields implements FieldsInterface
{
src/Nonstandard/Uuid.php
+1 -1
View File
@@ -22,7 +22,7 @@ use Ramsey\Uuid\Uuid as BaseUuid;
/**
* Nonstandard\Uuid is a UUID that doesn't conform to RFC 4122
*
* @psalm-immutable
* @immutable
*/
final class Uuid extends BaseUuid
{
src/Nonstandard/UuidBuilder.php
+1 -3
View File
@@ -25,7 +25,7 @@ use Throwable;
/**
* Nonstandard\UuidBuilder builds instances of Nonstandard\Uuid
*
* @psalm-immutable
* @immutable
*/
class UuidBuilder implements UuidBuilderInterface
{
@@ -49,8 +49,6 @@ class UuidBuilder implements UuidBuilderInterface
*
* @return Uuid The Nonstandard\UuidBuilder returns an instance of
* Nonstandard\Uuid
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface
{
src/Nonstandard/UuidV6.php
+1 -1
View File
@@ -34,7 +34,7 @@ use Ramsey\Uuid\Uuid as BaseUuid;
* @link https://github.com/uuid6/uuid6-ietf-draft UUID version 6 IETF draft
* @link http://gh.peabody.io/uuidv6/ "Version 6" UUIDs
*
* @psalm-immutable
* @immutable
*/
class UuidV6 extends BaseUuid implements UuidInterface
{
src/Provider/Dce/SystemDceSecurityProvider.php
+1 -4
View File
@@ -141,10 +141,7 @@ class SystemDceSecurityProvider implements DceSecurityProviderInterface
*/
private function getOs(): string
{
/**
* @psalm-suppress UnnecessaryVarAnnotation
* @var string $phpOs
*/
/** @var string $phpOs */
$phpOs = constant('PHP_OS');
return strtoupper(substr($phpOs, 0, 3));
src/Provider/Node/NodeProviderCollection.php
-3
View File
@@ -40,9 +40,6 @@ class NodeProviderCollection extends AbstractCollection
*
* @param string $serialized The serialized PHP string to unserialize into
* a UuidInterface instance
*
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @psalm-suppress RedundantConditionGivenDocblockType
*/
public function unserialize($serialized): void
{
src/Provider/Node/SystemNodeProvider.php
+2 -8
View File
@@ -104,10 +104,7 @@ class SystemNodeProvider implements NodeProviderInterface
return '';
}
/**
* @psalm-suppress UnnecessaryVarAnnotation
* @var string $phpOs
*/
/** @var string $phpOs */
$phpOs = constant('PHP_OS');
ob_start();
@@ -151,10 +148,7 @@ class SystemNodeProvider implements NodeProviderInterface
{
$mac = '';
/**
* @psalm-suppress UnnecessaryVarAnnotation
* @var string $phpOs
*/
/** @var string $phpOs */
$phpOs = constant('PHP_OS');
if (strtoupper($phpOs) === 'LINUX') {
src/Rfc4122/Fields.php
+2 -2
View File
@@ -31,12 +31,12 @@ use function unpack;
use const STR_PAD_LEFT;
/**
* RFC 4122 variant UUIDs are comprised of a set of named fields
* RFC 4122 variant UUIDs consist of a set of named fields
*
* Internally, this class represents the fields together as a 16-byte binary
* string.
*
* @psalm-immutable
* @immutable
*/
final class Fields implements FieldsInterface
{
src/Rfc4122/FieldsInterface.php
+1 -1
View File
@@ -35,7 +35,7 @@ use Ramsey\Uuid\Type\Hexadecimal;
*
* @link http://tools.ietf.org/html/rfc4122#section-4.1 RFC 4122, § 4.1: Format
*
* @psalm-immutable
* @immutable
*/
interface FieldsInterface extends BaseFieldsInterface
{
src/Rfc4122/MaxTrait.php
+1 -1
View File
@@ -22,7 +22,7 @@ namespace Ramsey\Uuid\Rfc4122;
*
* @link https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis-00#section-5.10 Max UUID
*
* @psalm-immutable
* @immutable
*/
trait MaxTrait
{
src/Rfc4122/MaxUuid.php
+1 -1
View File
@@ -20,7 +20,7 @@ use Ramsey\Uuid\Uuid;
* The max UUID is special form of UUID that is specified to have all 128 bits
* set to one
*
* @psalm-immutable
* @immutable
*/
final class MaxUuid extends Uuid implements UuidInterface
{
src/Rfc4122/NilTrait.php
+1 -1
View File
@@ -22,7 +22,7 @@ namespace Ramsey\Uuid\Rfc4122;
*
* @link https://tools.ietf.org/html/rfc4122#section-4.1.7 RFC 4122, § 4.1.7: Nil UUID
*
* @psalm-immutable
* @immutable
*/
trait NilTrait
{
src/Rfc4122/NilUuid.php
+1 -1
View File
@@ -20,7 +20,7 @@ use Ramsey\Uuid\Uuid;
* The nil UUID is special form of UUID that is specified to have all 128 bits
* set to zero
*
* @psalm-immutable
* @immutable
*/
final class NilUuid extends Uuid implements UuidInterface
{
src/Rfc4122/TimeTrait.php
+1 -1
View File
@@ -26,7 +26,7 @@ use const STR_PAD_LEFT;
/**
* Provides common functionality for getting the time from a time-based UUID
*
* @psalm-immutable
* @immutable
*/
trait TimeTrait
{
src/Rfc4122/UuidBuilder.php
+1 -3
View File
@@ -30,7 +30,7 @@ use Throwable;
/**
* UuidBuilder builds instances of RFC 4122 UUIDs
*
* @psalm-immutable
* @immutable
*/
class UuidBuilder implements UuidBuilderInterface
{
@@ -63,8 +63,6 @@ class UuidBuilder implements UuidBuilderInterface
* @param string $bytes The byte string from which to construct a UUID
*
* @return Rfc4122UuidInterface UuidBuilder returns instances of Rfc4122UuidInterface
*
* @psalm-pure
*/
public function build(CodecInterface $codec, string $bytes): UuidInterface
{
src/Rfc4122/UuidInterface.php
+1 -1
View File
@@ -22,7 +22,7 @@ use Ramsey\Uuid\UuidInterface as BaseUuidInterface;
*
* @link https://tools.ietf.org/html/rfc4122 RFC 4122
*
* @psalm-immutable
* @immutable
*/
interface UuidInterface extends BaseUuidInterface
{
src/Rfc4122/UuidV1.php
+1 -1
View File
@@ -25,7 +25,7 @@ use Ramsey\Uuid\Uuid;
* Gregorian time, or version 1, UUIDs include timestamp, clock sequence, and node
* values that are combined into a 128-bit unsigned integer
*
* @psalm-immutable
* @immutable
*/
final class UuidV1 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV2.php
+1 -1
View File
@@ -48,7 +48,7 @@ use function hexdec;
* @link https://pubs.opengroup.org/onlinepubs/9629399/apdxa.htm DCE 1.1: RPC, Appendix A
* @link https://github.com/google/uuid Go package for UUIDs (includes DCE implementation)
*
* @psalm-immutable
* @immutable
*/
final class UuidV2 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV3.php
+2 -2
View File
@@ -22,10 +22,10 @@ use Ramsey\Uuid\Rfc4122\FieldsInterface as Rfc4122FieldsInterface;
use Ramsey\Uuid\Uuid;
/**
* Version 3 UUIDs are named-based, using combination of a namespace and name
* Version 3 UUIDs are named-based, using a combination of a namespace and name
* that are hashed into a 128-bit unsigned integer using MD5
*
* @psalm-immutable
* @immutable
*/
final class UuidV3 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV4.php
+1 -1
View File
@@ -25,7 +25,7 @@ use Ramsey\Uuid\Uuid;
* Random, or version 4, UUIDs are randomly or pseudo-randomly generated 128-bit
* integers
*
* @psalm-immutable
* @immutable
*/
final class UuidV4 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV5.php
+2 -2
View File
@@ -22,10 +22,10 @@ use Ramsey\Uuid\Rfc4122\FieldsInterface as Rfc4122FieldsInterface;
use Ramsey\Uuid\Uuid;
/**
* Version 5 UUIDs are named-based, using combination of a namespace and name
* Version 5 UUIDs are named-based, using a combination of a namespace and name
* that are hashed into a 128-bit unsigned integer using SHA1
*
* @psalm-immutable
* @immutable
*/
final class UuidV5 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV6.php
+1 -1
View File
@@ -22,7 +22,7 @@ use Ramsey\Uuid\Nonstandard\UuidV6 as NonstandardUuidV6;
*
* @link https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis-00#section-5.6 UUID Version 6
*
* @psalm-immutable
* @immutable
*/
final class UuidV6 extends NonstandardUuidV6 implements UuidInterface
{
src/Rfc4122/UuidV7.php
+1 -1
View File
@@ -27,7 +27,7 @@ use Ramsey\Uuid\Uuid;
*
* @link https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis-00#section-5.7 UUID Version 7
*
* @psalm-immutable
* @immutable
*/
final class UuidV7 extends Uuid implements UuidInterface
{
src/Rfc4122/UuidV8.php
+1 -1
View File
@@ -32,7 +32,7 @@ use Ramsey\Uuid\Uuid;
*
* @link https://datatracker.ietf.org/doc/html/draft-ietf-uuidrev-rfc4122bis-00#section-5.8 UUID Version 8
*
* @psalm-immutable
* @immutable
*/
final class UuidV8 extends Uuid implements UuidInterface
{
src/Rfc4122/Validator.php
+2 -4
View File
@@ -23,7 +23,7 @@ use function str_replace;
/**
* Rfc4122\Validator validates strings as UUIDs of the RFC 4122 variant
*
* @psalm-immutable
* @immutable
*/
final class Validator implements ValidatorInterface
{
@@ -31,9 +31,7 @@ final class Validator implements ValidatorInterface
. '[1-8][0-9A-Fa-f]{3}-[ABab89][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}\z';
/**
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function getPattern(): string
{
src/Rfc4122/VariantTrait.php
+1 -1
View File
@@ -29,7 +29,7 @@ use const STR_PAD_LEFT;
/**
* Provides common functionality for handling the variant, as defined by RFC 4122
*
* @psalm-immutable
* @immutable
*/
trait VariantTrait
{
src/Rfc4122/VersionTrait.php
+1 -1
View File
@@ -19,7 +19,7 @@ use Ramsey\Uuid\Uuid;
/**
* Provides common functionality for handling the version, as defined by RFC 4122
*
* @psalm-immutable
* @immutable
*/
trait VersionTrait
{
src/Type/Decimal.php
+1 -5
View File
@@ -31,7 +31,7 @@ use function str_starts_with;
* To support values as true decimals and not as floats or doubles, we store the
* decimals as strings.
*
* @psalm-immutable
* @immutable
*/
final class Decimal implements NumberInterface
{
@@ -103,8 +103,6 @@ final class Decimal implements NumberInterface
* Constructs the object from a serialized string representation
*
* @param string $data The serialized string representation of the object
*
* @psalm-suppress UnusedMethodCall
*/
public function unserialize(string $data): void
{
@@ -113,8 +111,6 @@ final class Decimal implements NumberInterface
/**
* @param array{string?: string} $data
*
* @psalm-suppress UnusedMethodCall
*/
public function __unserialize(array $data): void
{
src/Type/Hexadecimal.php
+1 -3
View File
@@ -28,7 +28,7 @@ use function substr;
* returned from ramsey/uuid methods as strings are truly hexadecimal and not some
* other kind of string.
*
* @psalm-immutable
* @immutable
*/
final class Hexadecimal implements TypeInterface
{
@@ -74,8 +74,6 @@ final class Hexadecimal implements TypeInterface
* Constructs the object from a serialized string representation
*
* @param string $data The serialized string representation of the object
*
* @psalm-suppress UnusedMethodCall
*/
public function unserialize(string $data): void
{
src/Type/Integer.php
+4 -7
View File
@@ -33,12 +33,12 @@ use function substr;
* To support large integers beyond PHP_INT_MAX and PHP_INT_MIN on both 64-bit
* and 32-bit systems, we store the integers as strings.
*
* @psalm-immutable
* @immutable
*/
final class Integer implements NumberInterface
{
/**
* @psalm-var numeric-string
* @var numeric-string
*/
private string $value;
@@ -55,7 +55,7 @@ final class Integer implements NumberInterface
}
/**
* @psalm-return numeric-string
* @return numeric-string
*/
public function toString(): string
{
@@ -63,7 +63,7 @@ final class Integer implements NumberInterface
}
/**
* @psalm-return numeric-string
* @return numeric-string
*/
public function __toString(): string
{
@@ -92,8 +92,6 @@ final class Integer implements NumberInterface
* Constructs the object from a serialized string representation
*
* @param string $data The serialized string representation of the object
*
* @psalm-suppress UnusedMethodCall
*/
public function unserialize(string $data): void
{
@@ -147,7 +145,6 @@ final class Integer implements NumberInterface
if ($sign === '-' && $value !== '0') {
$value = $sign . $value;
/** @psalm-suppress InaccessibleProperty */
$this->isNegative = true;
}
src/Type/NumberInterface.php
+1 -1
View File
@@ -17,7 +17,7 @@ namespace Ramsey\Uuid\Type;
/**
* NumberInterface ensures consistency in numeric values returned by ramsey/uuid
*
* @psalm-immutable
* @immutable
*/
interface NumberInterface extends TypeInterface
{
src/Type/Time.php
+1 -3
View File
@@ -29,7 +29,7 @@ use function sprintf;
* by ramsey/uuid are truly timestamp integers and not some other kind of string
* or integer.
*
* @psalm-immutable
* @immutable
*/
final class Time implements TypeInterface
{
@@ -95,8 +95,6 @@ final class Time implements TypeInterface
* Constructs the object from a serialized string representation
*
* @param string $data The serialized string representation of the object
*
* @psalm-suppress UnusedMethodCall
*/
public function unserialize(string $data): void
{
src/Type/TypeInterface.php
+1 -1
View File
@@ -20,7 +20,7 @@ use Serializable;
/**
* TypeInterface ensures consistency in typed values returned by ramsey/uuid
*
* @psalm-immutable
* @immutable
*/
interface TypeInterface extends JsonSerializable, Serializable
{
src/Uuid.php
+7 -55
View File
@@ -42,14 +42,14 @@ use function substr;
/**
* Uuid provides constants and static methods for working with and generating UUIDs
*
* @psalm-immutable
* @immutable
*/
class Uuid implements UuidInterface
{
use DeprecatedUuidMethodsTrait;
/**
* When this namespace is specified, the name string is a fully-qualified
* When this namespace is specified, the name string is a fully qualified
* domain name
*
* @link http://tools.ietf.org/html/rfc4122#appendix-C RFC 4122, Appendix C: Some Name Space IDs
@@ -274,7 +274,7 @@ class Uuid implements UuidInterface
}
/**
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function __toString(): string
{
@@ -366,7 +366,7 @@ class Uuid implements UuidInterface
}
/**
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function getBytes(): string
{
@@ -394,7 +394,7 @@ class Uuid implements UuidInterface
}
/**
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function toString(): string
{
@@ -438,13 +438,6 @@ class Uuid implements UuidInterface
* string representation
*
* @throws InvalidArgumentException
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
* @psalm-suppress ImpureStaticProperty we know that the factory being replaced can lead to massive
* havoc across all consumers: that should never happen, and
* is generally to be discouraged. Until the factory is kept
* un-replaced, this method is effectively pure.
*/
public static function fromBytes(string $bytes): UuidInterface
{
@@ -477,13 +470,6 @@ class Uuid implements UuidInterface
* string representation
*
* @throws InvalidArgumentException
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
* @psalm-suppress ImpureStaticProperty we know that the factory being replaced can lead to massive
* havoc across all consumers: that should never happen, and
* is generally to be discouraged. Until the factory is kept
* un-replaced, this method is effectively pure.
*/
public static function fromString(string $uuid): UuidInterface
{
@@ -524,24 +510,16 @@ class Uuid implements UuidInterface
* @param Hexadecimal $hex Hexadecimal object representing a hexadecimal number
*
* @return UuidInterface A UuidInterface instance created from the Hexadecimal
* object representing a hexadecimal number
* object representing a hexadecimal number
*
* @throws InvalidArgumentException
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
* @psalm-suppress MixedInferredReturnType,MixedReturnStatement
*/
public static function fromHexadecimal(Hexadecimal $hex): UuidInterface
{
$factory = self::getFactory();
if (method_exists($factory, 'fromHexadecimal')) {
/**
* @phpstan-ignore-next-line
* @psalm-suppress UndefinedInterfaceMethod
*/
return self::getFactory()->fromHexadecimal($hex);
return $factory->fromHexadecimal($hex);
}
throw new BadMethodCallException('The method fromHexadecimal() does not exist on the provided factory');
@@ -556,13 +534,9 @@ class Uuid implements UuidInterface
* representation of a 128-bit integer
*
* @throws InvalidArgumentException
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*/
public static function fromInteger(string $integer): UuidInterface
{
/** @psalm-suppress ImpureMethodCall */
return self::getFactory()->fromInteger($integer);
}
@@ -572,15 +546,9 @@ class Uuid implements UuidInterface
* @param string $uuid A string to validate as a UUID
*
* @return bool True if the string is a valid UUID, false otherwise
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*
* @psalm-assert-if-true =non-empty-string $uuid
*/
public static function isValid(string $uuid): bool
{
/** @psalm-suppress ImpureMethodCall */
return self::getFactory()->getValidator()->validate($uuid);
}
@@ -641,14 +609,6 @@ class Uuid implements UuidInterface
*
* @return UuidInterface A UuidInterface instance that represents a
* version 3 UUID
*
* @psalm-suppress ImpureMethodCall we know that the factory being replaced can lead to massive
* havoc across all consumers: that should never happen, and
* is generally to be discouraged. Until the factory is kept
* un-replaced, this method is effectively pure.
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*/
public static function uuid3($ns, string $name): UuidInterface
{
@@ -675,14 +635,6 @@ class Uuid implements UuidInterface
*
* @return UuidInterface A UuidInterface instance that represents a
* version 5 UUID
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*
* @psalm-suppress ImpureMethodCall we know that the factory being replaced can lead to massive
* havoc across all consumers: that should never happen, and
* is generally to be discouraged. Until the factory is kept
* un-replaced, this method is effectively pure.
*/
public static function uuid5($ns, string $name): UuidInterface
{
src/UuidFactory.php
-25
View File
@@ -240,9 +240,6 @@ class UuidFactory implements UuidFactoryInterface
$this->uuidBuilder = $builder;
}
/**
* @psalm-mutation-free
*/
public function getValidator(): ValidatorInterface
{
return $this->validator;
@@ -261,17 +258,11 @@ class UuidFactory implements UuidFactoryInterface
$this->validator = $validator;
}
/**
* @psalm-pure
*/
public function fromBytes(string $bytes): UuidInterface
{
return $this->codec->decodeBytes($bytes);
}
/**
* @psalm-pure
*/
public function fromString(string $uuid): UuidInterface
{
$uuid = strtolower($uuid);
@@ -279,9 +270,6 @@ class UuidFactory implements UuidFactoryInterface
return $this->codec->decode($uuid);
}
/**
* @psalm-pure
*/
public function fromInteger(string $integer): UuidInterface
{
$hex = $this->numberConverter->toHex($integer);
@@ -312,9 +300,6 @@ class UuidFactory implements UuidFactoryInterface
return $this->uuidFromBytesAndVersion($bytes, Uuid::UUID_TYPE_TIME);
}
/**
* @psalm-pure
*/
public function fromHexadecimal(Hexadecimal $hex): UuidInterface
{
return $this->codec->decode($hex->__toString());
@@ -348,7 +333,6 @@ class UuidFactory implements UuidFactoryInterface
/**
* @inheritDoc
* @psalm-pure
*/
public function uuid3($ns, string $name): UuidInterface
{
@@ -364,7 +348,6 @@ class UuidFactory implements UuidFactoryInterface
/**
* @inheritDoc
* @psalm-pure
*/
public function uuid5($ns, string $name): UuidInterface
{
@@ -439,12 +422,9 @@ class UuidFactory implements UuidFactoryInterface
*
* @return UuidInterface An instance of UuidInterface, created from the
* provided bytes
*
* @psalm-pure
*/
public function uuid(string $bytes): UuidInterface
{
/** @psalm-suppress ImpurePropertyFetch */
return $this->uuidBuilder->build($this->codec, $bytes);
}
@@ -459,8 +439,6 @@ class UuidFactory implements UuidFactoryInterface
*
* @return UuidInterface An instance of UuidInterface, created by hashing
* together the provided namespace and name
*
* @psalm-pure
*/
private function uuidFromNsAndName(
UuidInterface | string $ns,
@@ -485,8 +463,6 @@ class UuidFactory implements UuidFactoryInterface
*
* @return UuidInterface An instance of UuidInterface, created from the
* byte string and version
*
* @psalm-pure
*/
private function uuidFromBytesAndVersion(string $bytes, int $version): UuidInterface
{
@@ -507,7 +483,6 @@ class UuidFactory implements UuidFactoryInterface
return LazyUuidFromString::fromBytes($bytes);
}
/** @psalm-suppress ImpureVariable */
return $this->uuid($bytes);
}
}
src/UuidFactoryInterface.php
+2 -14
View File
@@ -20,7 +20,7 @@ use Ramsey\Uuid\Type\Integer as IntegerObject;
use Ramsey\Uuid\Validator\ValidatorInterface;
/**
* UuidFactoryInterface defines common functionality all `UuidFactory` instances
* UuidFactoryInterface defines the common functionality all `UuidFactory` instances
* must implement
*/
interface UuidFactoryInterface
@@ -32,8 +32,6 @@ interface UuidFactoryInterface
*
* @return UuidInterface A UuidInterface instance created from a binary
* string representation
*
* @psalm-pure
*/
public function fromBytes(string $bytes): UuidInterface;
@@ -63,8 +61,6 @@ interface UuidFactoryInterface
*
* @return UuidInterface A UuidInterface instance created from the string
* representation of a 128-bit integer
*
* @psalm-pure
*/
public function fromInteger(string $integer): UuidInterface;
@@ -75,15 +71,11 @@ interface UuidFactoryInterface
*
* @return UuidInterface A UuidInterface instance created from a hexadecimal
* string representation
*
* @psalm-pure
*/
public function fromString(string $uuid): UuidInterface;
/**
* Returns the validator to use for the factory
*
* @psalm-mutation-free
* Returns the validator used by the factory
*/
public function getValidator(): ValidatorInterface;
@@ -138,8 +130,6 @@ interface UuidFactoryInterface
*
* @return UuidInterface A UuidInterface instance that represents a
* version 3 UUID
*
* @psalm-pure
*/
public function uuid3($ns, string $name): UuidInterface;
@@ -160,8 +150,6 @@ interface UuidFactoryInterface
*
* @return UuidInterface A UuidInterface instance that represents a
* version 5 UUID
*
* @psalm-pure
*/
public function uuid5($ns, string $name): UuidInterface;
src/UuidInterface.php
+4 -4
View File
@@ -25,7 +25,7 @@ use Stringable;
* A UUID is a universally unique identifier adhering to an agreed-upon
* representation format and standard for generation
*
* @psalm-immutable
* @immutable
*/
interface UuidInterface extends
DeprecatedUuidInterface,
@@ -66,7 +66,7 @@ interface UuidInterface extends
/**
* Returns the binary string representation of the UUID
*
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function getBytes(): string;
@@ -96,14 +96,14 @@ interface UuidInterface extends
/**
* Returns the string standard representation of the UUID
*
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function toString(): string;
/**
* Casts the UUID to the string standard representation
*
* @psalm-return non-empty-string
* @return non-empty-string
*/
public function __toString(): string;
}
src/Validator/GenericValidator.php
+2 -4
View File
@@ -22,7 +22,7 @@ use function str_replace;
/**
* GenericValidator validates strings as UUIDs of any variant
*
* @psalm-immutable
* @immutable
*/
final class GenericValidator implements ValidatorInterface
{
@@ -32,9 +32,7 @@ final class GenericValidator implements ValidatorInterface
private const VALID_PATTERN = '\A[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}\z';
/**
* @psalm-return non-empty-string
* @psalm-suppress MoreSpecificReturnType we know that the retrieved `string` is never empty
* @psalm-suppress LessSpecificReturnStatement we know that the retrieved `string` is never empty
* @return non-empty-string
*/
public function getPattern(): string
{
src/Validator/ValidatorInterface.php
+2 -4
View File
@@ -17,16 +17,14 @@ namespace Ramsey\Uuid\Validator;
/**
* A validator validates a string as a proper UUID
*
* @psalm-immutable
* @immutable
*/
interface ValidatorInterface
{
/**
* Returns the regular expression pattern used by this validator
*
* @return string The regular expression pattern this validator uses
*
* @psalm-return non-empty-string
* @return non-empty-string The regular expression pattern this validator uses
*/
public function getPattern(): string;
src/functions.php
-6
View File
@@ -71,9 +71,6 @@ function v2(
* @param string|UuidInterface $ns The namespace (must be a valid UUID)
*
* @return non-empty-string Version 3 UUID as a string
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*/
function v3($ns, string $name): string
{
@@ -97,9 +94,6 @@ function v4(): string
* @param string|UuidInterface $ns The namespace (must be a valid UUID)
*
* @return non-empty-string Version 5 UUID as a string
*
* @psalm-pure note: changing the internal factory is an edge case not covered by purity invariants,
* but under constant factory setups, this method operates in functionally pure manners
*/
function v5($ns, string $name): string
{
tests/benchmark/UuidSerializationBench.php
+2 -4
View File
@@ -133,8 +133,7 @@ final class UuidSerializationBench
/** @var UuidInterface */
private $uuid;
/**
* @var UuidInterface[]
* @psalm-var non-empty-list<UuidInterface>
* @var non-empty-list<UuidInterface>
*/
private $promiscuousUuids;
/** @var string */
@@ -144,8 +143,7 @@ final class UuidSerializationBench
/** @var string */
private $serializedUuid;
/**
* @var string[]
* @psalm-var non-empty-list<string>
* @var non-empty-list<string>
*/
private $serializedPromiscuousUuids;
tests/benchmark/UuidStringConversionBench.php
+5 -10
View File
@@ -132,28 +132,23 @@ final class UuidStringConversionBench
/** @var UuidInterface */
private $uuid;
/**
* @var UuidInterface[]
* @psalm-var non-empty-list<UuidInterface>
* @var non-empty-list<UuidInterface>
*/
private $promiscuousUuids;
/**
* @var string
* @psalm-var non-empty-string
* @var non-empty-string
*/
private $tinyUuidBytes;
/**
* @var string
* @psalm-var non-empty-string
* @var non-empty-string
*/
private $hugeUuidBytes;
/**
* @var string
* @psalm-var non-empty-string
* @var non-empty-string
*/
private $uuidBytes;
/**
* @var string[]
* @psalm-var non-empty-list<non-empty-string>
* @var non-empty-list<non-empty-string>
*/
private $promiscuousUuidsBytes;
tests/static-analysis/UuidIsImmutable.php
-9
View File
@@ -29,13 +29,11 @@ use Ramsey\Uuid\UuidInterface;
*/
final class UuidIsImmutable
{
/** @psalm-pure */
public static function pureCompareTo(UuidInterface $a, UuidInterface $b): int
{
return $a->compareTo($b);
}
/** @psalm-pure */
public static function pureEquals(UuidInterface $a, ?object $b): bool
{
return $a->equals($b);
@@ -43,9 +41,6 @@ final class UuidIsImmutable
/**
* @return mixed[]
*
* @psalm-pure
* @psalm-suppress DeprecatedMethod
*/
public static function pureGetters(UuidInterface $a): array
{
@@ -76,8 +71,6 @@ final class UuidIsImmutable
/**
* @return UuidInterface[]|bool[]
*
* @psalm-pure
*/
public static function pureStaticUuidApi(): array
{
@@ -90,7 +83,6 @@ final class UuidIsImmutable
];
}
/** @psalm-pure */
public static function uuid3IsPure(): UuidInterface
{
return Uuid::uuid3(
@@ -99,7 +91,6 @@ final class UuidIsImmutable
);
}
/** @psalm-pure */
public static function uuid5IsPure(): UuidInterface
{
return Uuid::uuid5(
tests/static-analysis/UuidIsNeverEmpty.php
+2 -2
View File
@@ -22,13 +22,13 @@ use Ramsey\Uuid\UuidInterface;
*/
final class UuidIsNeverEmpty
{
/** @psalm-return non-empty-string */
/** @return non-empty-string */
public function bytesAreNeverEmpty(UuidInterface $uuid): string
{
return $uuid->getBytes();
}
/** @psalm-return non-empty-string */
/** @return non-empty-string */
public function stringIsNeverEmpty(UuidInterface $uuid): string
{
return $uuid->toString();
tests/static-analysis/stubs.php
-4
View File
@@ -16,18 +16,14 @@ if (!defined('UUID_TYPE_RANDOM')) {
define('UUID_TYPE_RANDOM', 4);
}
if (!function_exists('uuid_create')) {
/** @psalm-suppress all */
function uuid_create(int $uuid_type=UUID_TYPE_DEFAULT): string {} // @phpstan-ignore-line
}
if (!function_exists('uuid_generate_md5')) {
/** @psalm-suppress all */
function uuid_generate_md5(string $uuid_ns, string $name): string {} // @phpstan-ignore-line
}
if (!function_exists('uuid_generate_sha1')) {
/** @psalm-suppress all */
function uuid_generate_sha1(string $uuid_ns, string $name): string {} // @phpstan-ignore-line
}
if (!function_exists('uuid_parse')) {
/** @psalm-suppress all */
function uuid_parse(string $uuid): string {} // @phpstan-ignore-line
}