Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WHIPv2;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WHIPv2\Interfaces\Message;

[4] Fix | Delete

use Yoast\WHIPv2\Messages\NullMessage;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Manages messages using a global to prevent duplicate messages.

[8] Fix | Delete

[9] Fix | Delete

class MessagesManager {

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* MessagesManager constructor.

[13] Fix | Delete

[14] Fix | Delete

public function __construct() {

[15] Fix | Delete

if ( ! \array_key_exists( 'whip_messages', $GLOBALS ) ) {

[16] Fix | Delete

$GLOBALS['whip_messages'] = array();

[17] Fix | Delete

}

[18] Fix | Delete

}

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Adds a message to the Messages Manager.

[22] Fix | Delete

[23] Fix | Delete

* @param Message $message The message to add.

[24] Fix | Delete

[25] Fix | Delete

* @return void

[26] Fix | Delete

[27] Fix | Delete

public function addMessage( Message $message ) {

[28] Fix | Delete

$whipVersion = require __DIR__ . '/Configs/version.php';

[29] Fix | Delete

[30] Fix | Delete

$GLOBALS['whip_messages'][ $whipVersion ] = $message;

[31] Fix | Delete

}

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Determines whether or not there are messages available.

[35] Fix | Delete

[36] Fix | Delete

* @return bool Whether or not there are messages available.

[37] Fix | Delete

[38] Fix | Delete

public function hasMessages() {

[39] Fix | Delete

return isset( $GLOBALS['whip_messages'] ) && \count( $GLOBALS['whip_messages'] ) > 0;

[40] Fix | Delete

}

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Lists the messages that are currently available.

[44] Fix | Delete

[45] Fix | Delete

* @return array<Message> The messages that are currently set.

[46] Fix | Delete

[47] Fix | Delete

public function listMessages() {

[48] Fix | Delete

return $GLOBALS['whip_messages'];

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Deletes all messages.

[53] Fix | Delete

[54] Fix | Delete

* @return void

[55] Fix | Delete

[56] Fix | Delete

public function deleteMessages() {

[57] Fix | Delete

unset( $GLOBALS['whip_messages'] );

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Gets the latest message.

[62] Fix | Delete

[63] Fix | Delete

* @return Message The message. Returns a NullMessage if none is found.

[64] Fix | Delete

[65] Fix | Delete

public function getLatestMessage() {

[66] Fix | Delete

if ( ! $this->hasMessages() ) {

[67] Fix | Delete

return new NullMessage();

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

$messages = $this->sortByVersion( $this->listMessages() );

[71] Fix | Delete

[72] Fix | Delete

$this->deleteMessages();

[73] Fix | Delete

[74] Fix | Delete

return \array_pop( $messages );

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Sorts the list of messages based on the version number.

[79] Fix | Delete

[80] Fix | Delete

* @param array<Message> $messages The list of messages to sort.

[81] Fix | Delete

[82] Fix | Delete

* @return array<Message> The sorted list of messages.

[83] Fix | Delete

[84] Fix | Delete

private function sortByVersion( array $messages ) {

[85] Fix | Delete

\uksort( $messages, 'version_compare' );

[86] Fix | Delete

[87] Fix | Delete

return $messages;

[88] Fix | Delete

}

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete