c6digital/laravel-plausible

Send server-side events from Laravel to Plausible.

v1.1.0 2024-03-14 15:04 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This package provides a small wrapper for the Plausible "Events" API that makes it easy to send custom server-side events to Plausible.

Installation

You can install the package via Composer:

composer require c6digital/laravel-plausible

You can publish the config file with:

php artisan vendor:publish --tag="laravel-plausible-config"

Usage

Add your Plausible domain to your .env file.

PLAUSIBLE_DOMAIN=

The domain is the name you gave your site when creating it inside of Plausible.

Use the C6Digital\Plausible\Facades\Plausible facade to start sending events.

Plausible::event(name: 'my-event-name', props: []);

If you prefer to use dependency injection, you can use the C6Digital\Plausible\Plausible class and inject it into your controllers, jobs, etc.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.