Download the PHP package daanra/laravel-segment without Composer
On this page you can find all versions of the php package daanra/laravel-segment. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download daanra/laravel-segment
More information about daanra/laravel-segment
Files in daanra/laravel-segment
Package laravel-segment
Short Description Laravel Segment is an opinionated, approach to integrating Segment into your Laravel application.
License MIT
Homepage https://github.com/Daanra/laravel-segment
Informations about the package laravel-segment
Laravel Segment
Laravel Segment is an opinionated, approach to integrating Segment into your Laravel application.
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file, which should be located at config/segment.php
:
Setting your write key
Your write key is the API key given to you by Segment which can be found under your PHP source settings;
https://app.segment.com/{your-workspace-name}/sources/{your-source-name}/settings/keys
in the Segment UI.
What is a Segment User
When we talk about a 'user' in the context of this package we mean any object that
implements the SlashEquip\LaravelSegment\Contracts\CanBeIdentifiedForSegment
contract
the package comes with a trait (and the interface) you can attach to your default
User model;
Using this trait will automagically use your users' primary key as the identifier
that is sent to Segment. Alternatively, you can implement your own instance of the
public function getSegmentIdentifier(): string;
method on your User model and not
use the trait.
Globally identifying users
If you are sending Segment events in multiple places through your application and through-out a request it might make sense to globally identify a user to make it more convenient when making tracking calls.
Globally setting context
Segment allows you to send (context)[https://segment.com/docs/connections/spec/common/#context] with your tracking events too, you can set a global context that applies to all tracking events.
Here have some convenience
Laravel Segment ships with a middleware that you can apply in your HTTP Kernal that will handle the setting of the global user and some sensible global context too. It should be simple to extend this middleware and adjust for your needs if you want to add to the default context provided.
Usage
For tracking events
For identifying users
Misc
Deferring
When you start to fire many events in your application, even 2-3 per request it can be hyper-beneficial to turn on deferring (see config). When deferring is enabled, the service will store all of your tracking events triggered through-out the request or process and then send them in batch after your application has responded to your user. This happens during the Laravel termination.
Safe mode
By default safe-mode is turned on. When safe-mode is active it will swallow any exceptions thrown when making the HTTP request to Segmenta and report them automatically to the exception handler, allow your app to continue running. When disabled then the exception will be thrown.
Testing
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
- SlashEquip
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-segment with dependencies
guzzlehttp/guzzle Version ^7.0
illuminate/contracts Version ^8.0|^9.0|^10.0
myclabs/php-enum Version ^1.8