README

About

The sanskritick/matomo-tracker Laravel package is a wrapper for the matomo/matomo-php-tracker. The Matomo php tracker allows serverside tracking.

Features

MatomoTracker Facade
Queued tracking requests in Laravel queue

Feel free to suggest new features.

Installation

Via Composer

Require the sanskritick/matomo-tracker package in your composer.json and update your dependencies:

composer require sanskritick/matomo-tracker

Publish the config file (optional)

Run php artisan vendor:publish to publish the config file if needed.

php artisan vendor:publish

Update your .env

Add these variables to your .env file and configure it to fit your environment.

[...]
MATOMO_URL="https://your.matomo-install.com"
MATOMO_SITE_ID=1
MATOMO_AUTH_TOKEN="00112233445566778899aabbccddeeff"
MATOMO_QUEUE="matomotracker"
[...]

That's it!

Usage

You can use the facade to track.

MatomoTracker::doTrackPageView('Page Title')

Tracking

Basic functionality

Please see the [https://developer.matomo.org/api-reference/PHP-Matomo-Tracker](Matomo Tracker) page for basic method documentation.

Additionally there are some Methods to simplyfy the usage:

// instead of using 
MatomoTracker::doTrackAction($actionUrl, 'download') // or
MatomoTracker::doTrackAction($actionUrl, 'link')

// you can use this
MatomoTracker::doTrackDownload($actionUrl);
MatomoTracker::doTrackOutlink($actionUrl);

Queues

For queuing you can use these functions.

MatomoTracker::queuePageView(string $documentTitle)
MatomoTracker::queueEvent(string $category, string $action, $name = false, $value = false)
MatomoTracker::queueContentImpression(string $contentName, string $contentPiece = 'Unknown', $contentTarget = false)
MatomoTracker::queueContentInteraction(string $interaction, string $contentName, string $contentPiece = 'Unknown', $contentTarget = false)
MatomoTracker::queueSiteSearch(string $keyword, string $category = '',  $countResults = false)
MatomoTracker::queueGoal($idGoal, $revencue = 0.0)
MatomoTracker::queueDownload(string $actionUrl)
MatomoTracker::queueOutlink(string $actionUrl)
MatomoTracker::queueEcommerceCartUpdate(float $grandTotal)
MatomoTracker::queueEcommerceOrder(float $orderId, float $grandTotal, float $subTotal = 0.0, float $tax = 0.0, float $shipping = 0.0,  float $discount = 0.0)
MatomoTracker::queueBulkTrack()

For setting up queues, find the documentation on Laravel Queues.

Settings

Have a look in the [https://developer.matomo.org/api-reference/PHP-Matomo-Tracker](Matomo Tracker) page for basic settings documentation.

Additionaly these settings are available:

MatomoTracker::setCustomDimension(int $id, string $value) // only applicable if the custom dimensions plugin is installed on the Matomo installation
MatomoTracker::setCustomDimensions([]) // array of custom dimension objects {id: <int>, value: <string>} // bulk insert of custom dimensions and basic type checking
MatomoTracker::setCustomVariables([]) // array of custom variable objects {id: <int>, name: <string>, value: <string>, scope: <string>} // bulk insert of custom variables and basic type checking

Change log

Please see the changelog for more information on what has changed recently.

Contributing

Please see contributing.md for details and a todolist.

Security

Please see security.md for details and a todolist.

License

MIT. Please see the license file for more information.

sanskritick / matomo-tracker

Maintainers

Details