robbrazier/piwik

Piwik Package for Laravel

4.2.0 2023-03-17 20:41 UTC

Requires

• php: >=7.3
• guzzlehttp/guzzle: ^6.5|^7.3
• illuminate/support: >=5.0

Requires (Dev)

• ext-json: *
• ext-simplexml: *
• orchestra/testbench: ^6.19
• phpspec/prophecy: ^1.13
• phpunit/phpcov: ^8.2
• phpunit/phpunit: ^9.5

Suggests

• ext-json: Needed to support JSON formatting
• ext-simplexml: Needed to support XML formatting

MIT

• Rob Brazier

• piwik
• laravel

README

An Interface to Piwik's Analytics API for Laravel (Composer Package)

This is the Laravel 5+ version of the Laravel-Piwik Bundle.

Version 4.0.0 and onwards have dropped support for PHP 5.6, 7.0 and 7.1

Installation

Add RobBrazier/Piwik to composer.json:

{
  "require": {
    "robbrazier/piwik": "~4.2"
  }
}

For Laravel 5.4 and below

Add 'RobBrazier\Piwik\PiwikServiceProvider' and 'Piwik' => 'RobBrazier\Piwik\Facades\Piwik' to app/config/app.php

'providers' = [
    ...
    RobBrazier\Piwik\PiwikServiceProvider::class,
    ...
],

[...]

'aliases' = [
    ...
    'Piwik' => RobBrazier\Piwik\Facades\Piwik::class,
    ...
],

For Laravel 5.5 and above, no app.php changes are required as the autoloader will pick up the required configuration

Then move the config file out of the package, so that it doesn't get replaced when you update, by running:

php artisan vendor:publish --provider="RobBrazier\Piwik\PiwikServiceProvider" --tag="config"

Update your packages with composer update or install with composer install.

Then go to config/piwik.php and add your config settings such as server, apikey, siteid etc.

Documentation

Usage Documentation is located at https://docs.robbrazier.com/Laravel_Piwik/Usage.html API Documentation is located at https://docs.robbrazier.com/Laravel_Piwik/API_Docs.html

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT