Merge pull request #165 from patchlevel/mark-stack-hydrator-experimental

DavidBadura · web-flow · commit 22f3b9cff8aa · 2026-02-28T11:34:44.000+01:00
mark stack hydrator experimental
diff --git a/src/CoreExtension.php b/src/CoreExtension.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\Guesser\BuiltInGuesser;
 use Patchlevel\Hydrator\Middleware\TransformMiddleware;
 
+/** @experimental */
 final class CoreExtension implements Extension
 {
     public function configure(StackHydratorBuilder $builder): void
diff --git a/src/Extension.php b/src/Extension.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator;
 
+/** @experimental */
 interface Extension
 {
     public function configure(StackHydratorBuilder $builder): void;
diff --git a/src/Extension/Cryptography/Attribute/DataSubjectId.php b/src/Extension/Cryptography/Attribute/DataSubjectId.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class DataSubjectId
 {
diff --git a/src/Extension/Cryptography/Attribute/SensitiveData.php b/src/Extension/Cryptography/Attribute/SensitiveData.php
@@ -7,6 +7,7 @@
 use Attribute;
 use InvalidArgumentException;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_PROPERTY)]
 final class SensitiveData
 {
diff --git a/src/Extension/Cryptography/BaseCryptographer.php b/src/Extension/Cryptography/BaseCryptographer.php
@@ -20,6 +20,7 @@
 use function is_array;
 
 /**
+ * @experimental
  * @phpstan-type EncryptedDataV1 array{
  *     __enc: 'v1',
  *     data: non-empty-string,
diff --git a/src/Extension/Cryptography/Cipher/Cipher.php b/src/Extension/Cryptography/Cipher/Cipher.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography\Cipher;
 
+/** @experimental */
 interface Cipher
 {
     /**
diff --git a/src/Extension/Cryptography/Cipher/CipherKey.php b/src/Extension/Cryptography/Cipher/CipherKey.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography\Cipher;
 
+/** @experimental */
 final class CipherKey
 {
     /**
diff --git a/src/Extension/Cryptography/Cipher/CipherKeyFactory.php b/src/Extension/Cryptography/Cipher/CipherKeyFactory.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography\Cipher;
 
+/** @experimental */
 interface CipherKeyFactory
 {
     /** @throws CreateCipherKeyFailed */
diff --git a/src/Extension/Cryptography/Cipher/CreateCipherKeyFailed.php b/src/Extension/Cryptography/Cipher/CreateCipherKeyFailed.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
+/** @experimental */
 final class CreateCipherKeyFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
diff --git a/src/Extension/Cryptography/Cipher/DecryptionFailed.php b/src/Extension/Cryptography/Cipher/DecryptionFailed.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
+/** @experimental */
 final class DecryptionFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
diff --git a/src/Extension/Cryptography/Cipher/EncryptionFailed.php b/src/Extension/Cryptography/Cipher/EncryptionFailed.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
+/** @experimental */
 final class EncryptionFailed extends RuntimeException implements HydratorException
 {
     public function __construct()
diff --git a/src/Extension/Cryptography/Cipher/MethodNotSupported.php b/src/Extension/Cryptography/Cipher/MethodNotSupported.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class MethodNotSupported extends RuntimeException implements HydratorException
 {
     public function __construct(string $method)
diff --git a/src/Extension/Cryptography/Cipher/OpensslCipher.php b/src/Extension/Cryptography/Cipher/OpensslCipher.php
@@ -15,6 +15,7 @@
 
 use const JSON_THROW_ON_ERROR;
 
+/** @experimental */
 final class OpensslCipher implements Cipher
 {
     /** @return non-empty-string */
diff --git a/src/Extension/Cryptography/Cipher/OpensslCipherKeyFactory.php b/src/Extension/Cryptography/Cipher/OpensslCipherKeyFactory.php
@@ -11,6 +11,7 @@
 use function openssl_get_cipher_methods;
 use function openssl_random_pseudo_bytes;
 
+/** @experimental */
 final class OpensslCipherKeyFactory implements CipherKeyFactory
 {
     public const DEFAULT_METHOD = 'aes128';
diff --git a/src/Extension/Cryptography/Cryptographer.php b/src/Extension/Cryptography/Cryptographer.php
@@ -8,6 +8,7 @@
 use Patchlevel\Hydrator\Extension\Cryptography\Cipher\EncryptionFailed;
 use Patchlevel\Hydrator\Extension\Cryptography\Store\CipherKeyNotExists;
 
+/** @experimental */
 interface Cryptographer
 {
     /** @throws EncryptionFailed */
diff --git a/src/Extension/Cryptography/CryptographyExtension.php b/src/Extension/Cryptography/CryptographyExtension.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\Extension;
 use Patchlevel\Hydrator\StackHydratorBuilder;
 
+/** @experimental */
 final class CryptographyExtension implements Extension
 {
     public function __construct(
diff --git a/src/Extension/Cryptography/CryptographyMetadataEnricher.php b/src/Extension/Cryptography/CryptographyMetadataEnricher.php
@@ -12,6 +12,7 @@
 
 use function array_key_exists;
 
+/** @experimental */
 final class CryptographyMetadataEnricher implements MetadataEnricher
 {
     public function enrich(ClassMetadata $classMetadata): void
diff --git a/src/Extension/Cryptography/CryptographyMiddleware.php b/src/Extension/Cryptography/CryptographyMiddleware.php
@@ -19,6 +19,7 @@
 use function is_int;
 use function is_string;
 
+/** @experimental */
 final class CryptographyMiddleware implements Middleware
 {
     public function __construct(
diff --git a/src/Extension/Cryptography/DuplicateSubjectIdIdentifier.php b/src/Extension/Cryptography/DuplicateSubjectIdIdentifier.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class DuplicateSubjectIdIdentifier extends RuntimeException implements MetadataException
 {
     /** @param class-string $class */
diff --git a/src/Extension/Cryptography/MissingSubjectId.php b/src/Extension/Cryptography/MissingSubjectId.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class MissingSubjectId extends RuntimeException implements HydratorException
 {
     public function __construct(string $name)
diff --git a/src/Extension/Cryptography/MissingSubjectIdForField.php b/src/Extension/Cryptography/MissingSubjectIdForField.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class MissingSubjectIdForField extends RuntimeException implements HydratorException
 {
     /** @param class-string $class */
diff --git a/src/Extension/Cryptography/SensitiveDataInfo.php b/src/Extension/Cryptography/SensitiveDataInfo.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography;
 
+/** @experimental */
 final class SensitiveDataInfo
 {
     public function __construct(
diff --git a/src/Extension/Cryptography/Store/CipherKeyNotExists.php b/src/Extension/Cryptography/Store/CipherKeyNotExists.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class CipherKeyNotExists extends RuntimeException implements HydratorException
 {
     public function __construct(string $id)
diff --git a/src/Extension/Cryptography/Store/CipherKeyStore.php b/src/Extension/Cryptography/Store/CipherKeyStore.php
@@ -6,6 +6,7 @@
 
 use Patchlevel\Hydrator\Extension\Cryptography\Cipher\CipherKey;
 
+/** @experimental */
 interface CipherKeyStore
 {
     /** @throws CipherKeyNotExists */
diff --git a/src/Extension/Cryptography/Store/InMemoryCipherKeyStore.php b/src/Extension/Cryptography/Store/InMemoryCipherKeyStore.php
@@ -6,6 +6,7 @@
 
 use Patchlevel\Hydrator\Extension\Cryptography\Cipher\CipherKey;
 
+/** @experimental */
 final class InMemoryCipherKeyStore implements CipherKeyStore
 {
     /** @var array<string, CipherKey> */
diff --git a/src/Extension/Cryptography/SubjectIdAndSensitiveDataConflict.php b/src/Extension/Cryptography/SubjectIdAndSensitiveDataConflict.php
@@ -9,6 +9,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class SubjectIdAndSensitiveDataConflict extends RuntimeException implements MetadataException
 {
     /** @param class-string $class */
diff --git a/src/Extension/Cryptography/SubjectIdFieldMapping.php b/src/Extension/Cryptography/SubjectIdFieldMapping.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Cryptography;
 
+/** @experimental */
 final class SubjectIdFieldMapping
 {
     /** @param array<string, string> $nameToField */
diff --git a/src/Extension/Cryptography/SubjectIds.php b/src/Extension/Cryptography/SubjectIds.php
@@ -6,6 +6,7 @@
 
 use function array_merge;
 
+/** @experimental */
 final class SubjectIds
 {
     /** @param array<string, string> $subjectIds */
diff --git a/src/Extension/Cryptography/UnsupportedSubjectId.php b/src/Extension/Cryptography/UnsupportedSubjectId.php
@@ -10,6 +10,7 @@
 use function get_debug_type;
 use function sprintf;
 
+/** @experimental */
 final class UnsupportedSubjectId extends RuntimeException implements HydratorException
 {
     public function __construct(string $class, string $fieldName, mixed $subjectId)
diff --git a/src/Extension/Lifecycle/Attribute/PostExtract.php b/src/Extension/Lifecycle/Attribute/PostExtract.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class PostExtract
 {
diff --git a/src/Extension/Lifecycle/Attribute/PostHydrate.php b/src/Extension/Lifecycle/Attribute/PostHydrate.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class PostHydrate
 {
diff --git a/src/Extension/Lifecycle/Attribute/PreExtract.php b/src/Extension/Lifecycle/Attribute/PreExtract.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class PreExtract
 {
diff --git a/src/Extension/Lifecycle/Attribute/PreHydrate.php b/src/Extension/Lifecycle/Attribute/PreHydrate.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 
+/** @experimental */
 #[Attribute(Attribute::TARGET_METHOD)]
 final class PreHydrate
 {
diff --git a/src/Extension/Lifecycle/Lifecycle.php b/src/Extension/Lifecycle/Lifecycle.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Extension\Lifecycle;
 
+/** @experimental */
 final readonly class Lifecycle
 {
     public function __construct(
diff --git a/src/Extension/Lifecycle/LifecycleExtension.php b/src/Extension/Lifecycle/LifecycleExtension.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\Extension;
 use Patchlevel\Hydrator\StackHydratorBuilder;
 
+/** @experimental */
 final readonly class LifecycleExtension implements Extension
 {
     public function configure(StackHydratorBuilder $builder): void
diff --git a/src/Extension/Lifecycle/LifecycleMetadataEnricher.php b/src/Extension/Lifecycle/LifecycleMetadataEnricher.php
@@ -14,6 +14,7 @@
 
 use function sprintf;
 
+/** @experimental */
 final class LifecycleMetadataEnricher implements MetadataEnricher
 {
     public function enrich(ClassMetadata $classMetadata): void
diff --git a/src/Extension/Lifecycle/LifecycleMiddleware.php b/src/Extension/Lifecycle/LifecycleMiddleware.php
@@ -10,6 +10,7 @@
 
 use function assert;
 
+/** @experimental */
 final class LifecycleMiddleware implements Middleware
 {
     /**
diff --git a/src/Middleware/Middleware.php b/src/Middleware/Middleware.php
@@ -6,6 +6,7 @@
 
 use Patchlevel\Hydrator\Metadata\ClassMetadata;
 
+/** @experimental */
 interface Middleware
 {
     /**
diff --git a/src/Middleware/NoMoreMiddleware.php b/src/Middleware/NoMoreMiddleware.php
@@ -7,6 +7,7 @@
 use Patchlevel\Hydrator\HydratorException;
 use RuntimeException;
 
+/** @experimental */
 final class NoMoreMiddleware extends RuntimeException implements HydratorException
 {
     public function __construct()
diff --git a/src/Middleware/Stack.php b/src/Middleware/Stack.php
@@ -4,6 +4,7 @@
 
 namespace Patchlevel\Hydrator\Middleware;
 
+/** @experimental */
 final class Stack
 {
     private int $index = 0;
diff --git a/src/Middleware/TransformMiddleware.php b/src/Middleware/TransformMiddleware.php
@@ -17,6 +17,7 @@
 use function array_values;
 use function spl_object_id;
 
+/** @experimental */
 final class TransformMiddleware implements Middleware
 {
     /** @var array<int, class-string> */
diff --git a/src/StackHydrator.php b/src/StackHydrator.php
@@ -18,6 +18,7 @@
 
 use const PHP_VERSION_ID;
 
+/** @experimental */
 final class StackHydrator implements HydratorWithContext
 {
     /** @var array<class-string, ClassMetadata> */
diff --git a/src/StackHydratorBuilder.php b/src/StackHydratorBuilder.php
@@ -18,6 +18,7 @@
 use function array_merge;
 use function krsort;
 
+/** @experimental */
 final class StackHydratorBuilder
 {
     private bool $defaultLazy = false;

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`use Patchlevel\Hydrator\Guesser\BuiltInGuesser;`
`8`	`8`	`use Patchlevel\Hydrator\Middleware\TransformMiddleware;`
`9`	`9`
	`10`	`+/** @experimental */`
`10`	`11`	`final class CoreExtension implements Extension`
`11`	`12`	`{`
`12`	`13`	`public function configure(StackHydratorBuilder $builder): void`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Patchlevel\Hydrator;`
`6`	`6`
	`7`	`+/** @experimental */`
`7`	`8`	`interface Extension`
`8`	`9`	`{`
`9`	`10`	`public function configure(StackHydratorBuilder $builder): void;`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use Attribute;`
`8`	`8`
	`9`	`+/** @experimental */`
`9`	`10`	`#[Attribute(Attribute::TARGET_PROPERTY)]`
`10`	`11`	`final class DataSubjectId`
`11`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`use Attribute;`
`8`	`8`	`use InvalidArgumentException;`
`9`	`9`
	`10`	`+/** @experimental */`
`10`	`11`	`#[Attribute(Attribute::TARGET_PROPERTY)]`
`11`	`12`	`final class SensitiveData`
`12`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Patchlevel\Hydrator\Extension\Cryptography\Cipher;`
`6`	`6`
	`7`	`+/** @experimental */`
`7`	`8`	`interface Cipher`
`8`	`9`	`{`
`9`	`10`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`use Patchlevel\Hydrator\HydratorException;`
`8`	`8`	`use RuntimeException;`
`9`	`9`
	`10`	`+/** @experimental */`
`10`	`11`	`final class CreateCipherKeyFailed extends RuntimeException implements HydratorException`
`11`	`12`	`{`
`12`	`13`	`public function __construct()`