canerdogan/laravel-mixpanel

MixPanel wrapper for Laravel 5.*

Thursday, April 13, 2017
by canerdogan
Repository
1 Watchers
0 Stars
168 Installations

PHP
0 Dependents
0 Suggesters
22 Forks
0 Open issues
70 Versions
0 % Grown

The README.md

MixPanel for Laravel 5

Features

Asynchronous data transmission to Mixpanel's services. This prevents any delays to your application if Mixpanel is down, or slow to respond.
Drop-in installation and configuration into your Laravel app, tracking the most common events out of the box.
Simple Stripe integration allowing you to track revenues at the user level.
Front-end-ready Mixpanel JS library, both for Laravel Elixir inclusion or Blade template use.

Requirements and Compatibility

PHP 7
Laravel 5.1 (LTS)
Laravel 5.3
Laravel 5.4 (current)

Legacy Versions

Installation

composer require canerdogan/laravel-mixpanel

Add the service provider entry in config\app.php:, _(*1)

CanErdogan\LaravelMixpanel\Providers\LaravelMixpanelService::class,

Verify that your auth configuration file config/auth.php has the user model specified in auth.providers.users.model (or in auth.model for L5.1). If that entry is missing, go ahead and add it., _(*2)

// Laravel 5.3
'providers' => [
    'users' => [
        'driver' => '...',
        'model' => App\User::class,
    ],

// Laravel 5.1
'model' => App\User::class,

Lastly, add your Mixpanel API token to your .env file:, _(*3)

MIXPANEL_TOKEN=xxxxxxxxxxxxxxxxxxxxxx

Configuration

Default Values

services.mixpanel.token: pulls the 'MIXPANEL_TOKEN' value from your .env file.
services.mixpanel.enable-default-tracking: (default: true) enable or disable Laravel user event tracking.
services.mixpanel.consumer: (default: socket) set the Guzzle adapter you want to use.
services.mixpanel.connect-timeout: (default: 2) set the number of seconds after which connections timeout.
services.mixpanel.timeout: (default: 2) set the number of seconds after which event tracking times out.

Upgrade Notes

Page Views

Page view tracking has been removed in favor of Mixpanels in-built Autotrack functionality, which tracks all page views. To turn it on, visit your Mixpanel dashboard, click Applications > Autotrack > Web > etc. and enable Autotracking.

Usage

Track

event( new MixpanelEvent( 'Dashboard' ) );

OR, _(*4)

event( new MixpanelEvent( 'Welcome Modal', Auth::user() ) );

OR With parameters, _(*5)

event( new MixpanelEvent( 'Send Invitation', ['Status' => 'Done'] ) );

Increment

event( new MixpanelEvent( 'increment', ['Login Count', 1] ) );

PHP Events

Stripe Web-Hook

If you wish to take advantage of the Stripe web-hook and track revenue per user, you should install Cashier: - Laravel 5.4 - Laravel 5.3 - Laravel 5.1, _(*6)

Once that has been completed, exempt the web-hook endpoint from CSRF-validation in /app/Http/Middleware/VerifyCsrfToken.php:, _(*7)

    protected $except = [
        'canerdogan/laravel-mixpanel/stripe',
    ];

The only other step remaining is to register the web-hook with Stripe: Log into your Stripe account: https://dashboard.stripe.com/dashboard, and open your account settings' webhook tab:, _(*8)

Enter your MixPanel web-hook URL, similar to the following: http://<your server.com>/canerdogan/laravel-mixpanel/stripe: screen shot 2015-05-31 at 1 35 01 pm , _(*9)

Be sure to select "Live" if you are actually running live (otherwise put into test mode and update when you go live). Also, choose "Send me all events" to make sure Laravel Mixpanel can make full use of the Stripe data., _(*10)

JavaScript Events & Auto-Track

Laravel Elixir

Add the following lines to your /resources/js/app.js (or equivalent), and don't forget to replace YOUR_MIXPANEL_TOKEN with your actual token:, _(*11)

require('./../../../public/canerdogan-laravel-mixpanel/js/mixpanel.js');
mixpanel.init("YOUR_MIXPANEL_TOKEN");

Blade Template

First publish the necessary assets:, _(*12)

php artisan mixpanel:publish --assets

Then add the following to the head section of your layout template:, _(*13)

@include ('canerdogan-laravel-mixpanel::partials.mixpanel')

Usage

MixPanel is loaded into the IoC as a singleton. This means you don't have to manually call $mixPanel::getInstance() as described in the MixPanel docs. This is already done for you in the ServiceProvider., _(*14)

Common user events are automatically recorded: - User Registration - User Deletion - User Login - User Login Failed - User Logoff - Cashier Subscribed - Cashier Payment Information Submitted - Cashier Subscription Plan Changed - Cashier Unsubscribed, _(*15)

To make custom events, simple get MixPanel from the IoC using DI:, _(*16)

use CanErdogan\LaravelMixPanel\LaravelMixPanel;

class MyClass
{
    protected $mixPanel;

    public function __construct(LaravelMixPanel $mixPanel)
    {
        $this->mixPanel = $mixPanel;
    }
}

If DI is impractical in certain situations, you can also manually retrieve it from the IoC:, _(*17)

$mixPanel = app('mixpanel');

After that you can make the usual calls to the MixPanel API: - $mixPanel->identify($user->id); - $mixPanel->track('User just paid!'); - $mixPanel->people->trackCharge($user->id, '9.99'); - $mixPanel->people->set($user->id, [$data]);, _(*18)

And so on ..., _(*19)

Laravel Integration

Out of the box it will record the common events anyone would want to track. Also, if the default $user->name field is used that comes with Laravel, it will split up the name and use the last word as the last name, and everything prior for the first name. Otherwise it will look for first_name and last_name fields in the users table., _(*20)

User registers:, _(*21)

Track:
User:
  - Status: Registered
People:
- $first_name: <user's first name>
- $last_name: <user's last name>
- $email: <user's email address>
- $created: <date user registered>

User is updated:, _(*22)

People:
- $first_name: <user's first name>
- $last_name: <user's last name>
- $email: <user's email address>
- $created: <date user registered>

User is deleted:, _(*23)
```
Track:
User:
  - Status: Deactivated
```
User is restored (from soft-deletes):, _(*24)
```
Track:
User:
  - Status: Reactivated
```

User logs in:, _(*25)

Track:
Session:
  - Status: Logged In
People:
- $first_name: <user's first name>
- $last_name: <user's last name>
- $email: <user's email address>
- $created: <date user registered>

User login fails:, _(*26)

Track:
Session:
  - Status: Login Failed
People:
- $first_name: <user's first name>
- $last_name: <user's last name>
- $email: <user's email address>
- $created: <date user registered>

User logs out:, _(*27)
```
Track:
Session:
  - Status: Logged Out
```

Stripe Integration (test needed)

Many L5 sites are running Cashier to manage their subscriptions. This package creates an API webhook endpoint that keeps vital payment analytics recorded in MixPanel to help identify customer churn., _(*28)

Out of the box it will record the following Stripe events in MixPanel for you:, _(*29)

Charges

Authorized Charge (when only authorizing a payment for a later charge date):, _(*30)
```
Track:
Payment:
  - Status: Authorized
  - Amount: <amount authorized>
```

Captured Charge (when completing a previously authorized charge):, _(*31)

Track:
Payment:
  - Status: Captured
  - Amount: <amount of payment>
People TrackCharge: <amount of intended payment>

Completed Charge:, _(*32)

Track:
Payment:
  - Status: Successful
  - Amount: <amount of payment>
People TrackCharge: <amount of payment>

Refunded Charge:, _(*33)

Track:
Payment:
  - Status: Refunded
  - Amount: <amount of refund>
People TrackCharge: -<amount of refund>

Failed Charge:, _(*34)

Track:
Payment:
  - Status: Failed
  - Amount: <amount of intended payment>

Subscriptions

Customer subscribed:, _(*35)

Track:
Subscription:
  - Status: Created
People:
- Subscription: <plan name>

Customer unsubscribed:, _(*36)

Track:
Subscription:
  - Status: Canceled
  - Upgraded: false
Churn! :(
People:
- Subscription: None
- Churned: <date canceled>
- Plan When Churned: <subscribed plan when canceled>
- Paid Lifetime: <number of days from subscription to cancelation> days

Customer started trial:, _(*37)

Track:
Subscription:
  - Status: Trial
People:
- Subscription: Trial

Customer upgraded plan:, _(*38)

Track:
Subscription:
  - Upgraded: true
Unchurn! :-)
People:
- Subscription: <new plan name>

Customer downgraded plan (based on dollar value compared to previous plan):, _(*39)

Track:
Subscription:
  - Upgraded: false
Churn! :-(
People:
- Subscription: <new plan name>
- Churned: <date plan was downgraded>
- Plan When Churned: <plan name prior to downgrading>

The Versions

13/04 2017

dev-master

9999999-dev

MixPanel wrapper for Laravel 5.*

library laravel-mixpanel

MixPanel wrapper for Laravel 5.*

canerdogan/laravel-mixpanel

The README.md

MixPanel for Laravel 5

Features

Requirements and Compatibility

Legacy Versions

Installation

Configuration

Default Values

Upgrade Notes

Page Views

Usage

Track

Increment

PHP Events

Stripe Web-Hook

JavaScript Events & Auto-Track

Laravel Elixir

Blade Template

Usage

Laravel Integration

Stripe Integration (test needed)

Charges

Subscriptions

The Versions

dev-master

The Requires

The Development Requires

by Can Erdogan

0.7.4

The Requires

The Development Requires

by Can Erdogan

0.7.3

The Requires

The Development Requires

by Can Erdogan

0.7.2

The Requires

The Development Requires

by Can Erdogan

0.7.1

The Requires

The Development Requires

by Can Erdogan

0.7

The Requires

The Development Requires

by Can Erdogan

0.6.5

The Requires

The Development Requires

by Can Erdogan

0.6.4

The Requires

The Development Requires

by Mike Bronner

0.6.3

The Requires

The Development Requires

by Mike Bronner

0.6.2

The Requires

The Development Requires

by Mike Bronner

0.6.1

The Requires

The Development Requires

by Mike Bronner

0.6.0

The Requires

The Development Requires

by Mike Bronner

0.6.0-RC

The Requires

The Development Requires

by Mike Bronner

0.5.3