class-wc-admin-dashboard-setup.php — WooCommerce 10.9.4

woocommerce / includes / admin / class-wc-admin-dashboard-setup.php

woocommerce / includes / admin Last commit date

class-wc-admin-dashboard-setup.php

210 lines

1	<?php
2	/**
3	* Admin Dashboard - Setup
4	*
5	* @package WooCommerce\Admin
6	* @version 2.1.0
7	*/
8
9	use Automattic\Jetpack\Constants;
10	use Automattic\WooCommerce\Admin\Features\Features;
11	use Automattic\WooCommerce\Admin\Features\OnboardingTasks\TaskLists;
12	use Automattic\WooCommerce\Internal\Admin\Onboarding\OnboardingProfile;
13
14	if ( ! defined( 'ABSPATH' ) ) {
15	exit; // Exit if accessed directly.
16	}
17
18	if ( ! class_exists( 'WC_Admin_Dashboard_Setup', false ) ) :
19
20	/**
21	* WC_Admin_Dashboard_Setup Class.
22	*/
23	class WC_Admin_Dashboard_Setup {
24
25	/**
26	* Check for task list initialization.
27	*/
28	private bool $initialized = false;
29
30	/**
31	* The task list.
32	*/
33	private $task_list = null;
34
35	/**
36	* The tasks.
37	*/
38	private $tasks = null;
39
40	/**
41	* # of completed tasks.
42	*
43	* @var int
44	*/
45	private $completed_tasks_count = 0;
46
47	/**
48	* WC_Admin_Dashboard_Setup constructor.
49	*/
50	public function __construct() {
51	if ( $this->should_display_widget() ) {
52	add_meta_box(
53	'wc_admin_dashboard_setup',
54	__( 'WooCommerce Setup', 'woocommerce' ),
55	array( $this, 'render' ),
56	'dashboard',
57	'normal',
58	'high'
59	);
60	}
61	}
62
63	/**
64	* Render meta box output.
65	*/
66	public function render() {
67	$version = Constants::get_constant( 'WC_VERSION' );
68	wp_enqueue_style( 'wc-dashboard-setup', WC()->plugin_url() . '/assets/css/dashboard-setup.css', array(), $version );
69
70	$task = $this->get_next_task();
71	if ( ! $task ) {
72	return;
73	}
74
75	$button_link = $this->get_button_link( $task );
76	$completed_tasks_count = $this->get_completed_tasks_count();
77	$step_number = $this->get_completed_tasks_count() + 1;
78	$tasks_count = count( $this->get_tasks() );
79
80	// Given 'r' (circle element's r attr), dashoffset = ((100-$desired_percentage)/100) * PI * (r*2).
81	$progress_percentage = ( $completed_tasks_count / $tasks_count ) * 100;
82	$circle_r = 6.5;
83	$circle_dashoffset = ( ( 100 - $progress_percentage ) / 100 ) * ( pi() * ( $circle_r * 2 ) );
84
85	include __DIR__ . '/views/html-admin-dashboard-setup.php';
86	}
87
88	/**
89	* Get the button link for a given task.
90	*
91	* @param Task $task Task.
92	* @return string
93	*/
94	public function get_button_link( $task ) {
95	// Check if core profiler needs completion and redirect to it.
96	if ( class_exists( OnboardingProfile::class ) ) {
97	if ( OnboardingProfile::needs_completion() ) {
98	return wc_admin_url( '&path=/setup-wizard' );
99	}
100	}
101
102	$url = (string) $task->get_json()['actionUrl'];
103
104	if ( substr( $url, 0, 4 ) === 'http' ) {
105	return $url;
106	} elseif ( $url ) {
107	return wc_admin_url( '&path=' . $url );
108	}
109
110	return admin_url( 'admin.php?page=wc-admin&task=' . $task->get_id() );
111	}
112
113	/**
114	* Get the task list.
115	*
116	* @return array
117	*/
118	public function get_task_list() {
119	if ( $this->task_list \|\| $this->initialized ) {
120	return $this->task_list;
121	}
122
123	$this->set_task_list( TaskLists::get_list( 'setup' ) );
124	$this->initialized = true;
125	return $this->task_list;
126	}
127
128	/**
129	* Set the task list.
130	*/
131	public function set_task_list( $task_list ) {
132	return $this->task_list = $task_list;
133	}
134
135	/**
136	* Get the tasks.
137	*
138	* @return array
139	*/
140	public function get_tasks() {
141	if ( $this->tasks ) {
142	return $this->tasks;
143	}
144
145	$this->tasks = $this->get_task_list()->get_viewable_tasks();
146	return $this->tasks;
147	}
148
149	/**
150	* Return # of completed tasks
151	*
152	* @return integer
153	*/
154	public function get_completed_tasks_count() {
155	$completed_tasks = array_filter(
156	$this->get_tasks(),
157	function( $task ) {
158	return $task->is_complete();
159	}
160	);
161
162	return count( $completed_tasks );
163	}
164
165	/**
166	* Get the next task.
167	*
168	* @return array\|null
169	*/
170	private function get_next_task() {
171	foreach ( $this->get_tasks() as $task ) {
172	if ( false === $task->is_complete() ) {
173	return $task;
174	}
175	}
176
177	return null;
178	}
179
180	/**
181	* Check to see if we should display the widget
182	*
183	* @return bool
184	*/
185	public function should_display_widget() {
186	if ( ! class_exists( 'Automattic\WooCommerce\Admin\Features\Features' ) \|\| ! class_exists( 'Automattic\WooCommerce\Admin\Features\OnboardingTasks\TaskLists' ) ) {
187	return false;
188	}
189
190	if ( ! Features::is_enabled( 'onboarding' ) \|\| ! WC()->is_wc_admin_active() ) {
191	return false;
192	}
193
194	if ( ! current_user_can( 'manage_woocommerce' ) ) {
195	return false;
196	}
197
198	if ( ! $this->get_task_list() \|\| $this->get_task_list()->is_hidden() \|\| $this->get_task_list()->is_complete() ) {
199	return false;
200	}
201
202	return true;
203	}
204
205	}
206
207	endif;
208
209	return new WC_Admin_Dashboard_Setup();
210