Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Yoast\WHIPv2;

[2] Fix | Delete

[3] Fix | Delete

use Yoast\WHIPv2\Exceptions\InvalidType;

[4] Fix | Delete

use Yoast\WHIPv2\Interfaces\Message;

[5] Fix | Delete

use Yoast\WHIPv2\Interfaces\Requirement;

[6] Fix | Delete

use Yoast\WHIPv2\Messages\InvalidVersionRequirementMessage;

[7] Fix | Delete

use Yoast\WHIPv2\Messages\UpgradePhpMessage;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Main controller class to require a certain version of software.

[11] Fix | Delete

[12] Fix | Delete

class RequirementsChecker {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Requirements the environment should comply with.

[16] Fix | Delete

[17] Fix | Delete

* @var array<Requirement>

[18] Fix | Delete

[19] Fix | Delete

private $requirements;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* The configuration to check.

[23] Fix | Delete

[24] Fix | Delete

* @var Configuration

[25] Fix | Delete

[26] Fix | Delete

private $configuration;

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Message Manager.

[30] Fix | Delete

[31] Fix | Delete

* @var MessagesManager

[32] Fix | Delete

[33] Fix | Delete

private $messageManager;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* The text domain to use for translations.

[37] Fix | Delete

[38] Fix | Delete

* @var string

[39] Fix | Delete

[40] Fix | Delete

private $textdomain;

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* RequirementsChecker constructor.

[44] Fix | Delete

[45] Fix | Delete

* @param array<string, string> $configuration The configuration to check.

[46] Fix | Delete

* @param string $textdomain The text domain to use for translations.

[47] Fix | Delete

[48] Fix | Delete

* @throws InvalidType When the $configuration parameter is not of the expected type.

[49] Fix | Delete

[50] Fix | Delete

public function __construct( $configuration = array(), $textdomain = 'default' ) {

[51] Fix | Delete

$this->requirements = array();

[52] Fix | Delete

$this->configuration = new Configuration( $configuration );

[53] Fix | Delete

$this->messageManager = new MessagesManager();

[54] Fix | Delete

$this->textdomain = $textdomain;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Adds a requirement to the list of requirements if it doesn't already exist.

[59] Fix | Delete

[60] Fix | Delete

* @param Requirement $requirement The requirement to add.

[61] Fix | Delete

[62] Fix | Delete

* @return void

[63] Fix | Delete

[64] Fix | Delete

public function addRequirement( Requirement $requirement ) {

[65] Fix | Delete

// Only allow unique entries to ensure we're not checking specific combinations multiple times.

[66] Fix | Delete

if ( $this->requirementExistsForComponent( $requirement->component() ) ) {

[67] Fix | Delete

return;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

$this->requirements[] = $requirement;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Determines whether or not there are requirements available.

[75] Fix | Delete

[76] Fix | Delete

* @return bool Whether or not there are requirements.

[77] Fix | Delete

[78] Fix | Delete

public function hasRequirements() {

[79] Fix | Delete

return $this->totalRequirements() > 0;

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Gets the total amount of requirements.

[84] Fix | Delete

[85] Fix | Delete

* @return int The total amount of requirements.

[86] Fix | Delete

[87] Fix | Delete

public function totalRequirements() {

[88] Fix | Delete

return \count( $this->requirements );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Determines whether or not a requirement exists for a particular component.

[93] Fix | Delete

[94] Fix | Delete

* @param string $component The component to check for.

[95] Fix | Delete

[96] Fix | Delete

* @return bool Whether or not the component has a requirement defined.

[97] Fix | Delete

[98] Fix | Delete

public function requirementExistsForComponent( $component ) {

[99] Fix | Delete

foreach ( $this->requirements as $requirement ) {

[100] Fix | Delete

if ( $requirement->component() === $component ) {

[101] Fix | Delete

return true;

[102] Fix | Delete

}

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

return false;

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Determines whether a requirement has been fulfilled.

[110] Fix | Delete

[111] Fix | Delete

* @param Requirement $requirement The requirement to check.

[112] Fix | Delete

[113] Fix | Delete

* @return bool Whether or not the requirement is fulfilled.

[114] Fix | Delete

[115] Fix | Delete

private function requirementIsFulfilled( Requirement $requirement ) {

[116] Fix | Delete

$availableVersion = $this->configuration->configuredVersion( $requirement );

[117] Fix | Delete

$requiredVersion = $requirement->version();

[118] Fix | Delete

[119] Fix | Delete

if ( \in_array( $requirement->operator(), array( '=', '==', '===' ), true ) ) {

[120] Fix | Delete

return \version_compare( $availableVersion, $requiredVersion, '>=' );

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

return \version_compare( $availableVersion, $requiredVersion, $requirement->operator() );

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

/**

[127] Fix | Delete

* Checks if all requirements are fulfilled and adds a message to the message manager if necessary.

[128] Fix | Delete

[129] Fix | Delete

* @return void

[130] Fix | Delete

[131] Fix | Delete

public function check() {

[132] Fix | Delete

foreach ( $this->requirements as $requirement ) {

[133] Fix | Delete

// Match against config.

[134] Fix | Delete

$requirementFulfilled = $this->requirementIsFulfilled( $requirement );

[135] Fix | Delete

[136] Fix | Delete

if ( $requirementFulfilled ) {

[137] Fix | Delete

continue;

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

$this->addMissingRequirementMessage( $requirement );

[141] Fix | Delete

}

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Adds a message to the message manager for requirements that cannot be fulfilled.

[146] Fix | Delete

[147] Fix | Delete

* @param Requirement $requirement The requirement that cannot be fulfilled.

[148] Fix | Delete

[149] Fix | Delete

* @return void

[150] Fix | Delete

[151] Fix | Delete

private function addMissingRequirementMessage( Requirement $requirement ) {

[152] Fix | Delete

switch ( $requirement->component() ) {

[153] Fix | Delete

case 'php':

[154] Fix | Delete

$this->messageManager->addMessage( new UpgradePhpMessage( $this->textdomain ) );

[155] Fix | Delete

break;

[156] Fix | Delete

default:

[157] Fix | Delete

$this->messageManager->addMessage( new InvalidVersionRequirementMessage( $requirement, $this->configuration->configuredVersion( $requirement ) ) );

[158] Fix | Delete

break;

[159] Fix | Delete

}

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Determines whether or not there are messages available.

[164] Fix | Delete

[165] Fix | Delete

* @return bool Whether or not there are messages to display.

[166] Fix | Delete

[167] Fix | Delete

public function hasMessages() {

[168] Fix | Delete

return $this->messageManager->hasMessages();

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

/**

[172] Fix | Delete

* Gets the most recent message from the message manager.

[173] Fix | Delete

[174] Fix | Delete

* @return Message The latest message.

[175] Fix | Delete

[176] Fix | Delete

public function getMostRecentMessage() {

[177] Fix | Delete

return $this->messageManager->getLatestMessage();

[178] Fix | Delete

}

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete