Spatie Ignition

https://github.com/spatie/ignition
Admin
Spatie Ignition is a beautiful and customizable error page for PHP applications that helps...
Tokens:38,148
Snippets:475
Trust Score:8.5
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Complete Setup Example

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Demonstrates conditional configuration for development and production environments, including AI solution providers and Flare reporting settings.

```php
<?php

use Spatie\
Ignition\
Ignition;
use Spatie\
Ignition\
Solutions\
OpenAi\
OpenAiSolutionProvider;

// Detect environment
$isDev = $_ENV['APP_ENV'] === 'local';
$isProd = $_ENV['APP_ENV'] === 'production';

// Build ignition
$ignition = Ignition::make()
    ->applicationPath(__DIR__);

// Development: show everything
if ($isDev) {
    $ignition
        ->setTheme('dark')
        ->setEditor('vscode')
        ->shouldDisplayException(true);
    
    // Optional: AI solutions in dev
    if ($_ENV['OPENAI_API_KEY'] ?? false) {
        $aiProvider = new OpenAiSolutionProvider($_ENV['OPENAI_API_KEY']);
        $ignition->addSolutionProviders([$aiProvider]);
    }
}

// Production: hide details, send to Flare
if ($isProd) {
    $ignition
        ->runningInProductionEnvironment(true)
        ->shouldDisplayException(false)
        ->sendToFlare($_ENV['FLARE_API_KEY'] ?? null)
        ->configureFlare(function ($flare) {
            $flare->censorRequestBodyFields(['password', 'token']);
            $flare->anonymizeIp();
        });
}

// Always register
$ignition->register();
```

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

### Full Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

A comprehensive example showing all available configuration keys and their default types.

```json
{
    "theme": "dark",
    "editor": "phpstorm",
    "hide_solutions": false,
    "enable_share_button": true,
    "enable_runnable_solutions": false,
    "remote_sites_path": "/var/www/app",
    "local_sites_path": "/Users/dev/projects/app",
    "share_endpoint": "https://flareapp.io/api/public-reports",
    "editor_options": {}
}
```

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

### Implement Custom Solution Provider

Source: https://github.com/spatie/ignition/blob/main/_autodocs/types.md

Example of implementing the interface and registering the provider with the Ignition instance.

```php
use Spatie\ErrorSolutions\Contracts\HasSolutionsForThrowable;
use Spatie\
ErrorSolutions\Contracts\Solution;
use Throwable;

class CustomSolutionProvider implements HasSolutionsForThrowable
{
    public function canSolve(Throwable $throwable): bool
    {
        return $throwable instanceof MyCustomException;
    }
    
    public function getSolutions(Throwable $throwable): array
    {
        return [
            new MyCustomSolution($throwable->getMessage()),
        ];
    }
}

// Register with Ignition
Ignition::make()
    ->addSolutionProviders([CustomSolutionProvider::class])
    ->register();
```

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

### Install OpenAI Client

Source: https://github.com/spatie/ignition/blob/main/README.md

Install the required dependency to enable AI-powered error solutions.

```bash
composer require openai-php/client
```

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

### Ignition Environment Setup

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Configuring Ignition behavior based on the application environment.

```APIDOC
## Ignition Environment Setup

### Description
Configure theme, editor, and error display settings for local development or production environments.

### Usage
```php
// Development
Ignition::make()->setTheme('dark')->setEditor('vscode')->shouldDisplayException(true)->register();

// Production
Ignition::make()->runningInProductionEnvironment(true)->shouldDisplayException(false)->sendToFlare('your-key')->register();
```
```

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

### FileConfigManager Usage Example

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Demonstrates loading, saving, and initializing the FileConfigManager with default or custom paths.

```php
use Spatie\Ignition\Config\FileConfigManager;

// Create manager using default home directory
$manager = new FileConfigManager();

// Load current configuration
$config = $manager->load();
echo "Current theme: " . ($config['theme'] ?? 'light');

// Save new configuration
$newConfig = array_merge($config, [
    'theme' => 'dark',
    'editor' => 'phpstorm',
    'hide_solutions' => false,
]);

if ($manager->save($newConfig)) {
    echo "Configuration saved successfully";
} else {
    echo "Failed to save configuration";
}

// Check file location
$info = $manager->getPersistentInfo();
echo "File stored at: " . $info['file'];

// Create custom instance for specific directory
$customManager = new FileConfigManager('/etc/myapp/ignition');
$customConfig = $customManager->load();
$customManager->save($customConfig);
```

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

### Configure Ignition for Development and Production

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Demonstrates conditional setup for local environments and production error reporting via Flare.

```php
use Spatie\Ignition\Ignition;

// Development setup
if ($_ENV['APP_ENV'] === 'local') {
    Ignition::make()
        ->applicationPath(__DIR__)
        ->setTheme('dark')
        ->setEditor('vscode')
        ->shouldDisplayException(true)
        ->addSolutionProviders([
            CustomSolutionProvider::class,
        ])
        ->resolveDocumentationLink(
            fn ($t) => 'https://docs.example.com'
        )
        ->register();
}

// Production setup with Flare
if ($_ENV['APP_ENV'] === 'production') {
    Ignition::make()
        ->applicationPath(__DIR__)
        ->runningInProductionEnvironment(true)
        ->shouldDisplayException(false)
        ->sendToFlare($_ENV['FLARE_API_KEY'])
        ->configureFlare(function ($flare) {
            $flare->censorRequestBodyFields(['password']);
            $flare->anonymizeIp();
        })
        ->register();
}
```

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

### Custom Solution Implementation

Source: https://github.com/spatie/ignition/blob/main/_autodocs/types.md

An example of implementing the Solution interface to provide context-specific error fixes.

```php
use Spatie\ErrorSolutions\Contracts\Solution;

class MyCustomSolution implements Solution
{
    public function __construct(private string $errorType) {}
    
    public function getSolutionTitle(): string
    {
        return "How to fix {$this->errorType} errors";
    }
    
    public function getSolutionDescription(): string
    {
        return "This error occurs when... Here's how to fix it...";
    }
    
    public function getDocumentationLinks(): array
    {
        return [
            'Documentation' => 'https://docs.example.com/errors',
            'GitHub Issue' => 'https://github.com/user/repo/issues/123',
        ];
    }
}
```

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

### Basic Ignition Setup

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Initializes and registers the Ignition error handler with default settings.

```php
use Spatie\Ignition\Ignition;

Ignition::make()->register();
```

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

### Install Ignition via Composer

Source: https://github.com/spatie/ignition/blob/main/README.md

Use this command to install the package in generic PHP projects.

```bash
composer require spatie/ignition
```

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

### Custom Editor Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Example of defining a custom editor using the %path and %line placeholders.

```json
{
    "theme": "light",
    "editor": "custom",
    "editor_options": {
        "custom": {
            "label": "My Custom Editor",
            "url": "customeditor://open?file=%path&line=%line"
        }
    }
}
```

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

### Complete error rendering workflow

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/renderer.md

A full example showing exception handling, view model preparation, and rendering to a custom template file.

```php
use Spatie\Ignition\ErrorPage\Renderer;
use Spatie\Ignition\ErrorPage\ErrorPageViewModel;
use Spatie\Ignition\Config\IgnitionConfig;
use Spatie\FlareClient\Flare;

// Create exception
try {
    throw new Exception('Database connection failed');
} catch (Throwable $e) {
    // Prepare view model
    $viewModel = new ErrorPageViewModel(
        $e,
        IgnitionConfig::loadFromConfigFile(),
        Flare::make()->createReport($e),
        [],
    );
    
    // Render to browser
    $renderer = new Renderer();
    $renderer->render(['viewModel' => $viewModel], __DIR__ . '/error-page.php');
    exit;
}
```

```php
<?php
// /path/to/error-page.php template
?>
<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <title>Error</title>
    <style>
        body { font-family: sans-serif; margin: 20px; }
        .error { background: #fee; padding: 20px; border-radius: 5px; }
        h1 { color: #c33; }
    </style>
</head>
<body>
    <div class="error">
        <h1><?php echo $viewModel->title(); ?></h1>
        <pre><?php echo $viewModel->throwableString(); ?></pre>
    </div>
</body>
</html>
```

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

### Simple Template Structure

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/renderer.md

A basic PHP template example demonstrating variable access and view model method calls.

```php
<?php
// /path/to/my-template.php
?>
<!DOCTYPE html>
<html>
<head>
    <title><?php echo htmlspecialchars($title); ?></title>
</head>
<body>
    <h1><?php echo $viewModel->title(); ?></h1>
    <p><?php echo $viewModel->throwableString(); ?></p>
</body>
</html>
```

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

### Handle Exception Usage Example

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Demonstrates registering Ignition and manually passing an exception to the handler within a try-catch block.

```php
$ignition = Ignition::make()->register();

try {
    // some code
} catch (Throwable $e) {
    $ignition->handleException($e);
}
```

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

### Template with Multiple Variables

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/renderer.md

An example showing how to handle multiple variables and conditional logic within a template.

```php
<?php
// All variables from $data array are available here
?>
<!DOCTYPE html>
<html>
<head>
    <title><?php echo htmlspecialchars($title); ?></title>
</head>
<body>
    <h1><?php echo htmlspecialchars($heading); ?></h1>
    <p>Error Code: <?php echo $errorCode; ?></p>
    
    <?php if (!empty($viewModel->solutions())): ?>
        <section>
            <h2>Possible Solutions</h2>
            <?php foreach ($viewModel->solutions() as $solution): ?>
                <article>
                    <h3><?php echo htmlspecialchars($solution['title']); ?></h3>
                    <p><?php echo htmlspecialchars($solution['description']); ?></p>
                </article>
            <?php endforeach; ?>
        </section>
    <?php endif; ?>
</body>
</html>
```

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

### Render Exception Usage Example

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Shows how to trigger the rendering of the Ignition error page for a specific exception.

```php
$ignition = Ignition::make();

try {
    throw new Exception('Test error');
} catch (Exception $e) {
    $ignition->renderException($e);
}
```

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

### Identify invalid JSON configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Example of a malformed JSON configuration file missing a comma.

```json
// Corrupted .ignition.json
{
    "theme": "dark"
    "editor": "vscode"  // Missing comma - invalid JSON
}
```

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

### Initialize Ignition with Flare

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Demonstrates basic initialization and manual injection of a custom Flare client instance.

```php
use Spatie\Ignition\Ignition;
use Spatie\FlareClient\Flare;

// Basic initialization (recommended)
$ignition = Ignition::make();

// With custom Flare instance
$flare = Flare::make();
$ignition = new Ignition($flare);
```

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

### Initialize configuration path

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Validates and prepares the configuration directory path.

```php
protected function initPath(string $path): string
```

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

### Get Flare Instance

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Accesses the underlying Flare client instance from the Ignition object.

```php
$ignition = Ignition::make();
$flare = $ignition->getFlare();
// Now you have direct access to Flare client
```

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

### Load Ignition configuration from file

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Initializes an IgnitionConfig instance by loading settings from the .ignition.json file.

```php
use Spatie\Ignition\Config\IgnitionConfig;

$config = IgnitionConfig::loadFromConfigFile();
echo $config->editor(); // 'vscode' (default or loaded value)
```

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

### Implement CensoringMiddleware

Source: https://github.com/spatie/ignition/blob/main/_autodocs/types.md

Example implementation of FlareMiddleware that modifies the report message before passing it to the next handler.

```php
use SpatielareClientlareMiddlewarelareMiddleware;
use SpatielareClient
eport;
use Closure;

class CensoringMiddleware implements FlareMiddleware
{
    public function handle(Report $report, Closure $next)
    {
        // Modify report
        $report->message($report->getMessage() . " [CENSORED]");
        
        // Call next middleware or final handler
        return $next($report);
    }
}
```

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

### Load configuration from file in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Initializes configuration settings by loading them from the persistent configuration file.

```php
$config = new IgnitionConfig();
$config->loadConfigFile(); // Load saved settings
```

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

### Create configuration file

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Creates the configuration file if it does not exist.

```php
protected function createFile(): bool
```

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

### Initialize OpenAI Solution Provider

Source: https://github.com/spatie/ignition/blob/main/README.md

Instantiate the provider using your OpenAI API key.

```php
use \Spatie\Ignition\Solutions\OpenAi\OpenAiSolutionProvider;

$aiSolutionProvider = new OpenAiSolutionProvider($openAiKey);
```

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

### Implement Custom ConfigManager

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/config-manager-interface.md

Demonstrates manual instantiation and registration of a custom ConfigManager with Ignition.

```php
use Spatie\Ignition\Ignition;
use Spatie\Ignition\Config\IgnitionConfig;

// Create custom config manager
$configManager = new DatabaseConfigManager($pdo, $userId);

// Create config with custom manager
$config = new IgnitionConfig();
// Note: IgnitionConfig detects custom manager via service container
// Or you can set it after instantiation:
// $config = IgnitionConfig::loadFromConfigFile();

// Use with Ignition
Ignition::make()
    ->setConfig($config)
    ->register();
```

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

### Registering Solution Providers

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Shows correct syntax for adding solution providers to the configuration.

```php
// Wrong - class doesn't exist
->addSolutionProviders(['NonExistentProvider::class'])

// Correct:
->addSolutionProviders([ExistingProvider::class])

// Or instance:
->addSolutionProviders([new ExistingProvider()])
```

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

### Initialize Renderer

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/renderer.md

Instantiate the stateless Renderer class.

```php
use Spatie\Ignition\ErrorPage\Renderer;

$renderer = new Renderer();
```

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

### Retrieve Asset Contents

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/error-page-view-model.md

Defines the method signature for fetching compiled asset contents and provides an example of inlining them into HTML.

```php
public function getAssetContents(string $asset): string
```

```php
$cssContent = $viewModel->getAssetContents('app.css');
$jsContent = $viewModel->getAssetContents('app.js');

// Can be embedded in HTML:
// <style><?php echo $cssContent; ?></style>
// <script><?php echo $jsContent; ?></script>
```

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

### Implement and Register Middleware

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Shows how to create a custom middleware class and register it with the Ignition instance.

```php
use Spatie\FlareClient\Report;
use Spatie\FlareClient\FlareMiddleware\FlareMiddleware;
use Closure;

class LogErrorMiddleware implements FlareMiddleware
{
    public function handle(Report $report, Closure $next)
    {
        error_log("Error: " . $report->getMessage());
        return $next($report);
    }
}

Ignition::make()
    ->registerMiddleware([new LogErrorMiddleware()])
    ->register();
```

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

### Construct configuration file path

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Generates the full path to the configuration file.

```php
protected function initFile(): string
```

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

### Flare Integration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Methods for configuring Flare error reporting, including API key setup, context enrichment, and data censoring.

```APIDOC
## Flare Integration

### Description
Configure Flare to receive error reports and customize the data sent with each report.

### Methods
- **sendToFlare(string $apiKey)**: Enables Flare reporting.
- **configureFlare(callable $callback)**: Allows modification of the Flare instance to add context, group data, censor fields, or anonymize IPs.

### Example
```php
Ignition::make()
    ->sendToFlare($apiKey)
    ->configureFlare(function ($flare) {
        $flare->context('Tenant', 'customer-123');
        $flare->censorRequestBodyFields(['password']);
    })
    ->register();
```
```

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

### Initialize IgnitionConfig with custom options

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Creates a new instance using default settings or an associative array of overrides.

```php
use Spatie\Ignition\Config\IgnitionConfig;

// Default configuration
$config = new IgnitionConfig();

// With custom options
$config = new IgnitionConfig([
    'theme' => 'dark',
    'editor' => 'phpstorm',
]);
```

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

### load()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Reads the configuration settings from the .ignition.json file and returns them as an associative array.

```APIDOC
## load()

### Description
Loads configuration from the .ignition.json file. Returns an empty array if the file does not exist, is not readable, or contains invalid JSON.

### Return Type
array<string, mixed>

### Example
```php
$manager = new FileConfigManager();
$config = $manager->load();
```
```

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

### Implement load() Method

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/config-manager-interface.md

Reads configuration from the persistence backend, returning an empty array on failure.

```php
public function load(): array
{
    try {
        $content = file_get_contents($this->configFile);
        return json_decode($content, true) ?? [];
    } catch (Exception $e) {
        return [];  // Return empty on any error
    }
}
```

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

### Initialize FileConfigManager

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Instantiate the manager using either the default home directory or a custom path.

```php
use Spatie\Ignition\Config\FileConfigManager;

// Use default home directory
$manager = new FileConfigManager();

// Use custom path
$manager = new FileConfigManager('/etc/ignition');
```

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

### Verify Configuration Loading

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Load and inspect the current Ignition configuration settings.

```php
$config = IgnitionConfig::loadFromConfigFile();
$array = $config->toArray();
echo json_encode($array, JSON_PRETTY_PRINT);

// Check individual settings
echo "Theme: " . $config->theme();
echo "Editor: " . $config->editor();
echo "Hide Solutions: " . ($config->hideSolutions() ? 'yes' : 'no');
```

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

### Configure Development Environment

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Sets up Ignition for local development with specific theme, editor, and display preferences.

```php
Ignition::make()
    ->applicationPath(__DIR__)
    ->setTheme('dark')
    ->setEditor('vscode')
    ->shouldDisplayException(true)
    ->register();
```

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

### Implement save() Method

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/config-manager-interface.md

Persists configuration to storage, returning a boolean indicating success or failure.

```php
public function save(array $options): bool
{
    try {
        $json = json_encode($options, JSON_THROW_ON_ERROR);
        return file_put_contents($this->configFile, $json) !== false;
    } catch (Exception $e) {
        return false;  // Return false on any error
    }
}
```

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

### Implement a custom solution provider

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Create a class implementing HasSolutionsForThrowable and register it using Ignition::make()->addSolutionProviders().

```php
use Spatie\ErrorSolutions\Contracts\HasSolutionsForThrowable;

class MyProvider implements HasSolutionsForThrowable
{
    public function canSolve(Throwable $throwable): bool { }
    public function getSolutions(Throwable $throwable): array { }
}

Ignition::make()->addSolutionProviders([MyProvider::class]);
```

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

### Implementing Solution Providers Correctly

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Ensures that canSolve() and getSolutions() are synchronized to prevent empty solution lists.

```php
class BadProvider implements HasSolutionsForThrowable
{
    public function canSolve(Throwable $throwable): bool
    {
        return true;  // Always says it can solve
    }
    
    public function getSolutions(Throwable $throwable): array
    {
        return [];  // But returns no solutions
    }
}
```

```php
public function canSolve(Throwable $throwable): bool
{
    return $throwable instanceof MySpecificException 
        && $this->hasSolutionFor($throwable);
}
```

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

### Configure Production and Flare Flags

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Understand the distinction between production environment flags and exception display settings.

```php
// Confusing - both need to be set correctly
Ignition::make()
    ->runningInProductionEnvironment(false)  // Development mode
    ->sendToFlare($key)                       // Send to Flare anyway
    ->register();

// The two flags control different behavior:
// - runningInProductionEnvironment() controls:
//   - Whether error page displays (hidden if true)
//   - Whether errors send to Flare (only if true or not set)
// 
// - shouldDisplayException() controls:
//   - Whether error page displays (hidden if false)
//   - Does NOT affect Flare sending
```

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

### Register AI Solution Provider

Source: https://github.com/spatie/ignition/blob/main/README.md

Add the initialized provider to the Ignition instance.

```php
\Spatie\Ignition\Ignition::make()
    ->addSolutionProviders([
        $aiSolutionProvider,
        // other solution providers...
    ])
    ->register();
```

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

### Ignition::__construct()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Initializes the Ignition instance with an optional Flare client.

```APIDOC
## Ignition::__construct()

### Description
Initializes the Ignition instance with optional Flare client injection.

### Parameters
- **$flare** (Flare|null) - Optional - Optional Flare client instance. If not provided, a new instance is created automatically.

### Example
```php
use Spatie\Ignition\Ignition;
use Spatie\FlareClient\Flare;

$flare = Flare::make();
$ignition = new Ignition($flare);
```
```

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

### loadFromConfigFile()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Static factory method to create an IgnitionConfig instance by loading settings from the .ignition.json configuration file.

```APIDOC
## static loadFromConfigFile()

### Description
Creates an IgnitionConfig instance and loads settings from the configuration file. This method is used by the Ignition class during initialization to apply saved user preferences.

### Signature
`public static function loadFromConfigFile(): self`

### Return Type
`self`

### Example
```php
use Spatie\Ignition\Config\IgnitionConfig;

$config = IgnitionConfig::loadFromConfigFile();
echo $config->editor();
```
```

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

### Debug Solution Visibility

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Check configuration settings and verify that custom solution providers are correctly registered and return true from their canSolve method.

```php
$config = IgnitionConfig::loadFromConfigFile();
if ($config->hideSolutions()) {
    echo "Solutions hidden by configuration";
}
```

```php
// Check configuration
$config = IgnitionConfig::loadFromConfigFile();
echo $config->hideSolutions(); // Should be false

// Register solution providers
Ignition::make()
    ->addSolutionProviders([YourProvider::class])
    ->register();

// In provider, ensure canSolve() returns true
public function canSolve(Throwable $throwable): bool
{
    return $throwable instanceof YourException;
}
```

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

### Register OpenAI Solution Provider

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Integrate AI-generated solutions by passing an instance of OpenAiSolutionProvider to the Ignition configuration.

```php
use Spatie\
Ignition\\Solutions\\OpenAi\\OpenAiSolutionProvider;

$aiProvider = new OpenAiSolutionProvider($openAiApiKey);

Ignition::make()
    ->addSolutionProviders([$aiProvider])
    ->register();
```

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

