1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
<?php
/**
* Jetpack Search: Module_Control class
*
* @package automattic/jetpack-search
*/
namespace Automattic\Jetpack\Search;
use Automattic\Jetpack\Status;
use Jetpack_Options;
use WP_Error;
/**
* To get and set Searh module settings
*/
class Module_Control {
/**
* Plan object
*
* @var Plan
*/
protected $plan;
/**
* We use the same options as Jetpack the plugin to flag whether Search is active.
*/
const JETPACK_ACTIVE_MODULES_OPTION_KEY = 'active_modules';
const JETPACK_SEARCH_MODULE_SLUG = 'search';
const SEARCH_MODULE_INSTANT_SEARCH_OPTION_KEY = 'instant_search_enabled';
/**
* Contructor
*
* @param Plan|null $plan - Plan object.
*/
public function __construct( $plan = null ) {
$this->plan = is_null( $plan ) ? new Plan() : $plan;
}
/**
* Returns a boolean for whether of the module is enabled.
*
* @return bool
*/
public function is_active() {
return in_array( self::JETPACK_SEARCH_MODULE_SLUG, $this->get_active_modules(), true );
}
/**
* Returns a boolean for whether instant search is enabled.
*
* @return bool
*/
public function is_instant_search_enabled() {
return (bool) get_option( self::SEARCH_MODULE_INSTANT_SEARCH_OPTION_KEY );
}
/**
* Activiate Search module
*/
public function activate() {
/**
* Fires before a module is activated.
*
* @since 2.6.0
*
* @param string $module Module slug.
* @param bool $exit Should we exit after the module has been activated. Default to true.
* @param bool $redirect Should the user be redirected after module activation? Default to true.
*/
do_action( 'jetpack_pre_activate_module', self::JETPACK_SEARCH_MODULE_SLUG );
// If it's already active, then don't do it again.
if ( $this->is_active() ) {
return true;
}
// Not available for offline mode.
$is_offline_mode = ( new Status() )->is_offline_mode();
if ( $is_offline_mode ) {
return new WP_Error( 'offline_mode', __( 'Search module can not be activated in offline mode.', 'jetpack-search-pkg' ) );
}
// Return false if no plan supports search.
if ( ! $this->plan->supports_search() ) {
return new WP_Error( 'not_supported', __( 'Your plan does not support Jetpack Search.', 'jetpack-search-pkg' ) );
}
$active_modules = $this->get_active_modules();
$active_modules[] = self::JETPACK_SEARCH_MODULE_SLUG;
$success = Jetpack_Options::update_option( self::JETPACK_ACTIVE_MODULES_OPTION_KEY, $active_modules );
/**
* Fired after a module has been deactivated.
*
* @since 4.2.0
*
* @param string $module Module slug.
* @param boolean $success whether the module was deactivated.
*/
do_action( 'jetpack_activate_module', self::JETPACK_SEARCH_MODULE_SLUG, $success );
/**
* Fires when a module is deactivated.
* The dynamic part of the filter, $module, is the module slug.
*
* @since 1.9.0
*
* @param string $module Module slug.
*/
do_action( 'jetpack_activate_module_' . self::JETPACK_SEARCH_MODULE_SLUG );
return $success;
}
/**
* Deactiviate Search module
*/
public function deactivate() {
/**
* Fires when a module is deactivated.
*
* @since 1.9.0
*
* @param string $module Module slug.
*/
do_action( 'jetpack_pre_deactivate_module', self::JETPACK_SEARCH_MODULE_SLUG );
$active_modules = $this->get_active_modules();
$active_modules = array_values( array_diff( $active_modules, array( self::JETPACK_SEARCH_MODULE_SLUG ) ) );
$success = Jetpack_Options::update_option( self::JETPACK_ACTIVE_MODULES_OPTION_KEY, $active_modules );
/**
* Fired after a module has been deactivated.
*
* @since 4.2.0
*
* @param string $module Module slug.
* @param boolean $success whether the module was deactivated.
*/
do_action( 'jetpack_deactivate_module', self::JETPACK_SEARCH_MODULE_SLUG, $success );
/**
* Fires when a module is deactivated.
* The dynamic part of the filter, $module, is the module slug.
*
* @since 1.9.0
*
* @param string $module Module slug.
*/
do_action( 'jetpack_deactivate_module_' . self::JETPACK_SEARCH_MODULE_SLUG );
$this->disable_instant_search();
return $success;
}
/**
* Update module status
*
* @param boolean $active - true to activate, false to deactivate.
*/
public function update_status( $active ) {
return $active ? $this->activate() : $this->deactivate();
}
/**
* Disable Instant Search Experience
*/
public function disable_instant_search() {
return update_option( self::SEARCH_MODULE_INSTANT_SEARCH_OPTION_KEY, false );
}
/**
* Enable Instant Search Experience
*/
public function enable_instant_search() {
if ( ! $this->is_active() ) {
return new WP_Error( 'search_module_inactive', __( 'Search module needs to be activated before enabling instant search.', 'jetpack-search-pkg' ) );
}
return update_option( self::SEARCH_MODULE_INSTANT_SEARCH_OPTION_KEY, true );
}
/**
* Update instant search status
*
* @param boolean $enabled - true to enable, false to disable.
*/
public function update_instant_search_status( $enabled ) {
return $enabled ? $this->enable_instant_search() : $this->disable_instant_search();
}
/**
* Get a list of activated modules as an array of module slugs.
*/
public function get_active_modules() {
$active_modules = Jetpack_Options::get_option( self::JETPACK_ACTIVE_MODULES_OPTION_KEY );
if ( ! is_array( $active_modules ) ) {
$active_modules = array();
}
/**
* Allow filtering of the active modules.
*
* Gives theme and plugin developers the power to alter the modules that
* are activated on the fly.
*
* @since 5.8.0
*
* @param array $active Array of active module slugs.
*/
$active_modules = apply_filters( 'jetpack_active_modules', $active_modules );
return array_unique( $active_modules );
}
}
|
GitWeb