GetStarted.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.12.1

matomo / classes / WpMatomo / Admin / GetStarted.php

matomo / classes / WpMatomo / Admin Last commit date

GetStarted.php

128 lines

1	<?php
2	/**
3	* Matomo - free/libre analytics platform
4	*
5	* @link https://matomo.org
6	* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
7	* @package matomo
8	*/
9
10	namespace WpMatomo\Admin;
11
12	use WpMatomo\Settings;
13
14	if ( ! defined( 'ABSPATH' ) ) {
15	exit; // if accessed directly
16	}
17
18	class GetStarted implements MatomoPageContent {
19	const NONCE_NAME = 'matomo_enable_tracking';
20	const FORM_NAME = 'matomo';
21
22	/**
23	* @var Settings
24	*/
25	private $settings;
26
27	/**
28	* @param Settings $settings
29	*/
30	public function __construct( $settings ) {
31	$this->settings = $settings;
32	}
33
34	public static function register_hooks() {
35	add_action( 'matomo_before_add_menu', [ self::class, 'on_marketplace_plugin_activated' ] );
36	}
37
38	public static function on_marketplace_plugin_activated() {
39	$settings = new Settings();
40
41	$is_hidden = self::auto_hide_page_if_steps_completed( $settings );
42	if (
43	$is_hidden
44	&& isset( $_REQUEST['page'] )
45	&& Menu::SLUG_GET_STARTED === $_REQUEST['page']
46	) {
47	wp_safe_redirect( admin_url( 'admin.php?page=' . Menu::SLUG_REPORT_SUMMARY ) );
48	exit;
49	}
50	}
51
52	public static function auto_hide_page_if_steps_completed( Settings $settings ) {
53	if ( self::should_auto_hide_get_started_page( $settings ) ) {
54	$settings->apply_changes(
55	[
56	Settings::SHOW_GET_STARTED_PAGE => 0,
57	]
58	);
59
60	return true;
61	}
62
63	return false;
64	}
65	public function show() {
66	$was_updated = $this->update_if_submitted();
67	$settings = $this->settings;
68	$can_user_edit = $this->can_user_manage();
69	$show_this_page = $this->settings->get_global_option( Settings::SHOW_GET_STARTED_PAGE );
70	$matomo_is_marketplace_active = $this->is_marketplace_installed_and_active();
71
72	$matomo_marketplace_setup_wizard = new MarketplaceSetupWizard();
73	$matomo_marketplace_setup_wizard_body = $matomo_marketplace_setup_wizard->get_body( false );
74	$matomo_marketplace_setup_wizard_body->set_design_variant( MarketplaceSetupWizardBody::DESIGN_VARIANT_REDESIGN );
75
76	include __DIR__ . '/views/get_started.php';
77	}
78
79	private function update_if_submitted() {
80	if ( isset( $_POST )
81	&& ! empty( $_POST[ self::FORM_NAME ] )
82	&& is_admin()
83	&& check_admin_referer( self::NONCE_NAME )
84	&& $this->can_user_manage() ) {
85	if ( ! empty( $_POST[ self::FORM_NAME ][ Settings::SHOW_GET_STARTED_PAGE ] )
86	&& 'no' === $_POST[ self::FORM_NAME ][ Settings::SHOW_GET_STARTED_PAGE ] ) {
87	$this->settings->apply_changes(
88	[
89	Settings::SHOW_GET_STARTED_PAGE => 0,
90	]
91	);
92
93	return true;
94	}
95	if ( ! empty( $_POST[ self::FORM_NAME ]['track_mode'] )
96	&& TrackingSettings::TRACK_MODE_DEFAULT === $_POST[ self::FORM_NAME ]['track_mode'] ) {
97	$this->settings->apply_tracking_related_changes( [ 'track_mode' => TrackingSettings::TRACK_MODE_DEFAULT ] );
98
99	self::auto_hide_page_if_steps_completed( $this->settings );
100
101	return true;
102	}
103	}
104
105	return false;
106	}
107
108	public static function should_auto_hide_get_started_page( Settings $settings ) {
109	return $settings->is_tracking_enabled()
110	&& self::is_marketplace_installed_and_active();
111	}
112
113	public static function is_marketplace_installed_and_active() {
114	return MarketplaceSetupWizard::is_marketplace_installed()
115	&& is_plugin_active( MarketplaceSetupWizard::MARKETPLACE_PLUGIN_FILE );
116	}
117
118	public function can_user_manage() {
119	$tracking_settings = new TrackingSettings( $this->settings );
120
121	return $tracking_settings->can_user_manage();
122	}
123
124	public function get_title() {
125	return __( 'Start getting a full picture of your visitors', 'matomo' );
126	}
127	}
128