Pan

https://github.com/panphp/pan
Admin
Pan is a lightweight and privacy-focused PHP product analytics library that tracks impressions,...
Tokens:37,052
Snippets:345
Trust Score:5.9
License:MIT
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Install Pan package with php artisan install:pan

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Run the install:pan command to install the Pan package. It publishes Pan migrations under the 'pan-migrations' tag and prompts to run migrations immediately. If a migration file already exists, publishing is skipped.

```bash
php artisan install:pan
# Publishing Pan migrations...
# Would like to run the migrations now? (yes/no) [yes]:
```

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

### Install dev dependencies with composer install

Source: https://github.com/panphp/pan/blob/main/CONTRIBUTING.md

Run this command after cloning your fork to install the project's development dependencies.

```bash
composer install
```

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

### InstallPanCommand signature and handle method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

PHP class properties and method signature for InstallPanCommand. Defines the command signature 'install:pan', alias 'pan:install', description, and the handle() method that performs the installation steps.

```php
/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'install:pan';

/**
 * The console command aliases.
 *
 * @var array<int, string>
 */
protected $aliases = ['pan:install'];

/**
 * The console command description.
 *
 * @var string
 */
protected $description = 'Install the Pan package';

/**
 * Execute the console command.
 */
public function handle(): void
```

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

### Install Pan into Laravel

Source: https://github.com/panphp/pan/blob/main/README.md

Install Pan into your Laravel project after requiring it via Composer.

```bash
php artisan install:pan
```

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

### Usage example for all()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Iterates over the result of all() and prints each analytic's name, impressions, hovers, and clicks.

```php
$analytics = $this->repository->all();

foreach ($analytics as $analytic) {
    printf('%s: %d impressions, %d hovers, %d clicks', $analytic->name, $analytic->impressions, $analytic->hovers, $analytic->clicks);
}
```

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

### Example: route all analytics through a secondary connection

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Shows how to set the database connection to 'analytics' in a service provider's register method.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::databaseConnection('analytics');
}
```

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

### Example: whitelist analytics names

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Shows how to whitelist specific analytics names in a service provider's register method.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::allowedAnalytics(['tab-profile', 'tab-settings']);
}
```

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

### Usage example for flush()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Truncates the pan_analytics table, removing all analytics records.

```php
$this->repository->flush(); // all analytics records removed
```

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

### Custom route prefix curl example

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Example of using a custom route prefix. After setting PanConfiguration::routePrefix('internal-analytics'), the endpoint is available at /internal-analytics/events.

```bash
curl -X POST http://localhost/internal-analytics/events ...   # after PanConfiguration::routePrefix('internal-analytics')
```

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

### Example: set max analytics to 10,000

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Shows how to set the maximum analytics rows to 10,000 in a service provider's register method.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::maxAnalytics(10_000);
}
```

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

### Usage example for delete()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Deletes the analytic with ID 42 and prints a message if no record was deleted.

```php
$deleted = $this->repository->delete(42);

if ($deleted === 0) {
    printf('No analytic with id 42 exists');
}
```

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

### Example return array of toArray()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Analytic.md

Example of the shaped array returned by toArray(), showing the keys and their types. The values are illustrative placeholders.

```php
[
    'id'          => 1,     // int
    'name'        => 'x',   // string
    'impressions' => 0,     // int
    'hovers'      => 0,     // int
    'clicks'      => 0,     // int
]
```

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

### Usage example for increment()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Increments the clicks and impressions counters for the 'help-modal' analytic.

```php
$this->repository->increment('help-modal', EventType::CLICK);      // clicks += 1
$this->repository->increment('help-modal', EventType::IMPRESSION); // impressions += 1
```

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

### Successful invocation example

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventController.md

Shows a successful POST request to /pan/events with a valid payload, resulting in 204 No Content and the repository storing the impression.

```php
// POST /pan/events
// {"events": [{"name": "help-modal", "type": "impression"}], "_token": "..."}
// → 204 No Content; repository now holds help-modal impressions = 1
```

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

### Unit test route and assertion

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/InjectJavascriptLibrary.md

Example of a route returning a full HTML page and the corresponding test assertions verifying the script and CSRF token are present.

```php
Route::get('/', fn (): string => <<<'HTML'
    <html lang="en">
        <head><title>My App</title></head>
        <body><h1>Welcome to my app</h1></body>
    </html>
    HTML
);

$response = $this->get('/');

$response->assertOk()
    ->assertSee('script')
    ->assertSee('_TEST_CSRF_TOKEN_'); // csrf_token() injected into the script
```

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

### Install Pan with Composer

Source: https://github.com/panphp/pan/blob/main/README.md

Use Composer to require Pan into your PHP project. Requires PHP 8.3+ and Laravel 11.0+.

```bash
composer require panphp/pan
```

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

### Configure route prefix with PanConfiguration::routePrefix

Source: https://github.com/panphp/pan/blob/main/README.md

Change the route prefix from the default '/pan' to a custom prefix. With this example, the tracking URL becomes '/internal-analytics/events'.

```php
PanConfiguration::routePrefix('internal-analytics');
```

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

### Valid single event curl example

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Valid single event (impression) curl example. Sends a JSON payload with one event and a CSRF token. Expect HTTP 204 No Content on success.

```bash
curl -X POST http://localhost/pan/events \
     -H "Content-Type: application/json" \
     -b cookies.txt \
     -d '{"events": [{"name": "tab-profile", "type": "impression"}], "_token": "TOKEN"}'
# HTTP 204 No Content
```

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

### Column lookup with column()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventType.md

Shows how to get the database column name for an event type using the column() method.

```php
use Pan\Enums\EventType;

$event->column(); // 'click' | 'hover' | 'impression' → 'clicks' | 'hovers' | 'impressions'
```

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

### pan:delete command usage examples

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Example invocations of the pan:delete command. The first deletes an existing analytic (ID 42) and prints 'Analytic has been deleted.'; the second attempts to delete a non-existent analytic (ID 9999) and prints 'Record not found or already deleted.'

```bash
php artisan pan:delete 42
# Analytic has been deleted.

php artisan pan:delete 9999
# Record not found or already deleted.
```

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

### Invalid type curl example (302 with session error)

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Invalid type example. Sends an event with type 'invalid', which is not one of the allowed enum values. Returns HTTP 302 with session error events.0.type indicating the selected type is invalid.

```bash
-d '{"events": [{"name": "help-modal", "type": "invalid"}], "_token": "TOKEN"}'
# session errors: events.0.type = "The selected events.0.type is invalid."
```

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

### Invalid name curl example (302 with session error)

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Invalid payload example where the event name contains a space. Returns HTTP 302 with Laravel session validation errors, specifically events.0.name indicating the name must only contain letters, numbers, dashes, and underscores.

```bash
curl -X POST http://localhost/pan/events \
     -H "Content-Type: application/json" \
     -b cookies.txt \
     -d '{"events": [{"name": "help modal", "type": "impression"}], "_token": "TOKEN"}'
# HTTP 302
# session errors: events.0.name = "The events.0.name field must only contain letters,
# numbers, dashes, and underscores."
```

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

### Read effective Pan configuration with toArray()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Retrieves the current effective configuration as an array. The example shows default values: max_analytics is 50, allowed_analytics is an empty array, and route_prefix is 'pan'.

```php
use Pan\PanConfiguration;

$config = PanConfiguration::instance()->toArray();

// $config === [
//   'max_analytics'     => 50,
//   'allowed_analytics' => [],
//   'route_prefix'      => 'pan',
// ]
```

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

### Invalid payload example

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventController.md

Shows an invalid payload that fails validation, resulting in a 302 redirect with a session error about the events.0.name field.

```php
// POST /pan/events
// {"events": [{"name": "help modal", "type": "impression"}]}
// → 302 redirect; session error: "The events.0.name field must only contain
//   letters, numbers, dashes, and underscores."
```

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

### Example valid request body

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEventRequest.md

A valid JSON payload for the events endpoint, containing two events with valid names and types, plus a CSRF token.

```json
{
  "events": [
    { "name": "tab-profile", "type": "impression" },
    { "name": "tab-profile", "type": "click" }
  ],
  "_token": "CSRF-token"
}
```

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

### POST /{route_prefix}/events request body

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Example request body for the POST /{route_prefix}/events endpoint. Includes an events array with name/type pairs and a CSRF _token. The JS client sends this as a JSON Blob via navigator.sendBeacon, but form-encoded posting also works.

```json
{
    "events": [
        { "name": "tab-profile", "type": "impression" },
        { "name": "tab-profile", "type": "click" }
    ],
    "_token": "CP2YfR2oyCzJdLuPrvhbPXu32WPAzUaGle3l6y5f1"
}
```

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

### Add data-pan attribute to HTML elements

Source: https://github.com/panphp/pan/blob/main/README.md

Add the data-pan attribute to HTML elements to start tracking pages or components. Event names must only contain letters, numbers, dashes, and underscores.

```diff
<div>
-    <button>Tab 1</button>
+    <button data-pan="tab-1">Tab 1</button>
-    <button>Tab 2</button>
+    <button data-pan="tab-2">Tab 2</button>
</div>
```

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

### Basic usage of Table::display

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Table.md

Shows how to instantiate Table with an output and call display with headers and rows.

```php
use Pan\Console\Table;

(new Table($this->output))->display(
    ['', 'Name', 'Impressions', 'Hovers', 'Clicks'],
    [
        ['  1', 'help-modal', '1', '1 (100.0%)', '1 (100.0%)'],
    ]
);
```

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

### Configure all Filament actions with data-pan

Source: https://github.com/panphp/pan/blob/main/README.md

Track all Filament actions globally by adding this to a service provider's boot method.

```php
use Filament\Actions\Action;

public function boot(): void
{
    Action::configureUsing(function (Action $action): void {
        $action->extraAttributes(fn () => ['data-pan' => $action->getLabel()]);
    });
}
```

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

### Basic usage of AnalyticPresentor::present

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticPresentor.md

Shows how to instantiate the presenter and call present() with an Analytic, producing an array of formatted cells. The output includes Termwind markup for id/name and percentages for hovers/clicks.

```php
use Pan\Presentors\AnalyticPresentor;
use Pan\ValueObjects\Analytic;

$presentor = new AnalyticPresentor;

$cells = $presentor->present(new Analytic(1, 'help-modal', 1, 1, 1));

// [
//   'id'          => '<fg=gray>#1</>',
//   'name'        => '<fg=gray>help-modal</>',
//   'impressions' => '1',
//   'hovers'      => '1 (100.0%)',
//   'clicks'      => '1 (100.0%)',
// ]
```

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

### boot() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Signature of the boot() lifecycle method. It calls registerCommands(), registerRoutes(), and registerPublishing().

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

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

### instance() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Returns the lazily-created singleton instance of PanConfiguration.

```php
public static function instance(): self
```

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

### Run the pan Artisan command

Source: https://github.com/panphp/pan/blob/main/README.md

Visualize your product analytics using the pan Artisan command. The --filter option filters the analytics.

```bash
php artisan pan
php artisan pan --filter=tab-profile
```

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

### Recording a batch of events with CreateEvent

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

Shows how to record multiple events in a loop, as done in EventController::store. Each event is processed by calling handle with the event name and type.

```php
use Pan\Actions\CreateEvent;
use Pan\Enums\EventType;

foreach ($events as $event) {
    $this->createEvent->handle($event['name'], EventType::from($event['type']));
}
```

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

### Basic usage of CreateEvent with container resolution

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

Shows how to resolve CreateEvent from the container and call handle with different event types. The repository is autowired.

```php
use Pan\Actions\CreateEvent;
use Pan\Enums\EventType;

// $this within a Laravel-injected context; CreateEvent autowires AnalyticsRepository.
$action = app(CreateEvent::class);

$action->handle('help-modal', EventType::CLICK);
$action->handle('help-modal', EventType::HOVER);
```

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

### Run php artisan pan with optional filter

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Runs the `pan` command to display all analytics, optionally filtering by name with `--filter=tab-profile`.

```bash
php artisan pan
php artisan pan --filter=tab-profile

```

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

### Recording programmatically with CreateEvent

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventType.md

Shows how to record an event programmatically by passing an EventType case to the CreateEvent action's handle method.

```php
use Pan\Actions\CreateEvent;
use Pan\Enums\EventType;

$this->createEvent->handle('subscribe-button', EventType::CLICK);
```

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

### Run all tests with composer test

Source: https://github.com/panphp/pan/blob/main/CONTRIBUTING.md

Run this command to execute the full test suite.

```bash
composer test
```

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

### Rebuild JavaScript bundle with npm run build

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/JavascriptClient.md

Run this command to compile TypeScript and build the Vite bundle, producing resources/js/dist/pan.iife.js.

```bash
npm run build   # tsc && vite build → resources/js/dist/pan.iife.js
```

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

### Run unit tests with composer test:unit

Source: https://github.com/panphp/pan/blob/main/CONTRIBUTING.md

Run this command to execute the unit test suite.

```bash
composer test:unit
```

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

### Configure Pan in application register() method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Shows how to configure Pan runtime behavior by calling PanConfiguration methods inside the application's register() method. Sets route prefix, max analytics, and allowed analytics.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::routePrefix('internal-analytics');
    PanConfiguration::maxAnalytics(1000);
    PanConfiguration::allowedAnalytics(['tab-profile', 'tab-settings']);
}
```

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

### Usage in PanCommand

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Table.md

Shows how PanCommand uses Table::display with analytics data and a presenter.

```php
use Pan\Contracts\AnalyticsRepository;
use Pan\Presentors\AnalyticPresentor;
use Pan\ValueObjects\Analytic;

$analytics = $this->analytics->all();

(new Table($this->output))->display(
    ['', 'Name', 'Impressions', 'Hovers', 'Clicks'],
    array_map(
        fn (Analytic $analytic): array => array_values($presentor->present($analytic)),
        $analytics
    )
);
```

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

### Flush analytics with pan:flush Artisan command

Source: https://github.com/panphp/pan/blob/main/README.md

Flush all product analytics using the pan:flush Artisan command.

```bash
php artisan pan:flush
```

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

### Edge case with zero impressions

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticPresentor.md

Demonstrates the division-by-zero guard: when impressions are zero, the percentage helper returns 'Infinity%' for hovers and clicks.

```php
$cells = $presentor->present(new Analytic(2, 'floating-cta', 0, 3, 2));

// 'hovers' => '3 (Infinity%)'
// 'clicks' => '2 (Infinity%)'
```

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

### Provider wiring diagram

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Text diagram showing what the provider wires together: container bindings, middleware, routes, commands, and migrations.

```text
register():
  PanConfiguration::class        → PanConfiguration::instance()         (singleton)
  AnalyticsRepository::class     → DatabaseAnalyticsRepository::class   (implementation)

boot():
  HTTP kernel ← InjectJavascriptLibrary middleware
  Route:prefix(config.route_prefix) → POST /events → EventController@store
  Commands:  install:pan, pan, pan:flush, pan:delete   (console only)
  Migrations: database/migrations → database_path('migrations')  (tag 'pan-migrations', console only)
```

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

### Initialize GlobalState singleton (window.__pan)

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/JavascriptClient.md

Initializes the global state object on window.__pan, preserving any existing instance. Sets default values for csrfToken, routePrefix, and listener/observer properties. Used on every page load to set up the tracking environment.

```typescript
window.__pan =
    window.__pan ||
    ({
        csrfToken: "%_PAN_CSRF_TOKEN_%",
        routePrefix: "%_PAN_ROUTE_PREFIX_%",
        observer: null,
        clickListener: null,
        mouseoverListener: null,
        inertiaStartListener: null,
        livewireNavigatedListener: null,
    } as GlobalState);
```

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

### Basic usage of Analytic

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Analytic.md

Basic usage: instantiate an Analytic with named arguments and access its public readonly properties. The printf outputs the name and the three counters.

```php
use Pan\ValueObjects\Analytic;

$analytic = new Analytic(id: 1, name: 'help-modal', impressions: 10, hovers: 4, clicks: 2);

printf('%s: %d/%d/%d', $analytic->name, $analytic->impressions, $analytic->hovers, $analytic->clicks);
```

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

### Run php artisan pan:flush

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Runs the `pan:flush` command to flush all analytics.

```bash
php artisan pan:flush

```

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

### Feeding the console table as PanCommand does

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticPresentor.md

Shows how PanCommand maps analytics to rows and displays them using the Table class. It uses array_map to convert each Analytic to an array of cell values and passes headers and rows to the table display.

```php
use Pan\Console\Table;
use Pan\Contracts\AnalyticsRepository;
use Pan\Presentors\AnalyticPresentor;
use Pan\ValueObjects\Analytic;

$rows = array_map(
    fn (Analytic $analytic): array => array_values($presentor->present($analytic)),
    $this->analytics->all()
);

(new Table($this->output))->display(
    ['', 'Name', 'Impressions', 'Hovers', 'Clicks'],
    $rows
);
```

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

### register() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Signature of the register() lifecycle method. It calls registerConfiguration() and registerRepositories().

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

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

### all() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Declares the public method all() that returns an array of Analytic objects.

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

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

### setRoutePrefix method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Instance-level equivalent of routePrefix(). Declared @internal.

```php
public function setRoutePrefix(string $prefix): void
```

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

### PanConfiguration::instance()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Returns the lazily-created singleton instance of PanConfiguration. This is used internally by the container binding and repository/config consumers.

```APIDOC
## PanConfiguration::instance()

### Description
Returns the lazily-created singleton instance of PanConfiguration.

### Method
`public static function instance(): self`

### Return
- **PanConfiguration** - The singleton instance.

### Example
```php
$config = PanConfiguration::instance();
```
```

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

### Lint code with composer lint

Source: https://github.com/panphp/pan/blob/main/CONTRIBUTING.md

Run this command to check the coding style of your changes.

```bash
composer lint
```

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

### Class declaration and constructor for CreateEvent

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

Shows the class declaration and constructor for CreateEvent, which takes an AnalyticsRepository instance. The repository is resolved to DatabaseAnalyticsRepository via the container binding in PanServiceProvider::register().

```php
final readonly class CreateEvent
{
    /**
     * Creates a new action instance.
     */
    public function __construct(
        private AnalyticsRepository $repository,
    ) {
        //
    }
```

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

### present() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticPresentor.md

The public method signature that returns an array of strings. It accepts an Analytic value object.

```php
/**
 * Returns the human-readable information about the analytic.
 *
 * @return array<string, string>
 */
public function present(Analytic $analytic): array
```

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

### Configure Pan from service provider register()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Use this snippet inside a service provider's register() method to set allowed analytics and the maximum number of analytics. The setters return void and do not throw exceptions.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::allowedAnalytics(['tab-profile', 'tab-settings']);
    PanConfiguration::maxAnalytics(10_000);
}
```

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

### Class declaration and constructor

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/InjectJavascriptLibrary.md

Defines the final readonly middleware class with a constructor that accepts a PanConfiguration instance. Only the route_prefix is read from the configuration.

```php
final readonly class InjectJavascriptLibrary
{
    /**
     * Creates a new middleware instance.
     */
    public function __construct(private PanConfiguration $config)
    {
        //
    }
```

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

### Configure Pan with allowedAnalytics, maxAnalytics, and routePrefix

Source: https://github.com/panphp/pan/blob/main/_autodocs/configuration.md

Typical configuration block from the README pattern. Sets an allow-list of analytics, a maximum of 10,000 analytics, and a custom route prefix. Use in the register method of a Laravel service provider.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::allowedAnalytics([
        'tab-profile',
        'tab-settings',
    ]);

    PanConfiguration::maxAnalytics(10_000);

    PanConfiguration::routePrefix('internal-analytics');
}
```

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

### Bind PanConfiguration and AnalyticsRepository in PanServiceProvider

Source: https://github.com/panphp/pan/blob/main/_autodocs/configuration.md

Container bindings in PanServiceProvider. PanConfiguration is bound to the singleton instance, and AnalyticsRepository is bound to DatabaseAnalyticsRepository.

```php
/** src/Adapters/Laravel/Providers/PanServiceProvider.php */
private function registerConfiguration(): void
{
    $this->app->bind(PanConfiguration::class, fn (): PanConfiguration => PanConfiguration::instance());
}

private function registerRepositories(): void
{
    $this->app->bind(AnalyticsRepository::class, DatabaseAnalyticsRepository::class);
}
```

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

### POST /{route_prefix}/events

Source: https://github.com/panphp/pan/blob/main/_autodocs/index.md

The package exposes exactly one route for posting events. The route prefix is configurable via PanConfiguration::routePrefix(string) and defaults to 'pan'. Full request/response schema, validation rules, CSRF, and status codes are detailed in endpoints.md.

```APIDOC
## [POST] /{route_prefix}/events

### Description
This endpoint is the sole HTTP route exposed by the package, used to submit events for analytics tracking.

### Method
POST

### Endpoint
`/{route_prefix}/events` (default `/pan/events`)

### Parameters
#### Path Parameters
- **route_prefix** (string) - Required - The configurable route prefix, defaulting to `pan`.

### Request Example
Refer to endpoints.md for the full request schema.

### Response
Refer to endpoints.md for the full response schema, validation rules, CSRF, and status codes.
```

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

### PanConfiguration private constructor with defaults

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Defines the private constructor with default values for maxAnalytics, allowedAnalytics, routePrefix, and databaseConnection. The constructor is private and not called by consumers.

```php
private function __construct(
    private int $maxAnalytics = 50,
    private array $allowedAnalytics = [],
    private string $routePrefix = 'pan',
    private ?string $databaseConnection = null,
) {
    //
}
```

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

### reset() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Restores defaults: maxAnalytics(50), allowedAnalytics([]), routePrefix('pan'). Note: databaseConnection is not reset.

```php
public static function reset(): void
```

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

### Custom AnalyticsRepository binding in service provider

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticsRepository.md

Shows how to substitute a custom implementation of AnalyticsRepository by re-binding it in the application's service provider. The container binding is the only wire-up needed.

```php
use Illuminate\Support\ServiceProvider;
use Pan\Contracts\AnalyticsRepository;

// Custom implementation of AnalyticsRepository goes here.

final class AppServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->bind(AnalyticsRepository::class, CustomAnalyticsRepository::class);
    }
}
```

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

### Migration schema for pan_analytics table

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Creates the pan_analytics table with columns for id, name, impressions, hovers, and clicks. There is no unique constraint on name; uniqueness is enforced by the repository's read-then-insert/increment logic.

```php
Schema::create('pan_analytics', function (Blueprint $table): void {
    $table->id();
    $table->string('name');

    $table->unsignedBigInteger('impressions')->default(0);
    $table->unsignedBigInteger('hovers')->default(0);
    $table->unsignedBigInteger('clicks')->default(0);
});
```

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

### PanConfiguration::reset()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Restores defaults: maxAnalytics(50), allowedAnalytics([]), routePrefix('pan'). Note that databaseConnection is not reset.

```APIDOC
## PanConfiguration::reset()

### Description
Restores defaults: `maxAnalytics(50)`, `allowedAnalytics([])`, `routePrefix('pan')`. **Note:** `databaseConnection` is *not* reset.

### Method
`public static function reset(): void`

### Example
```php
PanConfiguration::reset();
```
```

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

### Register Pan events route

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Registers the POST /events route under a configurable prefix. The prefix defaults to 'pan' and can be changed via PanConfiguration::routePrefix(). Routes are registered on boot; changing the prefix at runtime requires re-registration.

```php
Route::prefix($config->toArray()['route_prefix'])->group(function (): void {
    Route::post('/events', [EventController::class, 'store']);
});
```

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

### Basic usage: from HTTP-payload string

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventType.md

Shows how to create an EventType instance from a string value, as done in EventController::store. Note that an invalid value throws an exception.

```php
use Pan\Enums\EventType;

$type = EventType::from('click');   // EventType::CLICK
$name = EventType::from('hover');   // EventType::HOVER
$type = EventType::from('invalid'); // throws (backing value not defined)
```

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

### setDatabaseConnection method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Instance-level equivalent of databaseConnection(). Declared @internal.

```php
public function setDatabaseConnection(string $connection): void
```

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

### connection() helper method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Resolves the Connection instance used for all analytics queries. getDatabaseConnection() returns null when unconfigured, causing DatabaseManager::connection(null) to yield the default connection. This enables redirecting queries to another connection via PanConfiguration::databaseConnection('secondary').

```php
private function connection(): Connection
{
    return $this->databaseManager->connection($this->config->getDatabaseConnection());
}
```

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

### Vite build configuration for Pan IIFE bundle

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/JavascriptClient.md

Configures Vite to build the client as an IIFE library named 'pan', outputting to resources/js/dist. Used to generate the injected bundle.

```TypeScript
export default defineConfig({
    build: {
        outDir: 'resources/js/dist',
        lib: {
            entry: resolve(__dirname, 'resources/js/src/main.ts'),
            name: 'pan',
            fileName: 'pan',
            formats: ['iife'],
        }
    },
});
```

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

### Check types with composer test:types

Source: https://github.com/panphp/pan/blob/main/CONTRIBUTING.md

Run this command to perform static type checking.

```bash
composer test:types
```

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

### Reading from repository and serializing with toArray()

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Analytic.md

Reads all analytics from the repository and serializes each Analytic to an array using toArray(). The comment shows the expected structure of the resulting $rows array.

```php
use Pan\Contracts\AnalyticsRepository;
use Pan\ValueObjects\Analytic;

$rows = array_map(fn (Analytic $analytic): array => $analytic->toArray(), $this->analytics->all());

// $rows: [{id: 1, name: 'help-modal', impressions: 10, hovers: 4, clicks: 2}, ...]
```

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

### Allow unlimited analytics with PanConfiguration::unlimitedAnalytics

Source: https://github.com/panphp/pan/blob/main/README.md

Allow unlimited analytics records. Use this method to disable the default limit of 50 records.

```php
PanConfiguration::unlimitedAnalytics();
```

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

### toArray method with docblock and return shape

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Converts the Pan configuration to an array. Returns a shaped array with keys max_analytics, allowed_analytics, and route_prefix. The array does not include databaseConnection. Consumers include DatabaseAnalyticsRepository::increment, InjectJavascriptLibrary::inject, and PanServiceProvider::registerRoutes.

```php
/**
 * Converts the Pan configuration to an array.
 *
 * @return array{max_analytics: int, allowed_analytics: array<int, string>, route_prefix: string}
 */
public function toArray(): array
```

```php
[
    'max_analytics'     => 50,          // int
    'allowed_analytics' => ['x'],       // array<int, string>
    'route_prefix'      => 'pan',       // string
]
```

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

### allowedAnalytics() method signature with docblock

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Sets the allowed analytics names to store. Replaces the allow-list.

```php
/**
 * Sets the allowed analytics names to store.
 *
 * @param  array<int, string>  $names
 */
public static function allowedAnalytics(array $names): void
```

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

### Class declaration for AnalyticPresentor

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticPresentor.md

The final class declaration for the internal presenter. It is stateless and can be instantiated directly or autowired.

```php
final class AnalyticPresentor
{
    //
}
```

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

### PanCommand signature and handle method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Defines the `pan` artisan command signature, description, and handle method. The `--filter` option applies a case-sensitive substring filter using `str_contains`. The handle method injects `AnalyticsRepository` and `AnalyticPresentor`.

```php
/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'pan {--filter= : Filter the analytics by name}';

/**
 * The console command description.
 *
 * @var string
 */
protected $description = 'Display all your analytics';

/**
 * Execute the console command.
 */
public function handle(AnalyticsRepository $analytics, AnalyticPresentor $presentor): void

```

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

### PanDeleteCommand signature and handle method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Defines the pan:delete command signature, description, and handle method signature. The handle method receives an AnalyticsRepository instance via dependency injection.

```php
/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'pan:delete {id : The ID of the analytic to delete}';

/**
 * The console command description.
 *
 * @var string
 */
protected $description = 'Delete analytics by ID.';

/**
 * Execute the console command.
 */
public function handle(AnalyticsRepository $repository): void
```

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

### Resolve AnalyticsRepository from container

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Shows the pattern used by the package to resolve the AnalyticsRepository contract from the application container.

```php
use Pan\Contracts\AnalyticsRepository;

// Anywhere the container is available:
$analytics = $this->app->get(AnalyticsRepository::class);
```

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

### Track a Filament action with data-pan

Source: https://github.com/panphp/pan/blob/main/README.md

Track a single Filament action by passing the data-pan attribute via extraAttributes.

```php
Action::make('subscribe')
    ->extraAttributes(['data-pan' => 'subscribe-button'])
```

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

### Constructor injection of AnalyticsRepository

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/AnalyticsRepository.md

Shows how to inject the AnalyticsRepository interface into a class. The container binding resolves to DatabaseAnalyticsRepository by default, so this constructor-injected dependency works out of the box.

```php
class ReportAnalytics
{
    public function __construct(
        private AnalyticsRepository $analytics,
    ) {
        //
    }

    public function totals(): array
    {
        return $this->analytics->all();
    }
}
```

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

### PanFlushCommand signature and handle method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/ArtisanCommands.md

Defines the `pan:flush` artisan command signature, description, and handle method. The handle method calls `$analytics->flush()` to truncate the `pan_analytics` table.

```php
/**
 * The name and signature of the console command.
 *
 * @var string
 */
protected $signature = 'pan:flush';

/**
 * The console command description.
 *
 * @var string
 */
protected $description = 'Flush all your analytics';

/**
 * Execute the console command.
 */
public function handle(AnalyticsRepository $analytics): void

```

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

### getDatabaseConnection method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Returns the configured connection name, or null (default connection). Consumed by DatabaseAnalyticsRepository::connection().

```php
public function getDatabaseConnection(): ?string
```

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

### Usage of CreateEvent with explicit constructor injection

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

Shows a class that injects CreateEvent via its constructor and uses it in a method. This is useful for programmatic event recording.

```php
class TrackNewsletter
{
    public function __construct(
        private CreateEvent $createEvent,
    ) {
        //
    }

    public function subscribe(): void
    {
        $this->createEvent->handle('subscribe-button', EventType::CLICK);
    }
}
```

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

### Reset Pan configuration between tests

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

After dynamically reconfiguring with maxAnalytics(), allowedAnalytics(), and routePrefix(), call reset() to restore defaults: 50, empty array, and 'pan'. Useful for test isolation.

```php
PanConfiguration::maxAnalytics(99);
PanConfiguration::allowedAnalytics(['help-modal']);
PanConfiguration::routePrefix('new-pan');

PanConfiguration::reset(); // back to 50 / [] / 'pan'
```

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

### Error handling and repository inspection for CreateEvent

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

Shows that handle silently drops events when the name is not in the allow-list or when maxAnalytics rows exist. To detect these cases, inspect the repository state. Also shows wrapping handle in a try-catch for database exceptions.

```php
// Silently-guarded cases produce no exception and no record:
$this->createEvent->handle('new-name', EventType::IMPRESSION);

// Inspect the outcome via the repository:
$all = $this->repository->all();

if (count($all) === 0) {
    printf('Event was dropped by the allow-list or the max-analytics guard');
}
```

```php
try {
    $this->createEvent->handle('help-modal', EventType::CLICK);
} catch (DatabaseException $e) {
    // e.g. connection failure — log and continue
}
```

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

### routePrefix() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Changes the URL prefix of the events endpoint.

```php
public static function routePrefix(string $prefix): void
```

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

### flush() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Declares the public method flush() that returns void.

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

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

### DatabaseAnalyticsRepository class declaration and constructor

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Defines the final readonly class implementing AnalyticsRepository. The constructor promotes DatabaseManager and PanConfiguration properties. PanConfiguration is injected by the container and bound to PanConfiguration::instance().

```php
final readonly class DatabaseAnalyticsRepository implements AnalyticsRepository
{
    /**
     * Creates a new analytics repository instance.
     */
    public function __construct(
        private DatabaseManager $databaseManager,
        private PanConfiguration $config
    ) {}
```

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

### Class declaration and constructor

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Table.md

Declares the final readonly Table class with a constructor that accepts an OutputInterface instance.

```php
final readonly class Table
{
    /**
     * Creates a new instance of the table.
     */
    public function __construct(
        private OutputInterface $output,
    ) {
        //
    }
```

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

### store method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventController.md

The store method accepts a validated CreateEventRequest and a container-resolved CreateEvent action. It returns a Response, always 204 No Content on success.

```php
public function store(CreateEventRequest $request, CreateEvent $action): Response
```

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

### PanConfiguration class declaration

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Declares the final class PanConfiguration with a private static instance property for the singleton pattern.

```php
final class PanConfiguration
{
    /**
     * The Pan configuration's instance.
     */
    private static ?self $instance = null;
```

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

### unlimitedAnalytics() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Sets the max to PHP_INT_MAX, effectively removing the row-count guard.

```php
public static function unlimitedAnalytics(): void
```

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

### POST /pan/events

Source: https://github.com/panphp/pan/blob/main/_autodocs/endpoints.md

Endpoint to store an event. The route is registered with a configurable prefix, defaulting to 'pan'.

```APIDOC
## POST /pan/events

### Description
Stores an event via the EventController@store action.

### Method
POST

### Endpoint
/pan/events

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- No request body fields are documented.

### Request Example
No request example provided.

### Response
#### Success Response (200)
No response fields documented.

#### Response Example
No response example provided.
```

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

### display method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/Table.md

Defines the display method that takes headers and rows arrays and outputs the table.

```php
/**
 * Displays the table.
 *
 * @param  array<int, string>  $headers
 * @param  array<int, array<int, string>>  $rows
 */
public function display(array $headers, array $rows): void
```

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

### Whitelist analytics with PanConfiguration::allowedAnalytics

Source: https://github.com/panphp/pan/blob/main/README.md

Whitelist specific analytics to track. Only the listed analytics will be stored in the database. Use this in the register method of a service provider.

```php
use Pan\PanConfiguration;

public function register(): void
{
    PanConfiguration::allowedAnalytics([
        'tab-profile',
        'tab-settings',
    ]);
}
```

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

### Resulting HTML shape

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/InjectJavascriptLibrary.md

Shows the HTML structure after injection, with the script block inserted before the closing body tag.

```html
<html lang="en">
    <head><title>My App</title></head>
    <body>
        <h1>Welcome to my app</h1>
        <script>
            /* pan.iife.js with %_PAN_CSRF_TOKEN_% and %_PAN_ROUTE_PREFIX_% replaced */
        </script>
    </body>
</html>
```

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

### EventType enum with backing values and column() method

Source: https://github.com/panphp/pan/blob/main/_autodocs/types.md

Defines a string-backed enum for event types: CLICK, HOVER, and IMPRESSION, each with a backing value and a column() method that maps to the corresponding database column name. Consumed by CreateEventRequest::rules() (via Rule::enum(EventType::class)), EventController::store (via EventType::from(...)), CreateEvent::handle, and AnalyticsRepository::increment / DatabaseAnalyticsRepository::increment.

```php
enum EventType: string
{
    case CLICK = 'click';
    case HOVER = 'hover';
    case IMPRESSION = 'impression';

    public function column(): string; // 'clicks' | 'hovers' | 'impressions'
}
```

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

### Enum definition with column() method

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/EventType.md

Defines the string-backed enum with three cases and a `column()` method that returns the corresponding database column name for each case.

```php
enum EventType: string
{
    case CLICK = 'click';
    case HOVER = 'hover';
    case IMPRESSION = 'impression';

    /**
     * Returns the column name for the event type.
     */
    public function column(): string
    {
        return match ($this) {
            self::CLICK => 'clicks',
            self::HOVER => 'hovers',
            self::IMPRESSION => 'impressions',
        };
    }
}
```

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

### PanConfiguration::routePrefix(string $prefix)

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Changes the URL prefix of the events endpoint. The route is registered with the given prefix, so the endpoint becomes POST /{prefix}/events.

```APIDOC
## PanConfiguration::routePrefix(string $prefix)

### Description
Changes the URL prefix of the events endpoint. The route is registered as `Route::prefix($config->toArray()['route_prefix'])->group(...)`, so with prefix `'internal-analytics'` the endpoint becomes `POST /internal-analytics/events`. The same value is injected into the JavaScript client.

### Method
`public static function routePrefix(string $prefix): void`

### Parameters
- **prefix** (string) - Required - The new route prefix.

### Example
```php
PanConfiguration::routePrefix('internal-analytics');
```
```

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

### increment() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/DatabaseAnalyticsRepository.md

Declares the public method increment() that takes a name and an EventType.

```php
public function increment(string $name, EventType $event): void
```

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

### handle method signature for CreateEvent

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/CreateEvent.md

The handle method signature that increments the counter for the given event on the named analytic. It delegates to the repository's increment method and returns void.

```php
public function handle(string $name, EventType $event): void
```

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

### AnalyticsRepository interface with increment, flush, delete

Source: https://github.com/panphp/pan/blob/main/_autodocs/types.md

Defines the contract for analytics persistence. all() returns an array of Analytic objects; increment() bumps the counter for one event on one analytic; flush() deletes all analytics; delete() removes one analytic and returns the affected-row count. Implemented by DatabaseAnalyticsRepository (bound in the container) and consumed by CreateEvent, PanCommand, PanFlushCommand, and PanDeleteCommand.

```php
interface AnalyticsRepository
{
    public function all(): array;                       // array<int, Analytic>
    public function increment(string $name, EventType $event): void;
    public function flush(): void;
    public function delete(int $id): int;
}
```

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

### databaseConnection() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Sets the database connection name used by DatabaseAnalyticsRepository for all queries.

```php
public static function databaseConnection(string $connection): void
```

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

### POST /{route_prefix}/events

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/JavascriptClient.md

Endpoint for sending events from the JavaScript client. Requires a CSRF token and validates event names and types.

```APIDOC
## [POST] /{route_prefix}/events

### Description
Endpoint for sending events from the JavaScript client. The default route prefix is `/pan`, making the default endpoint `/pan/events`. The `_token` field is required by Laravel's CSRF middleware and is injected server-side.

### Method
POST

### Endpoint
`/{route_prefix}/events` (default `/pan/events`)

### Parameters
#### Request Body
- **`_token`** (string) - Required - CSRF token, injected server-side.
- **`name`** (string) - Required - Event name, must be `alpha_dash` ASCII.
- **`type`** (string) - Required - Event type, must be one of `click`, `hover`, or `impression`.

### Response
#### Success Response (200)
No response body details provided.

### Notes
- Validation rules are defined in [CreateEventRequest](CreateEventRequest.md).
- See [endpoints.md](../endpoints.md) for more details.
```

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

### setMaxAnalytics method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Instance-level equivalent of maxAnalytics(). Declared @internal.

```php
public function setMaxAnalytics(int $number): void
```

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

### PanServiceProvider class declaration

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanServiceProvider.md

Declares the final PanServiceProvider class extending ServiceProvider. The class body is empty as shown.

```php
final class PanServiceProvider extends ServiceProvider
{
    //
}
```

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

### handle method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/InjectJavascriptLibrary.md

Signature of the handle method that processes the request and returns a Response. The request is only forwarded to the next middleware.

```php
/**
 * Handle an incoming request.
 *
 * @param  Closure(Request): (Response)  $next
 */
public function handle(Request $request, Closure $next): Response
```

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

### Limit analytics count with PanConfiguration::maxAnalytics

Source: https://github.com/panphp/pan/blob/main/README.md

Set a maximum number of analytics records that can be created. This is an alternative to whitelisting when you need dynamic analytics but still want to limit the count.

```php
PanConfiguration::maxAnalytics(10000);
```

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

### maxAnalytics() method signature

Source: https://github.com/panphp/pan/blob/main/_autodocs/api-reference/PanConfiguration.md

Sets the maximum number of analytics rows allowed. Once the table holds max rows, new analytic names are silently ignored.

```php
public static function maxAnalytics(int $number): void
```
Tokens:
Raw