You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
308 lines
6.8 KiB
308 lines
6.8 KiB
<?php |
|
/** |
|
* WPSEO plugin file. |
|
* |
|
* @package WPSEO\Admin\Notifications |
|
*/ |
|
|
|
/** |
|
* Class Yoast_Alerts. |
|
*/ |
|
class Yoast_Alerts { |
|
|
|
/** |
|
* Holds the admin page's ID. |
|
* |
|
* @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 ); |
|
// phpcs:disable WordPress.Security.EscapeOutput -- Reason: WPSEO_Utils::format_json_encode is safe. |
|
echo WPSEO_Utils::format_json_encode( |
|
array( |
|
'html' => $html, |
|
'total' => self::get_active_alert_count(), |
|
) |
|
); |
|
// phpcs:enable -- Reason: WPSEO_Utils::format_json_encode is safe. |
|
} |
|
|
|
/** |
|
* 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(); |
|
|
|
/** |
|
* Stops PHPStorm from nagging about this variable being unused. The variable is used in the view. |
|
* |
|
* @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() { |
|
|
|
/** |
|
* Stops PHPStorm from nagging about this variable being unused. The variable is used in the view. |
|
* |
|
* @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 ); |
|
} |
|
}
|
|
|