Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WHIPv2\Presenters;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WHIPv2\Interfaces\Message;

[4] Fix | Delete

use Yoast\WHIPv2\Interfaces\MessagePresenter;

[5] Fix | Delete

use Yoast\WHIPv2\MessageDismisser;

[6] Fix | Delete

use Yoast\WHIPv2\WPMessageDismissListener;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* A message presenter to show a WordPress notice.

[10] Fix | Delete

[11] Fix | Delete

* @phpcs:disable Yoast.NamingConventions.ObjectNameDepth.MaxExceeded -- Sniff does not count acronyms correctly.

[12] Fix | Delete

[13] Fix | Delete

class WPMessagePresenter implements MessagePresenter {

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* The string to show to dismiss the message.

[17] Fix | Delete

[18] Fix | Delete

* @var string

[19] Fix | Delete

[20] Fix | Delete

private $dismissMessage;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* The message to be displayed.

[24] Fix | Delete

[25] Fix | Delete

* @var Message

[26] Fix | Delete

[27] Fix | Delete

private $message;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* Dismisser object.

[31] Fix | Delete

[32] Fix | Delete

* @var MessageDismisser

[33] Fix | Delete

[34] Fix | Delete

private $dismisser;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* WPMessagePresenter constructor.

[38] Fix | Delete

[39] Fix | Delete

* @param Message $message The message to use in the presenter.

[40] Fix | Delete

* @param MessageDismisser $dismisser Dismisser object.

[41] Fix | Delete

* @param string $dismissMessage The copy to show to dismiss the message.

[42] Fix | Delete

[43] Fix | Delete

public function __construct( Message $message, MessageDismisser $dismisser, $dismissMessage ) {

[44] Fix | Delete

$this->message = $message;

[45] Fix | Delete

$this->dismisser = $dismisser;

[46] Fix | Delete

$this->dismissMessage = $dismissMessage;

[47] Fix | Delete

}

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Registers hooks to WordPress.

[51] Fix | Delete

[52] Fix | Delete

* This is a separate function so you can control when the hooks are registered.

[53] Fix | Delete

[54] Fix | Delete

* @return void

[55] Fix | Delete

[56] Fix | Delete

public function registerHooks() {

[57] Fix | Delete

\add_action( 'admin_notices', array( $this, 'renderMessage' ) );

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Renders the messages present in the global to notices.

[62] Fix | Delete

[63] Fix | Delete

* @return void

[64] Fix | Delete

[65] Fix | Delete

public function renderMessage() {

[66] Fix | Delete

$dismissListener = new WPMessageDismissListener( $this->dismisser );

[67] Fix | Delete

$dismissListener->listen();

[68] Fix | Delete

[69] Fix | Delete

if ( $this->dismisser->isDismissed() ) {

[70] Fix | Delete

return;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

$dismissButton = \sprintf(

[74] Fix | Delete

'<a href="%2$s">%1$s</a>',

[75] Fix | Delete

\esc_html( $this->dismissMessage ),

[76] Fix | Delete

\esc_url( $dismissListener->getDismissURL() )

[77] Fix | Delete

);

[78] Fix | Delete

[79] Fix | Delete

// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- output correctly escaped directly above and in the `kses()` method.

[80] Fix | Delete

\printf(

[81] Fix | Delete

'<div class="error"><p>%1$s</p><p>%2$s</p></div>',

[82] Fix | Delete

$this->kses( $this->message->body() ),

[83] Fix | Delete

$dismissButton

[84] Fix | Delete

);

[85] Fix | Delete

// phpcs:enable

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Removes content from the message that we don't want to show.

[90] Fix | Delete

[91] Fix | Delete

* @param string $message The message to clean.

[92] Fix | Delete

[93] Fix | Delete

* @return string The cleaned message.

[94] Fix | Delete

[95] Fix | Delete

public function kses( $message ) {

[96] Fix | Delete

return \wp_kses(

[97] Fix | Delete

$message,

[98] Fix | Delete

array(

[99] Fix | Delete

'a' => array(

[100] Fix | Delete

'href' => true,

[101] Fix | Delete

'target' => true,

[102] Fix | Delete

[103] Fix | Delete

'strong' => true,

[104] Fix | Delete

'p' => true,

[105] Fix | Delete

'ul' => true,

[106] Fix | Delete

'li' => true,

[107] Fix | Delete

)

[108] Fix | Delete

);

[109] Fix | Delete

}

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete