API reference
Generated by reflection (docs/scripts/reflect-api.php) over all three packages' src/, not written by hand — every signature, parameter and default value here is read straight from the code, not transcribed from it. Only @api-annotated types get a page; @internal classes are implementation detail and stay undocumented on purpose.
Core
| Type | Kind | Summary |
|---|---|---|
ArrayArbitrary | class | Generates lists whose elements come from a delegate arbitrary and shrinks them by length toward… |
BoolArbitrary | class | Generates booleans. |
BytesArbitrary | class | Generates raw byte strings (every byte 0..255, not printable text) and shrinks them by length… |
CharsetStringArbitrary | class | Generates strings whose characters come from a fixed alphabet, and shrinks them by length toward… |
CommandSequenceArbitrary | class | Generates valid Command sequences for stateful / model-based testing and shrinks them by dropping… |
ConstantArbitrary | class | Always produces the same fixed value. |
DateTimeArbitrary | class | Generates UTC DateTimeImmutable values with a Unix timestamp drawn uniformly from an inclusive… |
DictionaryArbitrary | class | Generates associative arrays (maps) whose keys come from a key arbitrary and whose values come… |
FilteredArbitrary | class | Generates values from a delegate arbitrary, retrying until a predicate holds. |
FlatMappedArbitrary | class | Dependent generators (monadic bind): each value produced by the source arbitrary is fed into a… |
FloatArbitrary | class | Generates floats in the half-open range [min, max). |
FrequencyArbitrary | class | Weighted choice among several arbitraries: each [weight, arbitrary] pair is picked with… |
IntArbitrary | class | Generates integers within an inclusive range and shrinks them toward zero (clamped into the range,… |
MappedArbitrary | class | Transforms each value produced by a delegate arbitrary through a pure function. |
NullableArbitrary | class | Wraps another arbitrary and additionally yields null with roughly even odds. |
OneOfArbitrary | class | Picks a value uniformly at random from a fixed set. |
RecordArbitrary | class | Fixed-shape associative array: produces a map with one value per named field, each drawn from that… |
StringArbitrary | class | Generates random strings and shrinks them by length toward the empty string, then… |
SubsetArbitrary | class | Generates subsets of a fixed ordered set: every result is a list of distinct elements of the… |
TupleArbitrary | class | Fixed-arity tuple: produces a list with one value per element arbitrary, in order. |
UniqueArrayArbitrary | class | Generates lists of pairwise-distinct elements (strict comparison) drawn from a delegate arbitrary,… |
UuidArbitrary | class | Generates RFC 4122 version 4 (random) UUID strings in the canonical… |
ArbitraryInterface | interface | Describes a space of random values with integrated shrinking. |
Assume | class | Discard a property run when a precondition does not hold. |
Classify | class | Records distribution labels for the current property run so the runner can report how often each… |
CounterExample | class | Minimal failing input for a property, captured at falsification time. |
CoverageViolationException | class | Thrown (as the failure of an otherwise passing property) when a coverage requirement registered… |
DeadlineExceededException | class | Thrown (as the failure of a property) when a single run's body takes longer than the… |
CorpusPruned | class | A recorded entry no longer fails and was removed from the corpus. |
CorpusReplayed | class | A recorded regression entry is about to replay before the random phase. |
CorpusStored | class | A falsification's minimised counterexample was recorded in the corpus. |
ExampleFinished | class | An explicit example finished. |
ExampleStarted | class | An explicit example is about to execute, before the random phase. |
PropertyEvent | interface | Marker for the engine's lifecycle events. |
PropertyFinished | class | The property finished. |
PropertyStarted | class | The property is about to run: examples first, then corpus replay, then the random phase. |
RunDiscarded | class | A random-phase attempt was discarded via Assume — neither a failure nor a successful check. |
RunFailed | class | A random-phase attempt falsified the property; shrinking follows. |
RunPassed | class | A random-phase attempt completed without failing. |
RunStarted | class | A random-phase attempt is about to execute the property body. |
ShrinkAccepted | class | A shrink candidate still failed and became the new current counterexample. |
ShrinkTried | class | One shrink trial executed the body with a smaller candidate for a single parameter (or draw#N… |
ExampleViolationException | class | Reported when an explicit example (a fixed input declared via the property's Examples method)… |
GaveUpException | class | Thrown (as the failure of a property) when discarded inputs exceed the configured budget before… |
Gen | class | Facade with static factories for the built-in ArbitraryInterfaces. |
GenerationExhausted | class | Thrown when a bounded-attempt generator cannot produce a value that satisfies its constraint… |
PropertyListener | interface | Observer of a property run's lifecycle events. |
PropertyViolationException | class | Reported when a property is falsified. |
Random | class | Seedable, deterministic pseudo-random number generator. |
RegressionViolationException | class | Reported when a recorded regression fails again: the minimised input of an earlier failure,… |
CallableTrialExecutor | class | The standalone executor: a plain callback is the property body. |
Clock | interface | Monotonic time source behind the per-run deadline and the phase budget. |
Corpus | interface | Persistent store of past falsifications, replayed before the random phase. |
CorpusEntry | class | One recorded regression in a property's corpus: either the minimised failing input itself (a… |
CoverageFailed | class | Every run passed, but a Classify::cover() requirement was under-covered — the pass is… |
DeadlineExceeded | class | A single run (random, example or regression replay) took longer than the per-run deadline. |
ExampleFailed | class | An explicit example failed before the random phase. |
Falsified | class | A random run falsified the property; the counterexample is shrunk. |
FilesystemCorpus | class | Opt-in on-disk corpus of a property's past failures, replayed before the random phase so a fixed… |
GaveUp | class | Discards exceeded the budget before the requested checks completed. |
GenerationFailed | class | A generator could not produce a valid value (e.g. |
MonotonicClock | class | |
Passed | class | Every check completed and every coverage requirement held. |
PropertyConfig | class | Resolved knobs of one property run. |
PropertyDefinition | class | One property, fully resolved for the engine: no attribute, no reflection, no environment. |
PropertyResult | interface | Structured outcome of a property run. |
PropertyRunner | class | The framework-agnostic property engine: runs the explicit examples, replays the regression corpus,… |
RegressionFailed | class | A recorded regression (a values corpus entry) failed again on replay. |
RunStatistics | class | Counters of a random phase, carried by the results whose reporting needs them: the classification… |
TimeBudgetExceeded | class | The whole random phase overran its wall-clock budget before the requested checks completed. |
TrialExecutor | interface | Executes the property body once with the given arguments. |
TrialOutcome | class | Result of executing the property body once, in the engine's terms. |
Shrinkable | class | A generated value together with a lazy tree of progressively "smaller" variants of it — the unit… |
Command | interface | A single operation in a stateful / model-based test. |
CommandSequence | class | A generated, valid-by-construction sequence of Commands together with the initial model it was… |
PostconditionViolation | class | Thrown by StateMachine::check() when a command's Command::postCondition() returns false. |
StateMachine | class | Drives a CommandSequence against a fresh system under test for stateful / model-based testing. |
TimeBudgetExceededException | class | Thrown (as the failure of a property) when the random phase's wall-clock time exceeds the… |
ValueRenderer | class | Renders an arbitrary value into a compact, human-readable string for counterexample reporting. |
Testo adapter
| Type | Kind | Summary |
|---|---|---|
Property | class | Marks a test method as a property: the PropertyInterceptor takes over, generating random arguments… |
PropertyInterceptor | class | The Testo adapter for a Property: resolves the test framework's conventions — the attribute, the… |
PHPUnit adapter
| Type | Kind | Summary |
|---|---|---|
PropertyCheck | class | Fluent builder mapping the engine's structured PropertyResult onto PHPUnit: a pass counts one… |