Ackee Analytics for KirbyCMS
Plugin for KirbyCMS to generate dynamic tracking-scripts for Ackee.
Plugin requirements
- PHP 7+
- KirbyCMS 3
Setup
Clone the repository into your site/plugins folder.
# HTTPS
git clone https://github.com/Sociant/kirby-ackee-analytics.git
# SSH
git clone [email protected]:Sociant/kirby-ackee-analytics.git
Add the plugin to your submodules
# Open from root directory of your project
git submodule add https://github.com/Sociant/kirby-ackee-analytics.git site/plugins/kirby-ackee-analytics
Add the plugin to your template by adding this line to a header-element
<span class="pl-v">Your</span> <span class="pl-v">Title</span>
"UTF-8">
echo $page->ackeeHeader() ?>
...
Without any changes in the config you won't see a script because the extension is disabled by default.
To enable the extension, add the following line to your config.php (site/config/config.php):
return [
// your other options
'sociant.ackee-analytics' => [
'ackee-analytics-url' => 'https://your-ackee-sever.de',
'tracker-file-name' => 'tracker.js',
'enable-tracking' => true,
'domain-id' => 'Your domain-id',
// optional if you want to gather information about the language, device and screen resolution of the visitor
'detailed' => true,
// optional if you want to track visitors from localhost
'ignore-localhost' => false,
// optional if you want to track yourself (if you're logged into your ackee-server)
'ignore-own-visits' => false,
]
];
Customization per template
You can easily change the behaviour of the plugin by extending the ackeeHeader method with options.
You dont have to add every option. If one option is not defined it will fallback to the page option or the global option.
<span class="pl-v">Your</span> <span class="pl-v">Title</span>
"UTF-8">
echo $page->ackeeHeader([
'isEnabled' => true,
'trackerFileName' => 'tracker.js',
'analyticsUrl' => '',
'domainId' => '',
'detailed' => true,
'ignoreLocalhost' => false,
'ignoreOwnVisits' => false,
]) ?>
...
Customization per page
As always you can edit the script by adding options to your page. You can add following identifiers to your blueprint to affect each page:
| key | function |
|---|---|
| ackeeTracking | to enable or disable tracking |
| ackeeTrackerFileName | the name of the tracker-file (usually 'tracker.js') |
| ackeeAnalyticsUrl | the url of the ackee-server |
| ackeeDomainId | the domain-id of your kirby-website |
| ackeeDetailed | to enable or disable detailed tracking |
| ackeeIgnoreLocalhost | to enable or disable tracking from localhost |
| ackeeIgnoreOwnVisits | to enable or disable tracking yourself (if you're logged into your ackee-server) |
Please note that the plugin prioritizes the template options over the page options. If none of them are defined it will always fallback to the global configuration.
License
This plugin is an open-source software licensed under the MIT license.
Copyright © 2021 Sociant
4 Oct 6, 2021
2 Sep 10, 2021
4 Dec 20, 2022
2 Jul 18, 2022
1 Jan 21, 2022
1 Jun 1, 2022
6 Dec 21, 2022
49 Jan 8, 2022
5 Oct 2, 2022
526 Dec 5, 2022
1 Oct 16, 2021
1 Jan 6, 2022
185 Dec 26, 2022
100 Nov 4, 2022
68 Dec 15, 2022
152 Dec 14, 2022
3 Jun 27, 2021
7 Jan 6, 2022
3 Feb 25, 2022
27 Nov 25, 2021
5 Dec 30, 2022
9 Jun 1, 2022
6 Oct 3, 2022
8 Dec 30, 2022
5 Dec 20, 2022
449 Jan 4, 2023
46 Dec 7, 2022
4 Dec 26, 2021