simpleanalytics / src / Plugin.php

Plugin.php in Simple Analytics 1.46, at src/Plugin.php

193 lines 8.5 KB

Raw Download Zip

1	<?php
2
3	namespace SimpleAnalytics;
4
5	use SimpleAnalytics\Settings\{Page, Tab};
6	use SimpleAnalytics\Actions\AddInactiveComment;
7	use SimpleAnalytics\Actions\AddNoScriptTag;
8	use SimpleAnalytics\Actions\AddPluginSettingsLink;
9	use SimpleAnalytics\Scripts\AnalyticsScript;
10	use SimpleAnalytics\Scripts\AutomatedEventsScript;
11	use SimpleAnalytics\Scripts\InactiveScript;
12
13	final class Plugin
14	{
15	use PluginLifecycle;
16
17	protected function onBoot(): void
18	{
19	if (is_admin()) {
20	$this->defineAdminPage();
21	AddPluginSettingsLink::register();
22	}
23	}
24
25	public function onActivation(): void
26	{
27	$this->addOptions();
28	}
29
30	public function onUninstall(): void
31	{
32	$this->deleteOptions();
33	}
34
35	public function onInit(): void
36	{
37	$shouldCollect = (new TrackingPolicy)->shouldCollectAnalytics();
38	$this->addScripts($shouldCollect);
39	if (! $shouldCollect) {
40	AddInactiveComment::register();
41	}
42	if ($shouldCollect && Setting::boolean(SettingName::NOSCRIPT)) {
43	AddNoScriptTag::register();
44	}
45	}
46
47	/**
48	* Register plugin options and autoload them.
49	*
50	* @note Eliminates any unnecessary database lookups by preloading on each request.
51	* @note Thanks to option autoloading, we don't need to use one serialized option, but several.
52	* This allows the usage of native hooks and filters and reduces the chance of data corruption.
53	*/
54	protected function addOptions(): void
55	{
56	// Add options with default values
57	add_option(SettingName::ENABLED, '1', null, true);
58
59	// Add all remaining options
60	$optionNames = array_diff(SettingName::cases(), [SettingName::ENABLED]);
61	foreach ($optionNames as $name) {
62	add_option($name, null, null, true);
63	}
64
65	// Legacy. Update the option introduced in a previous release to use autoloading.
66	update_option(SettingName::CUSTOM_DOMAIN, get_option(SettingName::CUSTOM_DOMAIN), true);
67	}
68
69	protected function deleteOptions(): void
70	{
71	foreach (SettingName::cases() as $name) {
72	delete_option($name);
73	}
74	}
75
76	protected function addScripts(bool $collect): void
77	{
78	$scripts = new ScriptManager;
79
80	if ($collect) {
81	$scripts->add(new AnalyticsScript);
82	} elseif (is_user_logged_in()) {
83	$scripts->add(new InactiveScript);
84	}
85
86	if (Setting::boolean(SettingName::AUTOMATED_EVENTS)) {
87	$scripts->add(new AutomatedEventsScript);
88	}
89
90	$scripts->register();
91	}
92
93	protected function defineAdminPage(): void
94	{
95	Page::title('Simple Analytics')
96	->slug('simpleanalytics')
97	->tab('General', function (Tab $tab) {
98	$tab->input(SettingName::CUSTOM_DOMAIN, 'Custom Domain')
99	->placeholder('Enter your custom domain or leave it empty.')
100	->description('E.g. api.example.com. Leave empty to use the default domain (most users).')
101	->docs('https://docs.simpleanalytics.com/bypass-ad-blockers');
102
103	$tab->checkbox(SettingName::ENABLED, 'Enabled')
104	->default(true)
105	->description('Enable or disable Simple Analytics on your website.');
106	})
107	->tab('Ignore Rules', function (Tab $tab) {
108	$tab->icon(get_icon('eye-slash'));
109
110	$tab->input(SettingName::IGNORE_PAGES, 'Ignore Pages')
111	->description('Comma separated list of pages to ignore. E.g. /contact, /about')
112	->placeholder('Example: /page1, /page2, /category/*')
113	->docs('https://docs.simpleanalytics.com/ignore-pages');
114
115	$tab->callout('IP and role exclusion only works when there is no page caching.');
116
117	$tab->multiCheckbox(SettingName::EXCLUDED_ROLES, 'Exclude User Roles')
118	->options(function () {
119	return wp_roles()->get_names();
120	});
121
122	$tab->ipList(SettingName::EXCLUDED_IP_ADDRESSES, 'Exclude IP Addresses')
123	->placeholder("127.0.0.1\n192.168.0.1")
124	->description('IP addresses to exclude from tracking.');
125	})
126	->tab('Advanced', function (Tab $tab) {
127	$tab->icon(get_icon('cog'));
128
129	$tab->checkbox(SettingName::COLLECT_DNT, 'Collect Do Not Track')
130	->description('If you want to collect visitors with Do Not Track enabled, turn this on.')
131	->docs('https://docs.simpleanalytics.com/dnt');
132
133	$tab->checkbox(SettingName::HASH_MODE, 'Hash mode')
134	->description('If your website uses hash (#) navigation, turn this on. On most WordPress websites this is not relevant.')
135	->docs('https://docs.simpleanalytics.com/hash-mode');
136
137	$tab->checkbox(SettingName::MANUAL_COLLECT, 'Manually collect page views')
138	->description('In case you don’t want to auto collect page views, but via `sa_pageview` function in JavaScript.')
139	->docs('https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway');
140
141	$tab->checkbox(SettingName::NOSCRIPT, 'Support no JavaScript mode')
142	->description('Collect analytics from visitors with disabled or no JavaScript.');
143
144	$tab->input(SettingName::ONLOAD_CALLBACK, 'Onload Callback')
145	->description('JavaScript function to call when the script is loaded.')
146	->placeholder('Example: sa_event("My event")')
147	->docs('https://docs.simpleanalytics.com/trigger-custom-page-views#use-custom-collection-anyway');
148
149	$tab->input(SettingName::HOSTNAME, 'Overwrite domain name')
150	->description('Override the domain that is sent to Simple Analytics. Useful for multi-domain setups.')
151	->placeholder('Example: example.com')
152	->docs('https://docs.simpleanalytics.com/overwrite-domain-name');
153
154	$tab->input(SettingName::SA_GLOBAL, 'Global variable name')
155	->description('Change the global variable name of Simple Analytics. Default is `sa_event`.')
156	->placeholder('Example: ba_event')
157	->docs('https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used');
158	})
159	->tab('Events', function (Tab $tab) {
160	$tab->title('Automated events')
161	->icon(get_icon('events'))
162	->description("It will track outbound links, email addresses clicks,
163	and amount of downloads for common files (pdf, csv, docx, xIsx).
164	Events will appear on your events page on simpleanalytics.com");
165
166	$tab->checkbox(SettingName::AUTOMATED_EVENTS, 'Collect automated events');
167
168	$tab->input(SettingName::EVENT_COLLECT_DOWNLOADS, 'Auto collect downloads')
169	->placeholder('Example: outbound,emails,downloads')
170	->docs('https://docs.simpleanalytics.com/automated-events');
171
172	$tab->input(SettingName::EVENT_EXTENSIONS, 'Download file extensions')
173	->description('Comma separated list of file extensions to track as downloads. E.g. pdf, zip')
174	->placeholder('Example: pdf, zip')
175	->docs('https://docs.simpleanalytics.com/automated-events');
176
177	$tab->checkbox(SettingName::EVENT_USE_TITLE, 'Use titles of page')
178	->description('Use the title of the page as the event name. Default is the URL.')
179	->docs('https://docs.simpleanalytics.com/automated-events');
180
181	$tab->checkbox(SettingName::EVENT_FULL_URLS, 'Use full URLs')
182	->description('Use full URLs instead of the path. Default is the path.')
183	->docs('https://docs.simpleanalytics.com/automated-events');
184
185	$tab->input(SettingName::EVENT_SA_GLOBAL, 'Override global')
186	->description('Override the global variable name of Simple Analytics. Default is `sa_event`.')
187	->placeholder('Example: ba_event')
188	->docs('https://docs.simpleanalytics.com/events#the-variable-sa_event-is-already-used');
189	})
190	->register();
191	}
192	}
193