### Retrieve configuration options in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Fetches all configuration options from the persistent file without altering the current instance.

```php
$config = IgnitionConfig::loadFromConfigFile();
$fileConfig = $config->getConfigOptions();
```

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

### Load Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Retrieve configuration settings from the .ignition.json file, returning an empty array if the file is missing or invalid.

```php
$manager = new FileConfigManager();
$config = $manager->load();

// Example result:
// [
//     'theme' => 'dark',
//     'editor' => 'phpstorm',
//     'hide_solutions' => false
// ]
```

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

### Implement Custom Solutions

Source: https://github.com/spatie/ignition/blob/main/README.md

Define custom solutions for exceptions by implementing the ProvidesSolution and Solution interfaces.

```php
use Spatie\Ignition\Contracts\Solution;
use Spatie\Ignition\Contracts\ProvidesSolution;

class CustomException extends Exception implements ProvidesSolution
{
    public function getSolution(): Solution
    {
        return new CustomSolution();
    }
}
```

```php
use Spatie\Ignition\Contracts\Solution;

class CustomSolution implements Solution
{
    public function getSolutionTitle(): string
    {
        return 'The solution title goes here';
    }

    public function getSolutionDescription(): string
    {
        return 'This is a longer description of the solution that you want to show.';
    }

    public function getDocumentationLinks(): array
    {
        return [
            'Your documentation' => 'https://your-project.com/relevant-docs-page',
        ];
    }
}
```

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

### configureFlare()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Customizes Flare client behavior via a callback.

```APIDOC
## configureFlare(callable $callable)

### Description
Allows advanced Flare configuration through a callback. The callback receives the Flare client instance and can configure context, middleware, censoring rules, and other options.

### Parameters
- **$callable** (callable) - Required - A callback that receives the Flare instance for configuration. Signature: function(Flare $flare): void

### Return Type
- **self** - Returns the instance for method chaining.
```

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

### Write content to file

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Writes raw content to the configuration file.

```php
protected function writeToFile(string $content): bool
```

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

### Resolve Documentation Links

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Configure documentation links using static URLs, dynamic matching based on exception types, or multiple resolvers.

```php
Ignition::make()
    ->resolveDocumentationLink(
        fn ($throwable) => 'https://docs.example.com/errors'
    )
    ->register();
```

```php
Ignition::make()
    ->resolveDocumentationLink(function ($throwable) {
        return match (get_class($throwable)) {
            'PDOException' => 'https://docs.example.com/database',
            'LogicException' => 'https://docs.example.com/logic',
            default => [],
        };
    })
    ->register();
```

```php
Ignition::make()
    ->resolveDocumentationLink(fn ($t) => 'https://general-docs.com')
    ->resolveDocumentationLink(fn ($t) => 'https://api-reference.com')
    ->register();
```

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

### Replacing the Solution Provider Repository

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Replaces the default solution provider repository with a custom implementation.

```php
public function setSolutionProviderRepository(SolutionProviderRepositoryContract $solutionProviderRepository): self
```

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

### config()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/error-page-view-model.md

Returns all configuration data as an array.

```APIDOC
## config()

### Description
Returns the complete configuration object converted to an array. Includes theme, editor, editor options, and all other display settings.

### Signature
`public function config(): array`

### Return Type
`array<string, mixed>`
```

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

### Retrieve configuration path

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Fetches the path from parameters or environment variables.

```php
protected function retrievePath(string $path): string
```

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

### Handle missing configuration files in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Demonstrates how FileConfigManager returns an empty array when a configuration file is missing.

```php
$manager = new FileConfigManager();
$config = $manager->load();  // Returns [] if file doesn't exist

// No exception thrown - returns empty array
```

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

### Minimal Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

The basic structure required for an Ignition configuration file.

```json
{
    "theme": "dark",
    "editor": "vscode"
}
```

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

### Configure Ignition Settings

Source: https://github.com/spatie/ignition/blob/main/README.md

Common configuration options for path trimming, themes, and environment-based display toggling.

```php
\Spatie\Ignition\Ignition::make()
    ->applicationPath($basePathOfYourApplication)
    ->register();
```

```php
\Spatie\Ignition\Ignition::make()
    ->setTheme('dark')
    ->register();
```

```php
\Spatie\Ignition\Ignition::make()
    ->shouldDisplayException($inLocalEnvironment)
    ->register();
```

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

### Retrieve configuration metadata

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Returns an array containing the filename, directory path, and full file path of the configuration file.

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

```php
$manager = new FileConfigManager();
$info = $manager->getPersistentInfo();

// Result:
// [
//     'name' => '.ignition.json',
//     'path' => '/home/username',
//     'file' => '/home/username/.ignition.json',
// ]
```

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

### theme()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Retrieves the configured visual theme.

```APIDOC
## public function theme(): ?string

### Description
Returns the theme name: 'light' or 'dark'. Default is 'light'.

### Return Type
string|null
```

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

### __construct()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Constructor to initialize the IgnitionConfig instance with optional custom configuration overrides.

```APIDOC
## __construct()

### Description
Initializes a new IgnitionConfig instance. Provided options are merged with defaults, with the provided options taking precedence.

### Signature
`public function __construct(array $options = [])`

### Parameters
- **$options** (array) - Optional - Associative array of configuration options to override defaults.

### Example
```php
use Spatie\Ignition\Config\IgnitionConfig;

$config = new IgnitionConfig([
    'theme' => 'dark',
    'editor' => 'phpstorm',
]);
```
```

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

### Configure Ignition via Fluent API

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Apply configuration settings directly to the Ignition instance using fluent methods.

```php
use Spatie\Ignition\Ignition;

Ignition::make()
    ->setTheme('dark')
    ->setEditor('vscode')
    ->register();
```

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

### Ignition::make()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Creates a new instance of the Ignition class with default configuration.

```APIDOC
## Ignition::make()

### Description
Creates a new Ignition instance with default configuration.

### Signature
`public static function make(): self`

### Return Type
`self`

### Example
```php
use Spatie\Ignition\Ignition;

$ignition = Ignition::make();
```
```

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

### Create Ignition Instance

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Initializes a new Ignition instance using the static factory method.

```php
use Spatie\Ignition\Ignition;

$ignition = Ignition::make();
```

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

### loadConfigFile()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition-config.md

Loads settings from the persistent configuration file and merges them into the current configuration instance.

```APIDOC
## public function loadConfigFile()

### Description
Loads settings from the persistent configuration file and merges them into the current configuration. Called automatically by `loadFromConfigFile()`.

### Return Type
`self` (for method chaining)

### Example
```php
$config = new IgnitionConfig();
$config->loadConfigFile();
```
```

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

### Debug Ignition Configuration and Flare Instance

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Use these snippets to verify configuration settings, locate the persistent config file, and access the underlying Flare instance.

```php
// Check configuration
$config = IgnitionConfig::loadFromConfigFile();
echo json_encode($config->toArray(), JSON_PRETTY_PRINT);

// Check file location
$manager = new FileConfigManager();
$info = $manager->getPersistentInfo();
echo "Config file: " . $info['file'];

// Access Flare directly
$ignition = Ignition::make();
$flare = $ignition->getFlare();
```

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

### Enable Flare Monitoring

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Connects the error handler to Flare using an API key.

```php
Ignition::make()
    ->sendToFlare($apiKey)
    ->register();
```

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

### Manage Persistent Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Verify directory permissions and ensure configuration changes are explicitly saved to the file system.

```php
// Check if FileConfigManager can write
$info = $manager->getPersistentInfo();
echo "Path: " . $info['path'];
echo "File: " . $info['file'];

// Verify directory exists and is writable
if (!is_writable($info['path'])) {
    echo "Directory not writable";
}
```

```php
// Wrong - only modifies in-memory, doesn't persist
$config->setOption('theme', 'dark');

// Correct - saves to file
$config->setOption('theme', 'dark');
$config->saveValues($config->toArray());
```

```php
class MyConfigManager implements ConfigManager
{
    public function save(array $options): bool
    {
        return false;  // Intentionally not saving
    }
}
```

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

### Configuration File Paths

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Typical file locations for the .ignition.json configuration file on different operating systems.

```text
~/.ignition.json
/home/username/.ignition.json
```

```text
C:\Users\username\.ignition.json
```

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

### Configure Flare Exception Monitoring

Source: https://github.com/spatie/ignition/blob/main/README.md

Register Ignition with Flare and toggle production environment behavior.

```php
\Spatie\Ignition\Ignition::make()
    ->runningInProductionEnvironment($boolean)
    ->sendToFlare($yourApiKey)
    ->register();
```

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

### Register documentation links with resolveDocumentationLink

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Registers a callback to dynamically generate documentation links based on the exception. Multiple resolvers can be registered and their results will be merged.

```php
Ignition::make()
    ->resolveDocumentationLink(
        fn (Throwable $throwable) => match (get_class($throwable)) {
            'PDOException' => 'https://docs.example.com/database-errors',
            'LogicException' => 'https://docs.example.com/logic-errors',
            default => [],
        }
    )
    ->resolveDocumentationLink(
        fn (Throwable $throwable) => 'https://general-docs.example.com'
    )
    ->register();
```

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

### Handle unreadable configuration files in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Shows that load and save operations return empty arrays or false respectively when file permissions prevent access.

```php
// File exists but not readable
chmod(~/.ignition.json, 0000);

$config = $manager->load();  // Returns []
$success = $manager->save($data);  // Returns false
```

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

### Initialize and use ErrorPageViewModel in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/error-page-view-model.md

Instantiate the view model with an exception, configuration, report, and solutions to access rendering data.

```php
use Spatie\Ignition\ErrorPage\ErrorPageViewModel;
use Spatie\
Ignition\Config\IgnitionConfig;
use Spatie\FlareClient\Flare;
use Spatie\ErrorSolutions\SolutionProviderRepository;

// Create view model for an exception
try {
    throw new Exception('Test error');
} catch (Throwable $e) {
    $flare = Flare::make();
    $report = $flare->createReport($e);
    
    $solutionRepository = new SolutionProviderRepository([]);
    $solutions = $solutionRepository->getSolutionsForThrowable($e);
    
    $viewModel = new ErrorPageViewModel(
        $e,
        IgnitionConfig::loadFromConfigFile(),
        $report,
        $solutions,
        customHtmlHead: '<meta name="custom" content="head">',
        customHtmlBody: '<script>console.log("page loaded")</script>'
    );
    
    // Get data for rendering
    echo "Title: " . $viewModel->title() . "\n";
    echo "Theme: " . $viewModel->theme() . "\n";
    echo "Solutions: " . json_encode($viewModel->solutions()) . "\n";
    
    // Get configuration for frontend
    $configJson = $viewModel->jsonEncode($viewModel->config());
    
    // Get assets
    $css = $viewModel->getAssetContents('app.css');
    $js = $viewModel->getAssetContents('app.js');
    
    // Render in template
    echo "Update endpoint: " . $viewModel->updateConfigEndpoint();
}
```

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

### Configure Ignition for Development

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Apply specific settings for development environments, such as enabling exception display and setting the application path.

```php
use Spatie\Ignition\Ignition;

if ($_ENV['APP_ENV'] === 'development') {
    Ignition::make()
        ->setTheme('dark')
        ->setEditor('vscode')
        ->applicationPath(__DIR__)
        ->shouldDisplayException(true)
        ->register();
}
```

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

### Read configuration file

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Parses JSON content from the configuration file.

```php
protected function readFromFile(): array
```

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

### Define Solution Providers

Source: https://github.com/spatie/ignition/blob/main/README.md

Create classes implementing HasSolutionsForThrowable to dynamically provide solutions for thrown exceptions.

```php
interface HasSolutionsForThrowable
{
    public function canSolve(Throwable $throwable): bool;

    /** @return \Spatie\Ignition\Contracts\Solution[] */
    public function getSolutions(Throwable $throwable): array;
}
```

```php
\Spatie\Ignition\Ignition::make()
    ->addSolutionProviders([
        YourSolutionProvider::class,
        AnotherSolutionProvider::class,
    ])
    ->register();
```

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

### Configure Local Sites Path

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Sets the file path prefix on the local development machine for path mapping.

```php
$config->setOption('local_sites_path', '/Users/dev/projects/app');
```

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

### Retrieving Exception Solutions

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Queries the solution provider repository to find potential fixes for a given throwable.

```php
$solutions = $this->solutionProviderRepository->getSolutionsForThrowable($throwable);
```

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

### setFlare()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Replaces the internal Flare client with a custom instance.

```APIDOC
## setFlare(Flare $flare)

### Description
Allows injection of a custom Flare instance, useful for testing or when you need complete control over Flare configuration.

### Parameters
- **$flare** (Flare) - Required - Configured Flare instance to use instead of the default.

### Return Type
- **self** - Returns the instance for method chaining.
```

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

### Inject a Custom Flare Instance

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Replaces the default Flare client with a pre-configured instance, useful for testing or specific custom requirements.

```php
$customFlare = Flare::make()->setApiToken($key);
Ignition::make()
    ->setFlare($customFlare)
    ->register();
```

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

### Handle non-writable configuration directories in PHP

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Illustrates that save operations return false when the target directory lacks write permissions.

```php
$manager = new FileConfigManager('/protected/dir');

// If /protected/dir is not writable:
$success = $manager->save(['theme' => 'dark']);  // Returns false
```

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

### Resolve Documentation Links

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Provides a callback to dynamically resolve documentation URLs for specific exceptions.

```php
Ignition::make()
    ->resolveDocumentationLink(function ($throwable) {
        return 'https://docs.example.com/errors';
    })
    ->register();
```

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

### Define Configuration Data Structure

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/config-manager-interface.md

Outlines the expected key-value structure for configuration data handled by the manager.

```php
[
    'theme' => 'dark',                              // string
    'editor' => 'vscode',                           // string
    'hide_solutions' => false,                      // boolean
    'enable_share_button' => true,                  // boolean
    'enable_runnable_solutions' => false,           // boolean
    'remote_sites_path' => '/var/www/app',          // string|null
    'local_sites_path' => '/Users/dev/app',         // string|null
    'share_endpoint' => 'https://flareapp.io/...',  // string
    'editor_options' => [ /* ... */ ],              // array
]
```

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

### Configure Yarn Workspaces for Ignition

Source: https://github.com/spatie/ignition/blob/main/README.md

Create this package.json file in the root directory containing the project repositories to enable workspace management.

```json
{
    "private": true,
    "workspaces": [
        "ignition-ui",
        "ignition"
    ]
}
```

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

### Check Configuration

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Loads the current Ignition configuration and outputs it as a JSON string.

```php
$config = IgnitionConfig::loadFromConfigFile();
echo json_encode($config->toArray(), JSON_PRETTY_PRINT);
```

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

### Detect and Configure Environment

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Conditionally configures Ignition based on the current application environment.

```php
$isDevelopment = $_ENV['APP_ENV'] === 'local';
$isProduction = $_ENV['APP_ENV'] === 'production';

if ($isDevelopment) {
    Ignition::make()
        ->setTheme($_ENV['IGNITION_THEME'] ?? 'light')
        ->setEditor($_ENV['IGNITION_EDITOR'] ?? 'vscode')
        ->shouldDisplayException(true)
        ->register();
}

if ($isProduction) {
    Ignition::make()
        ->runningInProductionEnvironment(true)
        ->shouldDisplayException(false)
        ->sendToFlare($_ENV['FLARE_API_KEY'] ?? '')
        ->register();
}
```

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

### Define Custom Editor URLs

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Use %path and %line placeholders when defining custom editor protocols.

```php
// Remember the placeholders when creating custom editors:
// %path - file path
// %line - line number

$editor_url = 'myeditor://open?file=%path&line=%line';
// Becomes: myeditor://open?file=/path/to/file.php&line=42
```

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

### Instantiate ErrorPageViewModel

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/error-page-view-model.md

Demonstrates creating a new instance of the ErrorPageViewModel with custom HTML injections for the head and body sections.

```php
use Spatie\Ignition\ErrorPage\ErrorPageViewModel;
use Spatie\Ignition\Config\IgnitionConfig;

$viewModel = new ErrorPageViewModel(
    $throwable,
    IgnitionConfig::loadFromConfigFile(),
    $flare->createReport($throwable),
    $solutions,
    customHtmlHead: '<link rel="stylesheet" href="/custom.css">',
    customHtmlBody: '<script src="/custom.js"></script>'
);
```

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

### Implement Custom Solution Provider

Source: https://github.com/spatie/ignition/blob/main/_autodocs/module-overview.md

Implement the HasSolutionsForThrowable contract to provide custom solutions for specific throwables. Register the provider using the addSolutionProviders method.

```php
class MyProvider implements HasSolutionsForThrowable
{
    public function canSolve(Throwable $throwable): bool { }
    public function getSolutions(Throwable $throwable): array { }
}

// Register:
Ignition::make()->addSolutionProviders([MyProvider::class]);
```

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

### Define Ignition configuration in JSON

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

The .ignition.json file supports various settings including theme, editor, and feature flags. Ensure the file is placed in the user home directory.

```json
{
    "theme": "dark",
    "editor": "vscode",
    "hide_solutions": false,
    "enable_share_button": false,
    "enable_runnable_solutions": false,
    "remote_sites_path": null,
    "local_sites_path": null,
    "share_endpoint": "https://flareapp.io/api/public-reports",
    "editor_options": {}
}
```

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

### Register Custom Solution Providers

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Extends error reporting by adding custom solution providers to the Ignition instance.

```php
Ignition::make()
    ->addSolutionProviders([
        CustomSolutionProvider::class,
        OpenAiSolutionProvider::class,
    ])
    ->register();
```

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

### Resolve Documentation Links

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Return documentation links in the correct string or array format.

```php
// Wrong - resolver must return string or array of strings
->resolveDocumentationLink(fn($e) => ['url' => 'https://...']);

// Correct - return string or array of strings
->resolveDocumentationLink(fn($e) => 'https://docs.example.com')

// Or array:
->resolveDocumentationLink(fn($e) => [
    'https://docs.example.com',
    'https://api-reference.example.com',
])
```

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

### Register Flare middleware

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Implement the FlareMiddleware interface and register the class via Ignition::make()->registerMiddleware().

```php
use Spatie\FlareClient\FlareMiddleware\FlareMiddleware;

class MyMiddleware implements FlareMiddleware
{
    public function handle(Report $report, Closure $next) { }
}

Ignition::make()->registerMiddleware(MyMiddleware::class);
```

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

### Enable Runnable Solutions

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Allows solutions that execute code to run directly from the error page. Should only be enabled in development environments.

```php
$config->setOption('enable_runnable_solutions', true);
```

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

### Configure Application Path

Source: https://github.com/spatie/ignition/blob/main/_autodocs/errors.md

Set the application root path to ensure file paths are displayed as relative rather than absolute.

```php
Ignition::make()
    ->applicationPath(__DIR__)  // Set this
    ->register();
```

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

### __construct(string $path = '')

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/file-config-manager.md

Initializes the FileConfigManager instance, optionally specifying a custom directory path for the configuration file.

```APIDOC
## __construct(string $path = '')

### Description
Initializes the FileConfigManager with an optional custom path. Automatically detects the home directory if no path is provided.

### Parameters
- **$path** (string) - Optional - Directory path where .ignition.json is stored. Defaults to the user's home directory.

### Example
```php
use Spatie\Ignition\Config\FileConfigManager;

// Use default home directory
$manager = new FileConfigManager();

// Use custom path
$manager = new FileConfigManager('/etc/ignition');
```
```

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

### Configure Ignition for Production

Source: https://github.com/spatie/ignition/blob/main/_autodocs/configuration.md

Apply production-specific settings, such as disabling exception display and configuring error reporting services.

```php
if ($_ENV['APP_ENV'] === 'production') {
    Ignition::make()
        ->runningInProductionEnvironment(true)
        ->shouldDisplayException(false)
        ->sendToFlare($_ENV['FLARE_API_KEY'])
        ->register();
}
```

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

### getFlare()

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Returns the underlying Flare client instance.

```APIDOC
## getFlare()

### Description
Provides access to the internal Flare client for advanced configuration not exposed through convenience methods.

### Return Type
- **Spatie\FlareClient\Flare** - The internal Flare client instance.
```

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

### Configure Production with Flare

Source: https://github.com/spatie/ignition/blob/main/_autodocs/README.md

Configures Ignition for production use, including Flare API integration and data privacy settings.

```php
Ignition::make()
    ->runningInProductionEnvironment(true)
    ->shouldDisplayException(false)
    ->sendToFlare($_ENV['FLARE_API_KEY'])
    ->configureFlare(function ($flare) {
        $flare->censorRequestBodyFields(['password']);
        $flare->anonymizeIp();
    })
    ->register();
```

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

### Resolving Documentation Links

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Provides dynamic documentation links based on the thrown exception type.

```php
Ignition::make()
    ->resolveDocumentationLink(function ($throwable) {
        if ($throwable instanceof PDOException) {
            return 'https://docs.example.com/database-errors';
        }
        return [];
    })
    ->register();
```

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

### Access the Flare Client Instance

Source: https://github.com/spatie/ignition/blob/main/_autodocs/api-reference/ignition.md

Retrieves the internal Flare client instance for advanced configuration not available via standard methods.

```php
$ignition = Ignition::make()
    ->sendToFlare($apiKey);

$flare = $ignition->getFlare();
$flare->setBaseUrl('https://custom-flare-endpoint.com');
```

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

### Set Environment Variables

Source: https://github.com/spatie/ignition/blob/main/_autodocs/quick-reference.md

Configures Ignition settings via environment variables in a .env file.

```bash
# .env file
IGNITION_EDITOR=vscode
IGNITION_THEME=dark
FLARE_API_KEY=your-key
```
Tokens:
Raw