Download the PHP package castrocrea/mixpanel-bundle without Composer
On this page you can find all versions of the php package castrocrea/mixpanel-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download castrocrea/mixpanel-bundle
More information about castrocrea/mixpanel-bundle
Files in castrocrea/mixpanel-bundle
Informations about the package mixpanel-bundle
CarstrocreaMixpanelBundle
Integration of the Mixpanel library into Symfony.
- Installation
- Usage
- Killer Feature
- Sending people information to Mixpanel
- Annotations
- Symfony2 Profiler Integration
- Reference Configuration
- License
Installation
Require gordalina/mixpanel-bundle
using composer
Or require
gordalina/mixpanel-bundle
to your composer.json
file:
Register the bundle in config/bundles.php
:
Enable the bundle's configuration in app/config/config.yml
:
Usage
This bundle registers a castrocrea_mixpanel.default
, mixpanel.default
and mixpanel
service which is an instance of Mixpanel
(from the official library).
You'll be able to do whatever you want with it.
NOTE: This bundle sends your client's ip address automatically. If you have
a reverse proxy in you servers you should set it in your front controller public/index.php
:
You can find more documentation on Symfony website: How to Configure Symfony to Work behind a Load Balancer or a Reverse Proxy
Killer Feature
Track an event with a single annotation
Sending people information to Mixpanel
Mixpanel allows you to track your user's behaviours, but also some user information. When using annotations which require the distinct_id, this will be set automatically. This is done automatically provided you have configured it properly. You are able to override this value if you wish.
This bundle uses property access to get the values out of the user object, so
event if you dont have a first_name
property, but have a getFirstName
method
it will work.
NOTE: extra_data
corresponding non-default properties in Mixpanel user profile
In the following example, we call UpdateUser, which sends all information registered
in the configuration above, but we override the id
property with an expression
that evaluates the user id.
The @Expression
annotation uses ExpressionLanguage
for evaluation.
Annotations
Mixpanel Actions
Events
@Mixpanel\Register(prop="visits", value=3)
@Mixpanel\Track(event="name", props={ "firstTime": true })
@Mixpanel\Unregister(prop="$email")
Engagement
@Mixpanel\Append(id=324, prop="fruits", value="apples" [, ignoreTime=false])
@Mixpanel\ClearCharges(id=324 [, ignoreTime=false])
@Mixpanel\DeleteUser(id=324 [, ignoreTime=false])
@Mixpanel\Increment(id=324, prop="visits", value=3 [, ignoreTime=false])
@Mixpanel\Remove(id=324, prop="$email")
@Mixpanel\Set(id=324, props={ "firstTime": true } [, ignoreTime=false])
@Mixpanel\SetOnce(id=324, props={ "firstTime": true } [, ignoreTime=false])
@Mixpanel\TrackCharge(id=697, amount="20.0" [, ignoreTime=false])
Custom Annotations
@Mixpanel\Id()
@Mixpanel\Expression(expression="<expression>")
@Mixpanel\UpdateUser()
Note: The first argument is not required to specify the name explicitly,
e.g: @Mixpanel\Expression("<expression>")
or @Mixpanel\Set("<property>", value="<value>")
.
Note: All id
properties can be omitted, as they will be set with the id of
the current user in security.context
Send an event based on a condition
In all annotations, you can add conditions with Expression Language
Note: By default condition is true and is not required.
MixpanelEvent
You can also send an event through symfony events when the annotations are not sufficient like this:
Override Props in all Annotations
In all your annotations, you can have something like this:
It can be annoying to always have to put the same properties in your annotations. The functioning of the events allows us to avoid that.
And in your config:
Symfony Profiler Integration
Mixpanel bundle additionally integrates with Symfony2 profiler. You can check number of events and engagements sent, total execution time and other information.
Reference Configuration
You'll find the reference configuration below:
Spec
In order to run the specs install all components with composer and run:
License
This bundle is released under the MIT license. See the complete license in the bundle:
All versions of mixpanel-bundle with dependencies
symfony/framework-bundle Version ^4.4 || >=5.0
symfony/expression-language Version ^4.4 || ^5.0
symfony/security-http Version ^4.4 || ^5.0
symfony/http-kernel Version ^4.4.13 || ^5.1.5
mixpanel/mixpanel-php Version ~2.8