Collision

https://github.com/nunomaduro/collision
Admin
Collision is a package designed to give you beautiful error reporting when interacting with your app...
Tokens:68,038
Snippets:563
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### ConfigureIO usage example

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Infrastructure.md

Usage example for ConfigureIO::of(). Creates a ConsoleOutput with normal verbosity and ANSI enabled, then configures it with an ArgvInput.

```php
use NunoMaduro\Collision\Adapters\Phpunit\ConfigureIO;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Output\ConsoleOutput;

$output = new ConsoleOutput(OutputInterface::VERBOSITY_NORMAL, true);
ConfigureIO::of(new ArgvInput, $output);
```

--------------------------------

### State usage example

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-State.md

Shows how to create a State instance, add a TestResult, check existence, set duration, and get the test case title. The title can be 'PASS', 'FAIL', 'WARN', etc.

```php
use NunoMaduro\Collision\Adapters\Phpunit\State;
use NunoMaduro\Collision\Adapters\Phpunit\TestResult;

$state = new State;
$state->add($testResult);
if ($state->existsInTestCase($test)) {
    $state->setDuration($test, 12.5);
}
echo $state->getTestCaseTitle(); // "PASS" | "FAIL" | "WARN" | ...
```

--------------------------------

### addTheme() usage example

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Shows how to add themes and apply one. The example adds an 'error' theme with red and bold styles, a 'muted' theme with dark_gray, then applies the 'error' theme to the text 'boom'.

```php
$color->addTheme('error', ['red', 'bold']);
$color->addTheme('muted', 'dark_gray');
echo $color->apply('error', 'boom');
```

--------------------------------

### Usage example

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Shows how to instantiate TestException and use it with the Writer.

```php
use NunoMaduro\Collision\Exceptions\TestException;
use PHPUnit\Event\Code\Throwable;

$exception = new TestException($phpunitThrowable, verbose: false);
$writer->showTitle(false);
$writer->write(new Inspector($exception));
```

--------------------------------

### Using apply() with styles and 256-color codes

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Example usage of the apply() method. It forces styling to bypass tty detection, then applies a named style, an array of styles, and a 256-color code. The 256-color example requires are256ColorsSupported to be true.

```php
use NunoMaduro\Collision\ConsoleColor;

$color = new ConsoleColor;
$color->setForceStyle(true); // bypass tty detection

echo $color->apply('red', 'ERR');        // \033[31mERR\033[0m
echo $color->apply(['bold', 'blue'], 'x');
echo $color->apply('color_196', 'y');    // 256-color (needs are256ColorsSupported)
```

--------------------------------

### Usage example for TestResult::fromTestCase

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-State.md

Shows how to create a TestResult instance using the fromTestCase factory method and access its public properties. The example uses the FAIL type and a throwable, then echoes the icon, color, and description.

```php
use NunoMaduro\Collision\Adapters\Phpunit\TestResult;
use PHPUnit\Event\Code\Throwable;

$result = TestResult::fromTestCase($test, TestResult::FAIL, $throwable);
echo $result->icon;      // ⨯
echo $result->color;     // red
echo $result->description; // humanized name
```

--------------------------------

### Instantiate Style with ConsoleOutput

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Style.md

Example of instantiating the Style class with a ConsoleOutput instance. This is the typical usage for the PHPUnit adapter.

```php
use NunoMaduro\Collision\Adapters\Phpunit\Style;
use Symfony\Component\Console\Output\ConsoleOutput;

$style = new Style(new ConsoleOutput);
```

--------------------------------

### Artisan test command usage examples

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-TestCommand.md

Example usage of the artisan test command with various options: --coverage with --min, --compact with --profile, and --parallel with --without-databases.

```bash
php artisan test --coverage --min=80
php artisan test --compact --profile
php artisan test --parallel --without-databases
```

--------------------------------

### Install Collision with Composer

Source: https://github.com/nunomaduro/collision/blob/v8.x/README.md

Install Collision as a development dependency using Composer. Requires PHP 8.2+.

```bash
composer require nunomaduro/collision --dev
```

--------------------------------

### Install Collision ^5.0 for Laravel 8.x

Source: https://github.com/nunomaduro/collision/blob/v8.x/README.md

Install a specific Collision version (^5.0) for Laravel 8.x compatibility.

```bash
composer require nunomaduro/collision:^5.0 --dev
```

--------------------------------

### Use IgnitionSolutionsRepository with Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-Adapter.md

Usage example: Create an IgnitionSolutionsRepository with a solution provider repository)Skip and pass it to a Writer so that exceptions display suggested fixes. This wires the repository into the rendering pipeline.

```php
use NunoMaduro\Collision\Adapters\Laravel\IgnitionSolutionsRepository;
use Spatie\Ignition\Contracts\SolutionProviderRepository;

$repo = new IgnitionSolutionsRepository($solutionProviderRepository);
$writer = new Writer($repo); // exceptions now show suggested fixes
```

--------------------------------

### Usage example with ExceptionHandler

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-Adapter.md

Shows how to instantiate the decorator with the container and the original handler. After this, renderForConsole() renders through Collision for non-Symfony console exceptions.

```php
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Debug\ExceptionHandler as ExceptionHandlerContract;
use NunoMaduro\Collision\Adapters\Laravel\ExceptionHandler;

$decorator = new ExceptionHandler($container, $appExceptionHandler);
// renderForConsole() now renders through Collision for non-Symfony-console exceptions
```

--------------------------------

### Usage example for ReportablePrinter

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Printer.md

Shows how to instantiate ReportablePrinter with a DefaultPrinter and call a method like testFailed, which is forwarded and any crash is rendered as an error and exits with code 1.

```php
use NunoMaduro\Collision\Adapters\Phpunit\Printers\DefaultPrinter;
use NunoMaduro\Collision\Adapters\Phpunit\Printers\ReportablePrinter;

$printer = new ReportablePrinter(new DefaultPrinter(true));
$printer->testFailed($failedEvent); // forwarded; crashes become rendered errors + exit(1)
```

--------------------------------

### Exit if coverage unavailable

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Usage example for Coverage::isAvailable(). Exits with code 1 if coverage collection is not available.

```php
if (! Coverage::isAvailable()) {
    exit 1;
}
```

--------------------------------

### `apply(array|string $style, string $text): string`

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Documentation for the `apply()` method of the `ConsoleColor` class, including parameters, return value, exceptions, and usage examples.

```APIDOC
## `apply(array|string $style, string $text): string`

### Description
Applies one or more console color styles to the given text. Returns the text unchanged when styling is not forced or supported; otherwise wraps the text with ANSI escape sequences.

### Method
`apply`

### Signature
`public function apply(array|string $style, string $text): string`

### Parameters
- **$style** (`array<string>|string`) - Required - One or more theme names / style names / 256-color codes.
- **$text** (`string`) - Required - Text to wrap.

### Return Value
- `string` - The styled text, or the plain text if styling is not applied.

### Exceptions
- `InvalidStyleException` - A style name passed to a theme path that is not a known style (raised via `addTheme`/`setThemes`).
- `InvalidArgumentException` - `$style` is neither string nor array (`'Style must be string or array.'`).

### Usage Example
```php
use NunoMaduro\Collision\ConsoleColor;

$color = new ConsoleColor;
$color->setForceStyle(true); // bypass tty detection

echo $color->apply('red', 'ERR');        // \033[31mERR\033[0m
echo $color->apply(['bold', 'blue'], 'x');
echo $color->apply('color_196', 'y');    // 256-color (needs are256ColorsSupported)
```

### Error Handling Example
```php
use NunoMaduro\Collision\Exceptions\InvalidStyleException;

try {
    $color->addTheme('bogus', ['not-a-style']);
} catch (InvalidStyleException $e) {
    // raised for unknown style names
}
```
```

--------------------------------

### Catch RequirementsException

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Catching RequirementsException to handle the missing parallel dependencies, e.g., print a friendly hint to install ParaTest.

```php
use NunoMaduro\Collision\Adapters\Laravel\Exceptions\RequirementsException;

try {
    $command->handle();
} catch (RequirementsException $e) {
    // e.g. print-friendly hint to `composer require brianium/paratest --dev`
}
```

--------------------------------

### Method signature: register()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Returns self for chaining. Pushes the handler onto the Whoops run and installs PHP error handlers.

```php
public function register(): self
```

--------------------------------

### Report coverage and fail build if below threshold

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Usage example for Coverage::report(). Creates a ConsoleOutput, passes hideFullCoverage: true, and fails the build if coverage is below 80.0.

```php
use Symfony\Component\Console\Output\ConsoleOutput;

$coverage = Coverage::report(new ConsoleOutput, hideFullCoverage: true);
if ($coverage < 80.0) {
    // fail the build
}
```

--------------------------------

### Usage example for writeError

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Style.md

Example of using writeError with a PHPUnit Throwable to produce a full Collision report for one failure.

```php
use NunoMaduro\Collision\Adapters\Phpunit\Style;
use PHPUnit\Event\Code\Throwable;

$style->writeError($phpunitThrowable); // full Collision report for one failure
```

--------------------------------

### Catching RequirementsException from handle()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-TestCommand.md

Error handling example for the handle() method. Catches RequirementsException and outputs an error message with a red background.

```php
use NunoMaduro\Collision\Adapters\Laravel\Exceptions\RequirementsException;

try {
    $command->handle();
} catch (RequirementsException $e) {
    $this->output->writeln("<fg=white;bg=red;options=bold> ERROR </> ".$e->getMessage());
}
```

--------------------------------

### ExceptionHandler Class

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-Adapter.md

Documentation for the ExceptionHandler class, including its constructor, methods, and usage example.

```APIDOC
## Class: `ExceptionHandler`

Import path: `src/Adapters/Laravel/ExceptionHandler.php`.

`ExceptionHandler` implements `Illuminate\Contracts\Debug\ExceptionHandler` and decorates the application's original handler instance (`$appExceptionHandler`).

### Constructor

```php
public function __construct(Container $container, ExceptionHandlerContract $appExceptionHandler)
```

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$container` | `Illuminate\Contracts\Container\Container` | Yes | — | Service container used to lazily `make(Provider::class)`. |
| `$appExceptionHandler` | `Illuminate\Contracts\Debug\ExceptionHandler` | Yes | — | The original Laravel exception handler receiving the delegated calls. |

### Methods

| Method | Signature | Behavior |
|--------|-----------|----------|
| `report(Throwable $e)` | `public function report(Throwable $e)` | Delegates to `$this->appExceptionHandler->report($e)`. |
| `render($request, Throwable $e)` | `public function render($request, Throwable $e)` | Delegates (HTTP responses keep the framework's rendering). |
| `renderForConsole($output, Throwable $e)` | `public function renderForConsole($output, Throwable $e)` | If `$e instanceof Symfony\Component\Console\Exception\ExceptionInterface`, delegates to the app handler. Otherwise resolves the container's `Provider`, calls `register()->getHandler()->setOutput($output)`, does `$handler->setInspector((new Inspector($e)))`, then `$handler->handle()` — rendering the Collision report through the console output. |
| `shouldReport(Throwable $e)` | `public function shouldReport(Throwable $e)` | Delegates (return type `bool` per the contract). |
| `reportable(callable $reportUsing)` | `public function reportable(callable $reportUsing)` | Delegates; returns the app handler's `ReportableHandler`. |
| `renderable(callable $renderUsing)` | `public function renderable(callable $renderUsing)` | Delegates; returns `$this` (chainable). |
| `dontReportDuplicates()` | `public function dontReportDuplicates()` | Delegates; returns `$this` (chainable). |

### Usage (as seen in the Laravel container)

```php
use Illuminate\Contracts\Container\Container;
use Illuminate\Contracts\Debug\ExceptionHandler as ExceptionHandlerContract;
use NunoMaduro\Collision\Adapters\Laravel\ExceptionHandler;

$decorator = new ExceptionHandler($container, $appExceptionHandler);
// renderForConsole() now renders through Collision for non-Symfony-console exceptions
```
```

--------------------------------

### DefaultPrinter testPreparationStarted method

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Printer.md

Records the start time, throws ShouldNotHappen if the test is not a TestMethod, and ensures case boundary to keep deprecation events from merging into the wrong case.

```php
public function testPreparationStarted(PreparationStarted $event): void
```

--------------------------------

### RenderlessTrace usage in a custom exception

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/types.md

Example of a custom exception implementing RenderlessTrace. The comment notes that the editor snippet is shown but no stack trace is rendered.

```php
class SecurityDenied extends Exception implements RenderlessTrace
{
    // editor snippet shown, but no stack trace
}
```

--------------------------------

### Iterate missing coverage ranges

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Usage example for Coverage::getMissingCoverage(). Iterates over the missing-line ranges, each being a string like '11' or '20..25'.

```php
foreach (Coverage::getMissingCoverage($file) as $range) {
    // "11" or "20..25"
}
```

--------------------------------

### Custom bootstrap usage of EnsurePrinterIsRegisteredSubscriber::register()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Infrastructure.md

Example of calling register() directly with required environment variables. Only does something when COLLISION_PRINTER is set.

```php
// Only when a COLLISION_PRINTER env var is present does it do anything:
$_SERVER['COLLISION_PRINTER']  = 'DefaultPrinter';
$_SERVER['COLLISION_PRINTER_COMPACT'] = 'true';
NunoMaduro\Collision\Adapters\Phpunit\Subscribers\EnsurePrinterIsRegisteredSubscriber::register();
```

--------------------------------

### Throw RequirementsException for missing parallel dependencies

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Throws RequirementsException when --parallel is requested but the parallel dependencies are not installed. The message is rendered by Collision without an editor snippet or trace.

```php
if ($usesParallel && ! $this->isParallelDependenciesInstalled()) {
    throw new RequirementsException('Running Collision 8.x artisan test command in parallel requires at least ParaTest (brianium/paratest) 7.x.');
}
```

--------------------------------

### Usage of highlight()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Shows how to instantiate the Highlighter and call highlight() with a sample PHP source and line 4. The output includes line numbers and a ➜ marker on the marked line.

```php
use NunoMaduro\Collision\Highlighter;
use NunoMaduro\Collision\Writer;

$source = "<?php\n\nfunction say()\n{\n    return 'Hi';\n}\n\nsay();";

$rendered = (new Highlighter)->highlight($source, 4);
echo $rendered; // …… 3▕ function say() / ➜ 4▕ { / 5▕ return 'Hi';
```

--------------------------------

### Instantiate Writer with defaults and explicit output

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Shows two ways to create a Writer: using all defaults, or passing an explicit ConsoleOutput. The first uses default dependencies, the second overrides the output stream.

```php
use NunoMaduro\Collision\Writer;
use Symfony\Component\Console\Output\ConsoleOutput;

// Defaults
$writer = new Writer;

// Explicit output
$writer = new Writer(null, new ConsoleOutput);
```

--------------------------------

### DefaultPrinter instantiation and configuration

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Printer.md

Shows how to instantiate DefaultPrinter with colors enabled, disable decoration, and enable compact icons, slow-test profiling, and a custom recap callback.

```php
use NunoMaduro\Collision\Adapters\Phpunit\Printers\DefaultPrinter;

$printer = new DefaultPrinter(true);       // colors: true
$printer->setDecorated(false);

DefaultPrinter::compact(true);             // compact icons
DefaultPrinter::profile(true);             // top-10 slow test profiling
DefaultPrinter::addRecap(fn (State $state, Info $info, $result) => 'custom: 1');
```

--------------------------------

### getFile and getLine methods

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Return file and line from the first trace entry, with fallback to reflection.

```php
public function getFile(): string
public function getLine(): int
```

--------------------------------

### Instantiating Highlighter with UTF-8 or ASCII glyphs

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Shows how to instantiate the Highlighter with default UTF-8 glyphs or with ASCII glyphs by passing false as the second argument.

```php
use NunoMaduro\Collision\ConsoleColor;
use NunoMaduro\Collision\Highlighter;

$highlighter = new Highlighter;                       // UTF-8 glyphs
$highlighter = new Highlighter(new ConsoleColor, false); // ASCII glyphs
```

--------------------------------

### Usage: Default and custom wiring of Provider

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Shows two ways to instantiate Provider: default with no arguments, and custom with an existing Whoops Run and Handler. Both then call register().

```php
use NunoMaduro\Collision\Handler;
use NunoMaduro\Collision\Provider;
use Whoops\Run;

// Default wiring
$provider = new Provider;
$provider->register();

// Custom wiring: reuse an existing Whoops Run
$provider = new Provider(new Run, new Handler);
$provider->register();
```

--------------------------------

### Usage of getOutput() with Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Shows how to set an output stream on a Writer instance and verify that getOutput() returns the same instance. The output stream is then used to write a message.

```php
$output = new ConsoleOutput;
$writer = (new Writer)->setOutput($output);
assert $writer->getOutput() === $output;
$output->writeln('captured by the same stream');
```

--------------------------------

### Usage: getHandler() with setOutput()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Shows how to set a custom ConsoleOutput on the handler after registering the provider.

```php
use Symfony\Component\Console\Output\ConsoleOutput;

$provider = new Provider;
$output = new ConsoleOutput;

$provider->register()
    ->getHandler()
    ->setOutput($output);
```

--------------------------------

### Catching InvalidStyleException

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Example of catching InvalidStyleException when adding a theme with an invalid style name. The catch block handles the invalid style name.

```php
use NunoMaduro\Collision\ConsoleColor;
use NunoMaduro\Collision\Exceptions\InvalidStyleException;

try {
    $color->addTheme('warning', ['xdark']);
} catch (InvalidStyleException $e) {
    // invalid style name
}
```

--------------------------------

### Writer constructor signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Constructor accepts optional SolutionsRepository, OutputInterface, ArgumentFormatter, and Highlighter. Defaults are NullSolutionsRepository, ConsoleOutput, new ArgumentFormatter, and new Highlighter respectively.

```php
public function __construct(
    ?SolutionsRepository $solutionsRepository = null,
    ?OutputInterface $output = null,
    ?ArgumentFormatter $argumentFormatter = null,
    ?Highlighter $highlighter = null
)
```

--------------------------------

### Using getWriter() to configure the Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Handler.md

Shows retrieving the Writer via getWriter() and then configuring it with ignoreFilesIn() and showTrace().

```php
$writer = (new Handler)->getWriter();
$writer->ignoreFilesIn(['/vendor\/phpunit\/']);
$writer->showTrace(true);
```

--------------------------------

### addTheme(string $name, array|string $styles): void

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Adds a theme with the given name and styles. Throws exceptions for invalid styles or unknown style names.

```APIDOC
## addTheme(string $name, array|string $styles): void

### Description
Adds a theme with the given name and styles. Throws `InvalidArgumentException` if `$styles` is neither string nor array; throws `InvalidStyleException` for the first unknown style name. Existing themes with the same name are overwritten.

### Method
`addTheme`

### Signature
```php
public function addTheme(string $name, array|string $styles): void
```

### Parameters
- **$name** (string) - Required - Theme name.
- **$styles** (array<string>|string) - Required - Style names for the theme.

### Return Type
`void`

### Usage
```php
$color->addTheme('error', ['red', 'bold']);
$color->addTheme('muted', 'dark_gray');
echo $color->apply('error', 'boom');
```

```

--------------------------------

### Usage: register() with chaining

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Instantiates Provider, calls register(), and notes that uncaught exceptions render through Collision from that point.

```php
$provider = (new Provider)->register();
// From this point on, uncaught exceptions in the CLI process render through Collision.
```

--------------------------------

### Instantiating Handler with default or explicit Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Handler.md

Shows two ways to instantiate Handler: with the default Writer (no arguments) or with an explicit Writer instance.

```php
use NunoMaduro\Collision\Handler;

$handler = new Handler;               // default Writer
$handler = new Handler(new Writer);   // explicit Writer
```

--------------------------------

### isSupported(): bool

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Determines whether color output is supported based on environment variables and terminal capabilities.

```APIDOC
## isSupported(): bool

### Description
Detection logic:
1. If the environment variable `COLLISION_FORCE_COLORS` is set (documented in source as "for internal purposes only"), returns `true`.
2. On Windows (`DIRECTORY_SEPARATOR === '\\'`): `true` when `ANSICON` is set or `ConEmuANSI === 'ON'`.
3. Otherwise `true` only if `posix_isatty` exists and `STDOUT` is a tty (error suppressed).

### Method
isSupported

### Signature
```php
public function isSupported(): bool
```

### Return Value
- **bool** - `true` if color output is supported, `false` otherwise.
```

--------------------------------

### Get coverage report path

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Returns the absolute path to the serialized coverage report: <package-root>/.temp/coverage. This path is passed to the test runner as --coverage-php.

```php
public static function getPath(): string
```

--------------------------------

### State constructor

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-State.md

Initializes the State object, setting testCaseName to an empty string.

```php
public function __construct()
```

--------------------------------

### RequirementsException class declaration

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Exception thrown by TestCommand::handle() when --parallel is requested but the parallel dependencies are not installed. Its message is rendered by Collision without an editor snippet or trace.

```php
final class RequirementsException extends RuntimeException implements RenderlessEditor, RenderlessTrace {}
```

--------------------------------

### Catch RequirementsException for parallel artisan test

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/errors.md

Catches RequirementsException thrown by TestCommand::handle() when running with --parallel without ParaTest 7.x. The comment suggests installing brianium/paratest as a dev dependency.

```php
use NunoMaduro\Collision\Adapters\Laravel\Exceptions\RequirementsException;

try {
    $command->handle();
} catch (RequirementsException $e) {
    // composer require brianium/paratest --dev
}
```

--------------------------------

### Custom SolutionsRepository usage with Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/types.md

Shows a custom implementation that returns a Solution for a ConnectionRefusedException and an empty array otherwise. The repository is then passed to the Writer constructor.

```php
class MySolutionsRepository implements SolutionsRepository
{
    public function getFromThrowable(Throwable $throwable): array
    {
        if ($throwable instanceof ConnectionRefusedException) {
            return [new Solution(
                'Check the service',
                'Ensure the MySQL container is running.',
                ['https://example.com/docs/connect'],
            )];
        }

        return [];
    }
}

$writer = new Writer(new MySolutionsRepository);
```

--------------------------------

### Get missing coverage ranges

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Returns the line numbers with no executed tests as compact ranges, e.g. ['11', '20..25']. Contiguous missing lines are merged, and the range orientation is preserved.

```php
public static function getMissingCoverage($file): array
```

--------------------------------

### Instantiate Laravel Inspector

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-Adapter.md

Shows how to import and instantiate the Laravel Inspector, asserting that it is an instance of Whoops' base Inspector. Use this when you need to create an inspector for a throwable in a Laravel context.

```php
use NunoMaduro\Collision\Adapters\Laravel\Inspector;
use Whoops\Exception\Inspector as BaseInspector;

assert new Inspector($throwable) instanceof BaseInspector;
```

--------------------------------

### Constructor signature for Provider

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Defines the constructor with optional RunInterface and Handler parameters. When null, defaults to new Run and new Handler respectively.

```php
public function __construct(?RunInterface $run = null, ?Handler $handler = null)
```

--------------------------------

### Chaining setOutput() with ConsoleOutput

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Handler.md

Shows chaining setOutput() with a ConsoleOutput and then calling handle(). The output stream is passed to the embedded Writer.

```php
use Symfony\Component\Console\Output\ConsoleOutput;

(new Handler)
    ->setOutput(new ConsoleOutput)
    ->handle();
```

--------------------------------

### getOutput() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Returns the currently configured output stream as an OutputInterface instance.

```php
public function getOutput(): OutputInterface
```

--------------------------------

### getCode method

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Always returns 0 for interface compatibility.

```php
public function getCode(): int
```

--------------------------------

### Highlighter::__construct

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Constructor for the Highlighter class, allowing optional custom ConsoleColor and UTF-8 glyph configuration.

```APIDOC
## Constructor

### Description
Creates a new Highlighter instance with optional custom ConsoleColor and UTF-8 glyph support.

### Method
__construct

### Signature
```php
public function __construct(?ConsoleColor $color = null, bool $UTF8 = true)
```

### Parameters
- **$color** (?ConsoleColor) - Optional - The ANSI style engine used to apply colors. Defaults to a new ConsoleColor instance.
- **$UTF8** (bool) - Required - When true, uses UTF-8 glyphs (➜ / ▕); when false, uses ASCII glyphs (> / |). Defaults to true.

### Usage Example
```php
use NunoMaduro\Collision\ConsoleColor;
use NunoMaduro\Collision\Highlighter;

$highlighter = new Highlighter;                       // UTF-8 glyphs
$highlighter = new Highlighter(new ConsoleColor, false); // ASCII glyphs
```
```

--------------------------------

### DefaultPrinter testRunnerExecutionStarted method

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Printer.md

Intentionally empty method for the ExecutionStarted event.

```php
public function testRunnerExecutionStarted(ExecutionStarted $executionStarted): void
```

--------------------------------

### Render coverage report

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Renders a per-file coverage table and total percentage to the console. Returns the total percentage as a float. If the report file does not exist, prints a warning and returns 0.0. When hideFullCoverage is true, files at exactly 100.0% are skipped.

```php
public static function report(OutputInterface $output, bool $hideFullCoverage = false): float
```

--------------------------------

### highlight(string $content, int $line): string

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Renders a colorized code snippet from the given PHP source, marking the specified line with an arrow. It returns a snippet with 4 lines before and after the marked line, right-trimmed.

```APIDOC
## Method: `highlight()`

### Description
Renders a colorized code snippet from the given PHP source, marking the specified line with an arrow. It returns a snippet with 4 lines before and after the marked line, right-trimmed.

### Signature
```php
public function highlight(string $content, int $line): string
```

### Parameters
- **$content** (string) - Required - Full PHP source to tokenize and render.
- **$line** (int) - Required - 1-based line number to mark with the arrow.

### Return Value
- **string** - The rendered, colorized code snippet (Termwind-style markup may be present in the color strings, e.g. `\033[...m` ANSI sequences).

### Usage Example
```php
use NunoMaduro\Collision\Highlighter;

$source = "<?php\n\nfunction say()\n{\n    return 'Hi';\n}\n\nsay();";

$rendered = (new Highlighter)->highlight($source, 4);
echo $rendered; // …… 3▕ function say() / ➜ 4▕ { / 5▕ return 'Hi';
```
```

--------------------------------

### DefaultPrinter constructor

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Printer.md

Constructor for DefaultPrinter. Accepts a boolean for colored output, creates a ConsoleOutput with normal verbosity, configures IO from argv, sets output for Pest events, snapshots verbosity, and builds a Style and State.

```php
public function __construct(bool $colors)
```

--------------------------------

### Highlighter constructor signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Constructor signature. Accepts an optional ConsoleColor instance and a UTF8 flag. When UTF8 is true, uses UTF-8 glyphs (➜ / ▕); when false, uses ASCII ( > / | ).

```php
public function __construct(?ConsoleColor $color = null, bool $UTF8 = true)
```

--------------------------------

### CollisionServiceProvider boot method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-Adapter.md

Signature of the boot method that registers the TestCommand as a console command via $this->commands([TestCommand::class]).

```php
public function boot(): void
```

--------------------------------

### getOutput()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Returns the currently configured output stream as an OutputInterface instance.

```APIDOC
## `getOutput()`

### Description
Returns the currently configured output stream.

### Method
`getOutput()`

### Signature
```php
public function getOutput(): OutputInterface
```

### Return Value
- `OutputInterface` - The output stream in use.

### Usage Example
```php
$output = new ConsoleOutput;
$writer = (new Writer)->setOutput($output);
assert $writer->getOutput() === $output;
$output->writeln('captured by the same stream');
```
```

--------------------------------

### Style constructor signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Style.md

Constructor signature for the Style class. It requires a ConsoleOutputInterface instance and throws ShouldNotHappen if the output is not a ConsoleOutput instance. It captures the terminal width for layout calculations.

```php
public function __construct(ConsoleOutputInterface $output)
```

--------------------------------

### Highlighter Public Constants

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Public constants defining theme names for token styling and line markers.

```APIDOC
## Public Constants

### Description
Theme names used for token styling and line markers. These are registered on the internal ConsoleColor instance.

### Constants
- **TOKEN_DEFAULT** = 'token_default'
- **TOKEN_COMMENT** = 'token_comment'
- **TOKEN_STRING** = 'token_string'
- **TOKEN_HTML** = 'token_html'
- **TOKEN_KEYWORD** = 'token_keyword'
- **ACTUAL_LINE_MARK** = 'actual_line_mark'
- **LINE_NUMBER** = 'line_number'

### Usage
These constants are used internally to register themes on the ConsoleColor instance.
```

--------------------------------

### getPossibleStyles(): array

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Returns every style name in the STYLES constant as an array of strings.

```APIDOC
## getPossibleStyles(): array

### Description
Returns every style name in `STYLES` as an array of strings.

### Method
getPossibleStyles

### Signature
```php
public function getPossibleStyles(): array
```

### Return Value
- **array** - An array of style name strings.
```

--------------------------------

### TestCommand handle() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Laravel-TestCommand.md

Method signature for the handle() method. The method orchestrates the test execution, including coverage and parallel guards, process spawning, and output streaming.

```php
public function handle()
```

--------------------------------

### showEditor() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Defines the showEditor method that toggles whether the file/line location and highlighted code snippet are rendered. Returns the Writer instance for chaining.

```php
public function showEditor(bool $show): self
```

--------------------------------

### showTrace() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Defines the showTrace method that toggles whether the stack trace section is rendered. Returns the Writer instance for chaining.

```php
public function showTrace(bool $show): self
```

--------------------------------

### showTrace(bool $show): self

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Configures whether the stack trace section is rendered in the output.

```APIDOC
## `showTrace(bool $show): self`

### Description
Sets whether the stack trace section is rendered.

### Method
`showTrace`

### Parameters
- `$show` (bool) - Required - Whether the stack trace section is rendered.

### Return
- `self` - The same `Writer` instance.
```

--------------------------------

### highlight() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Declares the public highlight() method that takes a PHP source string and a 1-based line number, returning a right-trimmed snippet with 4 lines of context before and after the marked line.

```php
public function highlight(string $content, int $line): string
```

--------------------------------

### End-to-end flow diagram

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Phpunit-Infrastructure.md

ASCII diagram showing the flow from Composer autoload through PHPUnit events to the DefaultPrinter's testRunnerExecutionFinished().

```text
Composer autoload  → Autoload.php
                     └─ EnsurePrinterIsRegisteredSubscriber::register()   [guarded by COLLISION_PRINTER]
PHPUnit Started    → EnsurePrinterIsRegisteredSubscriber::notify()
                     ├─ new ReportablePrinter(new DefaultPrinter(true))
                     └─ registers ~24 event subscriber classes
Per-test events    → subscriber.notify() → ReportablePrinter::__call() → DefaultPrinter::test*()
                     └─ State / TestResult aggregation → Style rendering
Run finished       → ExecutionFinishedSubscriber → DefaultPrinter::testRunnerExecutionFinished()
```

--------------------------------

### NunoMaduro\Collision\Writer

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Documentation for the Writer class constructor and its constants.

```APIDOC
## Class: `NunoMaduro\Collision\Writer`

### Description
`Writer` is the central renderer that takes a Whoops `Inspector` and prints the classic Collision layout — a red title bar with the exception class, the message, an optional editor code snippet pointing at the origin frame, optional recommended solutions, and an optional stack trace. It is a `final` class marked `@internal`.

### Import Path
`src/Writer.php` — PSR-4 autoload `NunoMaduro\Collision\` → `src/`.

### Constants
- `VERBOSITY_NORMAL_FRAMES` (int) - The maximum number of user (non-vendor) stack frames shown at normal verbosity (see `renderTrace()`).

### Constructor

```php
public function __construct(
    ?SolutionsRepository $solutionsRepository = null,
    ?OutputInterface $output = null,
    ?ArgumentFormatter $argumentFormatter = null,
    ?Highlighter $highlighter = null
)
```

#### Parameters
- `$solutionsRepository` (?SolutionsRepository) - Optional - Repository consulted to suggest fixes for the thrown exception. Default: `new NullSolutionsRepository`.
- `$output` (?Symfony\Component\Console\Output\OutputInterface) - Optional - Destination stream for all rendered output. Default: `new ConsoleOutput`.
- `$argumentFormatter` (?ArgumentFormatter) - Optional - Formats frame function arguments in trace lines. Default: `new ArgumentFormatter`.
- `$highlighter` (?Highlighter) - Optional - Produces the syntax-highlighted editor snippet. Default: `new Highlighter`.

#### Usage Example

```php
use NunoMaduro\Collision\Writer;
use Symfony\Component\Console\Output\ConsoleOutput;

// Defaults
$writer = new Writer;

// Explicit output
$writer = new Writer(null, new ConsoleOutput);
```
```

--------------------------------

### getCodeSnippet(string $source, int $lineNumber, int $linesBefore = 2, int $linesAfter = 2): string

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Generates a colored code snippet with a line-number gutter and an optional marker on a specified line. It normalizes line endings, tokenizes the source, and slices a window of context lines around the marked line.

```APIDOC
## Method: `getCodeSnippet()`

### Description
Generates a colored code snippet with a line-number gutter and an optional marker on a specified line. It normalizes line endings, tokenizes the source, and slices a window of context lines around the marked line.

### Signature
```php
public function getCodeSnippet(string $source, int $lineNumber, int $linesBefore = 2, int $linesAfter = 2): string
```

### Parameters
- **$source** (string) - Required - Full PHP source.
- **$lineNumber** (int) - Required - 1-based line to mark; `null` marks no line (line numbers are still printed).
- **$linesBefore** (int) - Optional - Default `2` - Number of context lines above the marked line.
- **$linesAfter** (int) - Optional - Default `2` - Number of context lines below the marked line.

### Behavior
Normalizes `\r\n`/`\r` to `\n`, tokenizes, splits tokens into lines, slices the window `[$lineNumber - $linesBefore - 1, $linesAfter + $linesBefore + 1)` (clamped at 0), colors each line, then renders line numbers with a left margin, a `STR_PAD_LEFT`-padded number column of at least width 3 (or the width of the largest line number), the delimiter glyph, the source line, and a `➜` / `>` marker in red on the marked line.

### Return Value
- **string** - Full colored snippet including line-number gutter and mark.

### Usage Example
```php
echo (new Highlighter)->getCodeSnippet($source, 3, 1, 1); // 1 line above, 1 below
```
```

--------------------------------

### setThemes(array $themes): void

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Sets the theme map, clearing all existing themes and re-adding each via addTheme.

```APIDOC
## setThemes(array $themes): void

### Description
Sets the theme map, clearing all existing themes and re-adding each via `addTheme`.

### Method
`setThemes`

### Signature
```php
public function setThemes(array $themes): void
```

### Parameters
- **$themes** (array<string, array|string>) - Required - Map of theme name → style names.

### Return Type
`void`

```

--------------------------------

### NullSolutionsRepository implementation

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/types.md

A final class implementing SolutionsRepository that always returns an empty array. Used as a default when no solutions repository is provided.

```php
final class NullSolutionsRepository implements SolutionsRepository
{
    public function getFromThrowable(Throwable $throwable): array
    {
        return [];
    }
}
```

--------------------------------

### getThemes(): array

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Returns the full theme map.

```APIDOC
## getThemes(): array

### Description
Returns the full theme map (`array<string, array<string>>`).

### Method
`getThemes`

### Signature
```php
public function getThemes(): array
```

### Parameters
None.

### Return Type
`array<string, array<string>>` - The theme map.

```

--------------------------------

### Highlighter public constants

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Highlighter.md

Defines the theme keys used by the highlighter. These names are registered as themes on the internal ConsoleColor instance.

```php
public const TOKEN_DEFAULT = 'token_default';
public const TOKEN_COMMENT = 'token_comment';
public const TOKEN_STRING = 'token_string';
public const TOKEN_HTML = 'token_html';
public const TOKEN_KEYWORD = 'token_keyword';
public const ACTUAL_LINE_MARK = 'actual_line_mark';
public const LINE_NUMBER = 'line_number';
```

--------------------------------

### addTheme() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/ConsoleColor.md

Adds a theme with the given name and styles. Throws InvalidArgumentException if styles is neither string nor array; throws InvalidStyleException for the first unknown style name. Existing themes with the same name are overwritten.

```php
public function addTheme(string $name, array|string $styles): void
```

--------------------------------

### RenderlessEditor

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/types.md

Documentation for the RenderlessEditor marker interface.

```APIDOC
## RenderlessEditor Interface

### Description
Marker interface that indicates an exception should not render the editor. When an exception implements this interface, the Collision writer skips the `renderEditor()` step, showing only the message and trace without a file editor snippet.

### Interface Definition
```php
interface RenderlessEditor {}
```

### Usage Example
```php
class BusinessRuleViolation extends Exception implements RenderlessEditor
{
    // message-only report: no file editor snippet, trace still shown
}
```
```

--------------------------------

### getTrace method

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Parses the trace string into an array of file/line pairs.

```php
public function getTrace(): array
```

--------------------------------

### Provider Class

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Provider.md

Documentation for the Provider class, including its constructor, register method, and getHandler method.

```APIDOC
## Constructor: `__construct()`

### Description
Creates a new Provider instance, optionally accepting a Whoops RunInterface and a Collision Handler. If not provided, defaults are used.

### Method
`__construct`

### Signature
```php
public function __construct(?RunInterface $run = null, ?Handler $handler = null)
```

### Parameters
- `$run` (?RunInterface) - Optional - The Whoops run instance that dispatches errors to handlers. Defaults to `new Run`.
- `$handler` (?Handler) - Optional - The Collision handler to push onto the run. Defaults to `new Handler`.

### Usage
```php
use NunoMaduro\Collision\Handler;
use NunoMaduro\Collision\Provider;
use Whoops\Run;

// Default wiring
$provider = new Provider;
$provider->register();

// Custom wiring: reuse an existing Whoops Run
$provider = new Provider(new Run, new Handler);
$provider->register();
```
```

```APIDOC
## Method: `register()`

### Description
Pushes the configured Handler onto the Whoops run and registers the PHP error handler. Returns the Provider instance for chaining.

### Method
`register`

### Signature
```php
public function register(): self
```

### Parameters
None.

### Return Value
- `self` - The same Provider instance, enabling chaining.

### Usage
```php
$provider = (new Provider)->register();
// From this point on, uncaught exceptions in the CLI process render through Collision.
```
```

```APIDOC
## Method: `getHandler()`

### Description
Returns the Handler instance owned by this provider. This is the recommended way to reach the handler to configure its Writer or invoke it manually.

### Method
`getHandler`

### Signature
```php
public function getHandler(): Handler
```

### Parameters
None.

### Return Value
- `Handler` - The Collision Handler created in the constructor.

### Usage
```php
use Symfony\Component\Console\Output\ConsoleOutput;

$provider = new Provider;
$output = new ConsoleOutput;

$provider->register()
    ->getHandler()
    ->setOutput($output);
```
```

--------------------------------

### Coverage::report()

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Coverage.md

Renders a per-file coverage table and total percentage to the console. Returns the total coverage percentage as a float.

```APIDOC
## Coverage::report()

### Description
Renders a per-file coverage table and total percentage to the console. If the coverage report file does not exist, prints a warning and returns 0.0. Otherwise, loads the report, deletes the file, and outputs each file's coverage with missing-line ranges and a total percentage.

### Method
`public static function report(OutputInterface $output, bool $hideFullCoverage = false): float`

### Parameters
- **$output** (`Symfony\Component\Console\Output\OutputInterface`) - Required - Destination stream for the report.
- **$hideFullCoverage** (`bool`) - Required - When `true`, files at exactly 100.0% coverage are skipped. The Laravel `--compact` option sets this.

### Return
- **float** - Total percentage of executed lines across the report (0.0 when no report file exists).

### Usage
```php
use Symfony\Component\Console\Output\ConsoleOutput;

$coverage = Coverage::report(new ConsoleOutput, hideFullCoverage: true);
if ($coverage < 80.0) {
    // fail the build
}
```

```

--------------------------------

### write(Inspector $inspector): void

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Renders the full report for an exception wrapped in a Whoops Inspector, including title, description, editor snippet, solutions, and stack trace.

```APIDOC
## [METHOD] write(Inspector $inspector): void

### Description
Renders the full report for an exception wrapped in a Whoops `Whoops\Exception\Inspector`. The report includes a title and description, an editor snippet (if enabled and applicable), solutions from the SolutionsRepository, and a stack trace (if enabled and applicable).

### Method
WRITE

### Endpoint
N/A - This is a PHP method, not an HTTP endpoint.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **$inspector** (Inspector) - Required - The Whoops Inspector wrapping the exception to render.

### Request Example
```php
use NunoMaduro\Collision\Writer;
use Whoops\Exception\Inspector;

$writer = new Writer;
$writer->write(new Inspector($myException));
```

### Response
#### Success Response (200)
No return value (void). Output is written directly to the output buffer.

#### Response Example
No response body.

### Error Handling
No explicit error handling documented.
```

--------------------------------

### showTitle() method signature

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Writer.md

Defines the showTitle method that toggles whether the red class-name bar and bold message line are rendered. Returns the Writer instance for chaining.

```php
public function showTitle(bool $show): self
```

--------------------------------

### __toString method

Source: https://github.com/nunomaduro/collision/blob/v8.x/_autodocs/api-reference/Exceptions.md

Returns the message from getMessage().

```php
public function __toString()
```
Tokens:
Raw