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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO\Admin\Notifications
*/
/**
* Class Yoast_Alerts.
*/
class Yoast_Alerts {
/**
* @var string
*/
const ADMIN_PAGE = 'wpseo_dashboard';
/**
* Total notifications count.
*
* @var int
*/
private static $notification_count = 0;
/**
* All error notifications.
*
* @var array
*/
private static $errors = array();
/**
* Active errors.
*
* @var array
*/
private static $active_errors = array();
/**
* Dismissed errors.
*
* @var array
*/
private static $dismissed_errors = array();
/**
* All warning notifications.
*
* @var array
*/
private static $warnings = array();
/**
* Active warnings.
*
* @var array
*/
private static $active_warnings = array();
/**
* Dismissed warnings.
*
* @var array
*/
private static $dismissed_warnings = array();
/**
* Yoast_Alerts constructor.
*/
public function __construct() {
$this->add_hooks();
}
/**
* Add hooks
*/
private function add_hooks() {
$page = filter_input( INPUT_GET, 'page' );
if ( self::ADMIN_PAGE === $page ) {
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_assets' ) );
}
// Needed for adminbar and Alerts page.
add_action( 'admin_init', array( __CLASS__, 'collect_alerts' ), 99 );
// Add AJAX hooks.
add_action( 'wp_ajax_yoast_dismiss_alert', array( $this, 'ajax_dismiss_alert' ) );
add_action( 'wp_ajax_yoast_restore_alert', array( $this, 'ajax_restore_alert' ) );
}
/**
* Enqueue assets.
*/
public function enqueue_assets() {
$asset_manager = new WPSEO_Admin_Asset_Manager();
$asset_manager->enqueue_style( 'alerts' );
}
/**
* Handle ajax request to dismiss an alert.
*/
public function ajax_dismiss_alert() {
$notification = $this->get_notification_from_ajax_request();
if ( $notification ) {
$notification_center = Yoast_Notification_Center::get();
$notification_center->maybe_dismiss_notification( $notification );
$this->output_ajax_response( $notification->get_type() );
}
wp_die();
}
/**
* Handle ajax request to restore an alert.
*/
public function ajax_restore_alert() {
$notification = $this->get_notification_from_ajax_request();
if ( $notification ) {
$notification_center = Yoast_Notification_Center::get();
$notification_center->restore_notification( $notification );
$this->output_ajax_response( $notification->get_type() );
}
wp_die();
}
/**
* Create AJAX response data.
*
* @param string $type Alert type.
*/
private function output_ajax_response( $type ) {
$html = $this->get_view_html( $type );
echo WPSEO_Utils::format_json_encode(
array(
'html' => $html,
'total' => self::get_active_alert_count(),
)
);
}
/**
* Get the HTML to return in the AJAX request.
*
* @param string $type Alert type.
*
* @return bool|string
*/
private function get_view_html( $type ) {
switch ( $type ) {
case 'error':
$view = 'errors';
break;
case 'warning':
default:
$view = 'warnings';
break;
}
// Re-collect alerts.
self::collect_alerts();
/** @noinspection PhpUnusedLocalVariableInspection */
$alerts_data = self::get_template_variables();
ob_start();
include WPSEO_PATH . 'admin/views/partial-alerts-' . $view . '.php';
$html = ob_get_clean();
return $html;
}
/**
* Extract the Yoast Notification from the AJAX request.
*
* @return null|Yoast_Notification
*/
private function get_notification_from_ajax_request() {
$notification_center = Yoast_Notification_Center::get();
$notification_id = filter_input( INPUT_POST, 'notification' );
return $notification_center->get_notification_by_id( $notification_id );
}
/**
* Show the alerts overview page.
*/
public static function show_overview_page() {
/** @noinspection PhpUnusedLocalVariableInspection */
$alerts_data = self::get_template_variables();
include WPSEO_PATH . 'admin/views/alerts-dashboard.php';
}
/**
* Collect the alerts and group them together.
*/
public static function collect_alerts() {
$notification_center = Yoast_Notification_Center::get();
$notifications = $notification_center->get_sorted_notifications();
self::$notification_count = count( $notifications );
self::$errors = array_filter( $notifications, array( __CLASS__, 'filter_error_alerts' ) );
self::$dismissed_errors = array_filter( self::$errors, array( __CLASS__, 'filter_dismissed_alerts' ) );
self::$active_errors = array_diff( self::$errors, self::$dismissed_errors );
self::$warnings = array_filter( $notifications, array( __CLASS__, 'filter_warning_alerts' ) );
self::$dismissed_warnings = array_filter( self::$warnings, array( __CLASS__, 'filter_dismissed_alerts' ) );
self::$active_warnings = array_diff( self::$warnings, self::$dismissed_warnings );
}
/**
* Get the variables needed in the views.
*
* @return array
*/
public static function get_template_variables() {
return array(
'metrics' => array(
'total' => self::$notification_count,
'active' => self::get_active_alert_count(),
'errors' => count( self::$errors ),
'warnings' => count( self::$warnings ),
),
'errors' => array(
'dismissed' => self::$dismissed_errors,
'active' => self::$active_errors,
),
'warnings' => array(
'dismissed' => self::$dismissed_warnings,
'active' => self::$active_warnings,
),
);
}
/**
* Get the number of active alerts.
*
* @return int
*/
public static function get_active_alert_count() {
return ( count( self::$active_errors ) + count( self::$active_warnings ) );
}
/**
* Filter out any non-errors.
*
* @param Yoast_Notification $notification Notification to test.
*
* @return bool
*/
private static function filter_error_alerts( Yoast_Notification $notification ) {
return $notification->get_type() === 'error';
}
/**
* Filter out any non-warnings.
*
* @param Yoast_Notification $notification Notification to test.
*
* @return bool
*/
private static function filter_warning_alerts( Yoast_Notification $notification ) {
return $notification->get_type() !== 'error';
}
/**
* Filter out any dismissed notifications.
*
* @param Yoast_Notification $notification Notification to test.
*
* @return bool
*/
private static function filter_dismissed_alerts( Yoast_Notification $notification ) {
return Yoast_Notification_Center::is_notification_dismissed( $notification );
}
}
|