Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WP\SEO\Actions;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WP\SEO\Helpers\User_Helper;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Class Alert_Dismissal_Action.

[7] Fix | Delete

[8] Fix | Delete

class Alert_Dismissal_Action {

[9] Fix | Delete

[10] Fix | Delete

public const USER_META_KEY = '_yoast_alerts_dismissed';

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Holds the user helper instance.

[14] Fix | Delete

[15] Fix | Delete

* @var User_Helper

[16] Fix | Delete

[17] Fix | Delete

protected $user;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Constructs Alert_Dismissal_Action.

[21] Fix | Delete

[22] Fix | Delete

* @param User_Helper $user User helper.

[23] Fix | Delete

[24] Fix | Delete

public function __construct( User_Helper $user ) {

[25] Fix | Delete

$this->user = $user;

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Dismisses an alert.

[30] Fix | Delete

[31] Fix | Delete

* @param string $alert_identifier Alert identifier.

[32] Fix | Delete

[33] Fix | Delete

* @return bool Whether the dismiss was successful or not.

[34] Fix | Delete

[35] Fix | Delete

public function dismiss( $alert_identifier ) {

[36] Fix | Delete

$user_id = $this->user->get_current_user_id();

[37] Fix | Delete

if ( $user_id === 0 ) {

[38] Fix | Delete

return false;

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

if ( $this->is_allowed( $alert_identifier ) === false ) {

[42] Fix | Delete

return false;

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

$dismissed_alerts = $this->get_dismissed_alerts( $user_id );

[46] Fix | Delete

if ( $dismissed_alerts === false ) {

[47] Fix | Delete

return false;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

if ( \array_key_exists( $alert_identifier, $dismissed_alerts ) === true ) {

[51] Fix | Delete

// The alert is already dismissed.

[52] Fix | Delete

return true;

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

// Add this alert to the dismissed alerts.

[56] Fix | Delete

$dismissed_alerts[ $alert_identifier ] = true;

[57] Fix | Delete

[58] Fix | Delete

// Save.

[59] Fix | Delete

return $this->user->update_meta( $user_id, static::USER_META_KEY, $dismissed_alerts ) !== false;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Resets an alert.

[64] Fix | Delete

[65] Fix | Delete

* @param string $alert_identifier Alert identifier.

[66] Fix | Delete

[67] Fix | Delete

* @return bool Whether the reset was successful or not.

[68] Fix | Delete

[69] Fix | Delete

public function reset( $alert_identifier ) {

[70] Fix | Delete

$user_id = $this->user->get_current_user_id();

[71] Fix | Delete

if ( $user_id === 0 ) {

[72] Fix | Delete

return false;

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

if ( $this->is_allowed( $alert_identifier ) === false ) {

[76] Fix | Delete

return false;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$dismissed_alerts = $this->get_dismissed_alerts( $user_id );

[80] Fix | Delete

if ( $dismissed_alerts === false ) {

[81] Fix | Delete

return false;

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

$amount_of_dismissed_alerts = \count( $dismissed_alerts );

[85] Fix | Delete

if ( $amount_of_dismissed_alerts === 0 ) {

[86] Fix | Delete

// No alerts: nothing to reset.

[87] Fix | Delete

return true;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

if ( \array_key_exists( $alert_identifier, $dismissed_alerts ) === false ) {

[91] Fix | Delete

// Alert not found: nothing to reset.

[92] Fix | Delete

return true;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

if ( $amount_of_dismissed_alerts === 1 ) {

[96] Fix | Delete

// The 1 remaining dismissed alert is the alert to reset: delete the alerts user meta row.

[97] Fix | Delete

return $this->user->delete_meta( $user_id, static::USER_META_KEY, $dismissed_alerts );

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

// Remove this alert from the dismissed alerts.

[101] Fix | Delete

unset( $dismissed_alerts[ $alert_identifier ] );

[102] Fix | Delete

[103] Fix | Delete

// Save.

[104] Fix | Delete

return $this->user->update_meta( $user_id, static::USER_META_KEY, $dismissed_alerts ) !== false;

[105] Fix | Delete

}

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* Returns if an alert is dismissed or not.

[109] Fix | Delete

[110] Fix | Delete

* @param string $alert_identifier Alert identifier.

[111] Fix | Delete

[112] Fix | Delete

* @return bool Whether the alert has been dismissed.

[113] Fix | Delete

[114] Fix | Delete

public function is_dismissed( $alert_identifier ) {

[115] Fix | Delete

$user_id = $this->user->get_current_user_id();

[116] Fix | Delete

if ( $user_id === 0 ) {

[117] Fix | Delete

return false;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

if ( $this->is_allowed( $alert_identifier ) === false ) {

[121] Fix | Delete

return false;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$dismissed_alerts = $this->get_dismissed_alerts( $user_id );

[125] Fix | Delete

if ( $dismissed_alerts === false ) {

[126] Fix | Delete

return false;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

return \array_key_exists( $alert_identifier, $dismissed_alerts );

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Returns an object with all alerts dismissed by current user.

[134] Fix | Delete

[135] Fix | Delete

* @return array|false An array with the keys of all Alerts that have been dismissed

[136] Fix | Delete

* by the current user or `false`.

[137] Fix | Delete

[138] Fix | Delete

public function all_dismissed() {

[139] Fix | Delete

$user_id = $this->user->get_current_user_id();

[140] Fix | Delete

if ( $user_id === 0 ) {

[141] Fix | Delete

return false;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

$dismissed_alerts = $this->get_dismissed_alerts( $user_id );

[145] Fix | Delete

if ( $dismissed_alerts === false ) {

[146] Fix | Delete

return false;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

return $dismissed_alerts;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Returns if an alert is allowed or not.

[154] Fix | Delete

[155] Fix | Delete

* @param string $alert_identifier Alert identifier.

[156] Fix | Delete

[157] Fix | Delete

* @return bool Whether the alert is allowed.

[158] Fix | Delete

[159] Fix | Delete

public function is_allowed( $alert_identifier ) {

[160] Fix | Delete

return \in_array( $alert_identifier, $this->get_allowed_dismissable_alerts(), true );

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Retrieves the dismissed alerts.

[165] Fix | Delete

[166] Fix | Delete

* @param int $user_id User ID.

[167] Fix | Delete

[168] Fix | Delete

* @return string[]|false The dismissed alerts. False for an invalid $user_id.

[169] Fix | Delete

[170] Fix | Delete

protected function get_dismissed_alerts( $user_id ) {

[171] Fix | Delete

$dismissed_alerts = $this->user->get_meta( $user_id, static::USER_META_KEY, true );

[172] Fix | Delete

if ( $dismissed_alerts === false ) {

[173] Fix | Delete

// Invalid user ID.

[174] Fix | Delete

return false;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

if ( $dismissed_alerts === '' ) {

[178] Fix | Delete

[179] Fix | Delete

* When no database row exists yet, an empty string is returned because of the `single` parameter.

[180] Fix | Delete

* We do want a single result returned, but the default should be an empty array instead.

[181] Fix | Delete

[182] Fix | Delete

return [];

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

return $dismissed_alerts;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Retrieves the allowed dismissable alerts.

[190] Fix | Delete

[191] Fix | Delete

* @return string[] The allowed dismissable alerts.

[192] Fix | Delete

[193] Fix | Delete

protected function get_allowed_dismissable_alerts() {

[194] Fix | Delete

/**

[195] Fix | Delete

* Filter: 'wpseo_allowed_dismissable_alerts' - List of allowed dismissable alerts.

[196] Fix | Delete

[197] Fix | Delete

* @param string[] $allowed_dismissable_alerts Allowed dismissable alerts list.

[198] Fix | Delete

[199] Fix | Delete

$allowed_dismissable_alerts = \apply_filters( 'wpseo_allowed_dismissable_alerts', [] );

[200] Fix | Delete

[201] Fix | Delete

if ( \is_array( $allowed_dismissable_alerts ) === false ) {

[202] Fix | Delete

return [];

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

// Only allow strings.

[206] Fix | Delete

$allowed_dismissable_alerts = \array_filter( $allowed_dismissable_alerts, 'is_string' );

[207] Fix | Delete

[208] Fix | Delete

// Filter unique and reorder indices.

[209] Fix | Delete

$allowed_dismissable_alerts = \array_values( \array_unique( $allowed_dismissable_alerts ) );

[210] Fix | Delete

[211] Fix | Delete

return $allowed_dismissable_alerts;

[212] Fix | Delete

}

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete