Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace NinjaForms\Includes\Admin;

[2] Fix | Delete

[3] Fix | Delete

if (!defined('ABSPATH')) exit;

[4] Fix | Delete

[5] Fix | Delete

class VersionCompatibilityCheck

[6] Fix | Delete

{

[7] Fix | Delete

/**

[8] Fix | Delete

* Array construct requirements for compatibility check

[9] Fix | Delete

[10] Fix | Delete

* @var array

[11] Fix | Delete

[12] Fix | Delete

const COMPATIBILITY_CHECK_REQUIREMENTS = [

[13] Fix | Delete

'className' => 'string',

[14] Fix | Delete

'minVersion' => 'string',

[15] Fix | Delete

'title' => 'string',

[16] Fix | Delete

'message' => 'string',

[17] Fix | Delete

'int' => 'integer',

[18] Fix | Delete

'link'=>'string'

[19] Fix | Delete

];

[20] Fix | Delete

[21] Fix | Delete

/** @var array */

[22] Fix | Delete

protected $compatiblityCheckCollection;

[23] Fix | Delete

[24] Fix | Delete

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Notices to add

[28] Fix | Delete

[29] Fix | Delete

* Uses NF notices array structure

[30] Fix | Delete

[31] Fix | Delete

* @var array

[32] Fix | Delete

[33] Fix | Delete

protected $compatibilityNotices = [];

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Activate checks and notices for plugin's envirnoment compatibility

[37] Fix | Delete

[38] Fix | Delete

* @return void

[39] Fix | Delete

[40] Fix | Delete

public function activate(): void

[41] Fix | Delete

{

[42] Fix | Delete

add_action('ninja_forms_loaded', array($this, 'ensureVersionCompatibility'), 0);

[43] Fix | Delete

}

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* If Authorize.net and NF core versions re incompatible, display user notice

[47] Fix | Delete

[48] Fix | Delete

* NOTE: this does not stop functioning of plugin, but warns user that

[49] Fix | Delete

* functionality may be affected

[50] Fix | Delete

[51] Fix | Delete

* @return void

[52] Fix | Delete

[53] Fix | Delete

public function ensureVersionCompatibility(): void

[54] Fix | Delete

{

[55] Fix | Delete

$this->loadCompatibilityConfiguration();

[56] Fix | Delete

[57] Fix | Delete

$this->constructCompatiblityNotices();

[58] Fix | Delete

[59] Fix | Delete

add_filter('nf_admin_notices', [$this, 'addIncompatibleVersionsNotice']);

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Load compatibility check configuration

[64] Fix | Delete

[65] Fix | Delete

* @return void

[66] Fix | Delete

[67] Fix | Delete

protected function loadCompatibilityConfiguration(): void

[68] Fix | Delete

{

[69] Fix | Delete

$this->compatiblityCheckCollection = \Ninja_Forms()->config('VersionCompatibilityCheck');

[70] Fix | Delete

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Iterate collection, check compatibility, append notices

[75] Fix | Delete

[76] Fix | Delete

* @return void

[77] Fix | Delete

[78] Fix | Delete

protected function constructCompatiblityNotices(): void

[79] Fix | Delete

{

[80] Fix | Delete

foreach ($this->compatiblityCheckCollection as $compatiblityCheck) {

[81] Fix | Delete

if (!$this->isValidConstruct($compatiblityCheck)) {

[82] Fix | Delete

[83] Fix | Delete

continue;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

$versionCompatiblity = $this->checkVersionCompatibility(

[87] Fix | Delete

$compatiblityCheck['className'],

[88] Fix | Delete

$compatiblityCheck['minVersion']

[89] Fix | Delete

);

[90] Fix | Delete

[91] Fix | Delete

if ($versionCompatiblity) {

[92] Fix | Delete

[93] Fix | Delete

continue;

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

$this->appendNotice(

[97] Fix | Delete

$compatiblityCheck['className'],

[98] Fix | Delete

$compatiblityCheck['title'],

[99] Fix | Delete

$compatiblityCheck['message'],

[100] Fix | Delete

$compatiblityCheck['int'],

[101] Fix | Delete

$compatiblityCheck['link']

[102] Fix | Delete

);

[103] Fix | Delete

}

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Ensure compatibility check construct is valid

[108] Fix | Delete

[109] Fix | Delete

* @param array $compatiblityCheck

[110] Fix | Delete

* @return boolean false on invalid construct

[111] Fix | Delete

[112] Fix | Delete

protected function isValidConstruct(array $compatiblityCheck): bool

[113] Fix | Delete

{

[114] Fix | Delete

$return = true;

[115] Fix | Delete

[116] Fix | Delete

foreach (self::COMPATIBILITY_CHECK_REQUIREMENTS as $requiredKey => $requiredType) {

[117] Fix | Delete

[118] Fix | Delete

if (

[119] Fix | Delete

!isset($compatiblityCheck[$requiredKey])

[120] Fix | Delete

|| $requiredType !== \gettype($compatiblityCheck[$requiredKey])

[121] Fix | Delete

) {

[122] Fix | Delete

$return = false;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

}

[126] Fix | Delete

return $return;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Check that required versions are installed for proper functionality

[131] Fix | Delete

[132] Fix | Delete

* Default is to pass checks; only fail if known version incompatibility

[133] Fix | Delete

[134] Fix | Delete

* @return boolean Compatible TRUE, incompatible FALSE

[135] Fix | Delete

[136] Fix | Delete

protected function checkVersionCompatibility(string $className, string $requiredVersion): bool

[137] Fix | Delete

{

[138] Fix | Delete

$return = true;

[139] Fix | Delete

[140] Fix | Delete

$classVersion = $this->getClassVersion($className);

[141] Fix | Delete

[142] Fix | Delete

if ('' != $classVersion && \version_compare($classVersion, $requiredVersion, '<')) {

[143] Fix | Delete

[144] Fix | Delete

$return = false;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

return $return;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Append a notice to the internal collection of notices

[152] Fix | Delete

[153] Fix | Delete

* @param string $className

[154] Fix | Delete

* @param string $title

[155] Fix | Delete

* @param string $message

[156] Fix | Delete

* @param integer $int

[157] Fix | Delete

* @return void

[158] Fix | Delete

[159] Fix | Delete

protected function appendNotice(string $className, string $title, string $message, int $int, string $link): void

[160] Fix | Delete

{

[161] Fix | Delete

$this->compatibilityNotices[$className . '_compatibility_notice'] = [

[162] Fix | Delete

'title' => $title,

[163] Fix | Delete

'msg' => $message,

[164] Fix | Delete

'int' => $int,

[165] Fix | Delete

'link'=>$link

[166] Fix | Delete

];

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Determine the version of the request class name

[171] Fix | Delete

[172] Fix | Delete

* @param string $className Name of class to check

[173] Fix | Delete

* @return string Version of the class, empty string if class doesn't exist or

[174] Fix | Delete

* does not have VERSION constant defined

[175] Fix | Delete

[176] Fix | Delete

protected function getClassVersion(string $className): string

[177] Fix | Delete

{

[178] Fix | Delete

$return = '';

[179] Fix | Delete

[180] Fix | Delete

if (\class_exists($className) ){

[181] Fix | Delete

[182] Fix | Delete

$reflectionClass = new \ReflectionClass($className);

[183] Fix | Delete

[184] Fix | Delete

$return = $reflectionClass->getConstant('VERSION')?$reflectionClass->getConstant('VERSION'):'';

[185] Fix | Delete

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

return $return;

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Add NF admin notice for incompatible versions

[193] Fix | Delete

[194] Fix | Delete

* @param array $notices

[195] Fix | Delete

* @return array

[196] Fix | Delete

[197] Fix | Delete

public function addIncompatibleVersionsNotice($notices): array

[198] Fix | Delete

{

[199] Fix | Delete

foreach($this->compatibilityNotices as $noticeKey=>$newNotice){

[200] Fix | Delete

[201] Fix | Delete

$notices[$noticeKey]=[

[202] Fix | Delete

'title'=>$newNotice['title'],

[203] Fix | Delete

'msg'=>$newNotice['msg'],

[204] Fix | Delete

'int'=>$newNotice['int'],

[205] Fix | Delete

'link'=>$newNotice['link']

[206] Fix | Delete

];

[207] Fix | Delete

}

[208] Fix | Delete

[209] Fix | Delete

return $notices;

[210] Fix | Delete

}

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete