elementor / modules / checklist / module.php

module.php in Elementor Website Builder – more than just a page builder 4.2.0-dev2, at modules/checklist/module.php

245 lines 7.2 KB

Raw Download Zip

1	<?php
2
3	namespace Elementor\Modules\Checklist;
4
5	use Elementor\Core\Base\Module as BaseModule;
6	use Elementor\Modules\ElementorCounter\Module as Elementor_Counter;
7	use Elementor\Core\Isolation\Wordpress_Adapter;
8	use Elementor\Core\Isolation\Wordpress_Adapter_Interface;
9	use Elementor\Core\Isolation\Elementor_Adapter;
10	use Elementor\Core\Isolation\Elementor_Adapter_Interface;
11	use Elementor\Core\Isolation\Elementor_Counter_Adapter_Interface;
12	use Elementor\Plugin;
13	use Elementor\Utils;
14	use Elementor\Modules\Checklist\Data\Controller;
15
16	if ( ! defined( 'ABSPATH' ) ) {
17	exit; // Exit if accessed directly.
18	}
19
20	class Module extends BaseModule implements Checklist_Module_Interface {
21	const DB_OPTION_KEY = 'elementor_checklist';
22	const VISIBILITY_SWITCH_ID = 'show_launchpad_checklist';
23	const FIRST_CLOSED_CHECKLIST_IN_EDITOR = 'first_closed_checklist_in_editor';
24	const LAST_OPENED_TIMESTAMP = 'last_opened_timestamp';
25	const SHOULD_OPEN_IN_EDITOR = 'should_open_in_editor';
26	const IS_POPUP_MINIMIZED_KEY = 'is_popup_minimized';
27
28	private Steps_Manager $steps_manager;
29	private Wordpress_Adapter_Interface $wordpress_adapter;
30	private Elementor_Adapter_Interface $elementor_adapter;
31	private Elementor_Counter_Adapter_Interface $counter_adapter;
32	private $user_progress = null;
33
34	/**
35	* @param ?Wordpress_Adapter_Interface $wordpress_adapter
36	* @param ?Elementor_Adapter_Interface $elementor_adapter
37	*
38	* @return void
39	*/
40	public function __construct(
41	?Wordpress_Adapter_Interface $wordpress_adapter = null,
42	?Elementor_Adapter_Interface $elementor_adapter = null
43	) {
44	$this->wordpress_adapter = $wordpress_adapter ?? new Wordpress_Adapter();
45	$this->elementor_adapter = $elementor_adapter ?? new Elementor_Adapter();
46
47	parent::__construct();
48	$this->init_user_progress();
49
50	Plugin::$instance->data_manager_v2->register_controller( new Controller() );
51	$this->user_progress = $this->user_progress ?? $this->get_user_progress_from_db();
52	$this->handle_checklist_visibility_with_kit();
53	$this->steps_manager = new Steps_Manager( $this );
54
55	if ( ! current_user_can( 'manage_options' ) ) {
56	return;
57	}
58
59	$this->enqueue_editor_scripts();
60	}
61
62	/**
63	* Get the module name.
64	*
65	* @return string
66	*/
67	public function get_name(): string {
68	return 'e-checklist';
69	}
70
71	/**
72	* Gets user's progress from db
73	*
74	* @return array {
75	* @type bool $is_hidden
76	* @type int $last_opened_timestamp
77	* @type array $steps {
78	* @type string $step_id => {
79	* @type bool $is_marked_completed
80	* @type bool $is_absolute_competed
81	* @type bool $is_immutable_completed
82	* }
83	* }
84	* }
85	*/
86	public function get_user_progress_from_db(): array {
87	$db_progress = json_decode( $this->wordpress_adapter->get_option( self::DB_OPTION_KEY ), true );
88	$db_progress = is_array( $db_progress ) ? $db_progress : [];
89
90	$progress = array_merge( $this->get_default_user_progress(), $db_progress );
91
92	$editor_visit_count = $this->elementor_adapter->get_count( Elementor_Counter::EDITOR_COUNTER_KEY );
93	$progress[ self::SHOULD_OPEN_IN_EDITOR ] = 2 === $editor_visit_count && ! $progress[ self::LAST_OPENED_TIMESTAMP ];
94
95	return $progress;
96	}
97
98	/**
99	* Using the step's ID, get the progress of the step should it exist
100	*
101	* @param $step_id
102	*
103	* @return null\|array {
104	* @type bool $is_marked_completed
105	* @type bool $is_completed
106	* }
107	*/
108	public function get_step_progress( $step_id ): ?array {
109	return $this->user_progress['steps'][ $step_id ] ?? null;
110	}
111
112	/**
113	* Update the progress of a step
114	*
115	* @param $step_id
116	* @param $step_progress
117	*
118	* @return void
119	*/
120	public function set_step_progress( $step_id, $step_progress ): void {
121	$this->user_progress['steps'][ $step_id ] = $step_progress;
122	$this->update_user_progress_in_db();
123	}
124
125	public function update_user_progress( $new_data ): void {
126	$allowed_properties = [
127	self::FIRST_CLOSED_CHECKLIST_IN_EDITOR => $new_data[ self::FIRST_CLOSED_CHECKLIST_IN_EDITOR ] ?? null,
128	self::LAST_OPENED_TIMESTAMP => $new_data[ self::LAST_OPENED_TIMESTAMP ] ?? null,
129	self::IS_POPUP_MINIMIZED_KEY => $new_data[ self::IS_POPUP_MINIMIZED_KEY ] ?? null,
130	];
131
132	foreach ( $allowed_properties as $key => $value ) {
133	if ( null !== $value ) {
134	$this->user_progress[ $key ] = $this->get_formatted_value( $key, $value );
135	}
136	}
137
138	$this->update_user_progress_in_db();
139
140	if ( isset( $new_data[ Elementor_Counter::EDITOR_COUNTER_KEY ] ) ) {
141	$this->elementor_adapter->set_count( Elementor_Counter::EDITOR_COUNTER_KEY, $new_data[ Elementor_Counter::EDITOR_COUNTER_KEY ] );
142	}
143	}
144
145	/**
146	* @return Steps_Manager
147	*/
148	public function get_steps_manager(): Steps_Manager {
149	return $this->steps_manager;
150	}
151
152	/**
153	* @return Wordpress_Adapter
154	*/
155	public function get_wordpress_adapter(): Wordpress_Adapter {
156	return $this->wordpress_adapter;
157	}
158
159	/**
160	* @return Elementor_Adapter
161	*/
162	public function get_elementor_adapter(): Elementor_Adapter {
163	return $this->elementor_adapter;
164	}
165
166	public function enqueue_editor_scripts(): void {
167	add_action( 'elementor/editor/before_enqueue_scripts', function () {
168	$min_suffix = Utils::is_script_debug() ? '' : '.min';
169
170	wp_enqueue_script(
171	$this->get_name(),
172	ELEMENTOR_ASSETS_URL . 'js/checklist' . $min_suffix . '.js',
173	[
174	'react',
175	'react-dom',
176	'elementor-common',
177	'elementor-v2-ui',
178	'elementor-v2-icons',
179	'elementor-v2-editor-app-bar',
180	'elementor-web-cli',
181	],
182	ELEMENTOR_VERSION,
183	true
184	);
185
186	wp_set_script_translations( $this->get_name(), 'elementor' );
187	} );
188	}
189
190	public function is_preference_switch_on(): bool {
191	if ( $this->should_switch_preferences_off() ) {
192	return false;
193	}
194
195	$user_preferences = $this->wordpress_adapter->get_user_preferences( self::VISIBILITY_SWITCH_ID );
196
197	return 'yes' === $user_preferences \|\| $this->wordpress_adapter->is_new_installation();
198	}
199
200	public function should_switch_preferences_off(): bool {
201	return ! $this->elementor_adapter->is_active_kit_default() && ! $this->user_progress[ self::LAST_OPENED_TIMESTAMP ] && ! $this->elementor_adapter->get_count( Elementor_Counter::EDITOR_COUNTER_KEY );
202	}
203
204	private function init_user_progress(): void {
205	$default_settings = $this->get_default_user_progress();
206
207	$this->wordpress_adapter->add_option( self::DB_OPTION_KEY, wp_json_encode( $default_settings ) );
208	}
209
210	private function get_default_user_progress(): array {
211	return [
212	self::LAST_OPENED_TIMESTAMP => null,
213	self::FIRST_CLOSED_CHECKLIST_IN_EDITOR => false,
214	self::IS_POPUP_MINIMIZED_KEY => false,
215	'steps' => [],
216	];
217	}
218
219	private function update_user_progress_in_db(): void {
220	$this->wordpress_adapter->update_option( self::DB_OPTION_KEY, wp_json_encode( $this->user_progress ) );
221	}
222
223	private function get_formatted_value( $key, $value ) {
224	if ( self::LAST_OPENED_TIMESTAMP === $key ) {
225	return $value ? time() : null;
226	}
227
228	return $value;
229	}
230
231	private function handle_checklist_visibility_with_kit() {
232	if ( ! $this->should_switch_preferences_off() ) {
233	return;
234	}
235
236	add_action( 'elementor/editor/init', function () {
237	$this->wordpress_adapter->set_user_preferences( self::VISIBILITY_SWITCH_ID, '' );
238	}, 11 );
239	}
240
241	public static function should_display_checklist_toggle_control(): bool {
242	return current_user_can( 'manage_options' );
243	}
244	}
245