Skip to content

Commit 935790b

Browse files
committed
add default type repository docs
1 parent 8fab3bc commit 935790b

File tree

1 file changed

+55
-4
lines changed

1 file changed

+55
-4
lines changed

src/Kernel/Repository/Factory/DefaultTypeRepositoryFactory.php

Lines changed: 55 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,73 @@
2424
*/
2525
final class DefaultTypeRepositoryFactory implements TypeRepositoryFactoryInterface
2626
{
27-
public const DEFAULT_TRACING_OPTION = false;
28-
public const DEFAULT_TYPE_CAST_TRACING_OPTION = true;
29-
public const DEFAULT_TYPE_MATCH_TRACING_OPTION = false;
27+
/**
28+
* Default value for {@see DefaultTypeRepositoryFactory::$enableLogging}
29+
*/
3030
public const DEFAULT_LOGGING_OPTION = false;
31-
public const DEFAULT_TYPE_CAST_LOGGING_OPTION = false;
31+
32+
/**
33+
* Default value for {@see DefaultTypeRepositoryFactory::$enableTypeMatchLogging}
34+
*/
3235
public const DEFAULT_TYPE_MATCH_LOGGING_OPTION = true;
36+
37+
/**
38+
* Default value for {@see DefaultTypeRepositoryFactory::$enableTypeCastLogging}
39+
*/
40+
public const DEFAULT_TYPE_CAST_LOGGING_OPTION = false;
41+
42+
/**
43+
* Default value for {@see DefaultTypeRepositoryFactory::$enableTracing}
44+
*/
45+
public const DEFAULT_TRACING_OPTION = false;
46+
47+
/**
48+
* Default value for {@see DefaultTypeRepositoryFactory::$enableTypeMatchTracing}
49+
*/
50+
public const DEFAULT_TYPE_MATCH_TRACING_OPTION = false;
51+
52+
/**
53+
* Default value for {@see DefaultTypeRepositoryFactory::$enableTypeCastTracing}
54+
*/
55+
public const DEFAULT_TYPE_CAST_TRACING_OPTION = true;
56+
57+
/**
58+
* Default value for {@see DefaultTypeRepositoryFactory::$enableMemoization}
59+
*/
3360
public const DEFAULT_MEMOIZATION_OPTION = true;
3461

3562
public function __construct(
63+
/**
64+
* Enables or disables logging of type retrieval from the repository
65+
*/
3666
private readonly bool $enableLogging = self::DEFAULT_LOGGING_OPTION,
67+
/**
68+
* Enables or disables logging of type matching processes
69+
*/
3770
private readonly bool $enableTypeMatchLogging = self::DEFAULT_TYPE_MATCH_TRACING_OPTION,
71+
/**
72+
* Enables or disables logging of type casting processes
73+
*/
3874
private readonly bool $enableTypeCastLogging = self::DEFAULT_TYPE_CAST_TRACING_OPTION,
75+
/**
76+
* Enables or disables tracing of type retrieval from the repository
77+
*/
3978
private readonly bool $enableTracing = self::DEFAULT_TRACING_OPTION,
79+
/**
80+
* Enables or disables tracing of type matching processes
81+
*/
4082
private readonly bool $enableTypeMatchTracing = self::DEFAULT_TYPE_MATCH_LOGGING_OPTION,
83+
/**
84+
* Enables or disables tracing of type casting processes
85+
*/
4186
private readonly bool $enableTypeCastTracing = self::DEFAULT_TYPE_CAST_LOGGING_OPTION,
87+
/**
88+
* Enables or disables storing types in memory for quick retrieval
89+
*/
4290
private readonly bool $enableMemoization = self::DEFAULT_MEMOIZATION_OPTION,
91+
/**
92+
* Printer instance for displaying types in tracing
93+
*/
4394
private readonly PrinterInterface $typeTracingPrinter = new PrettyPrinter(
4495
wrapUnionType: false,
4596
multilineShape: \PHP_INT_MAX,

0 commit comments

Comments
 (0)