Eliminate underscore prefix in method names... no longer needed as an indicator that a method should be internal only

Author: MarkBaker

docs/topics/recipes.md

@@ -187,7 +187,7 @@ internal English coding.
 
 ```php
 $formula = $spreadsheet->getActiveSheet()->getCell('B8')->getValue();
-$translatedFormula = \PhpOffice\PhpSpreadsheet\Calculation\Calculation::getInstance()->_translateFormulaToLocale($formula);
+$translatedFormula = \PhpOffice\PhpSpreadsheet\Calculation\Calculation::getInstance()->translateFormulaToLocale($formula);
 ```
 
 You can also create a formula using the function names and argument

phpstan-baseline.neon

@@ -55,26 +55,6 @@ parameters:
 			count: 1
 			path: src/PhpSpreadsheet/Calculation/Calculation.php
 
-		-
-			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:_translateFormulaToEnglish\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Calculation/Calculation.php
-
-		-
-			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:_translateFormulaToEnglish\\(\\) has parameter \\$formula with no type specified\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Calculation/Calculation.php
-
-		-
-			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:_translateFormulaToLocale\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Calculation/Calculation.php
-
-		-
-			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:_translateFormulaToLocale\\(\\) has parameter \\$formula with no type specified\\.$#"
-			count: 1
-			path: src/PhpSpreadsheet/Calculation/Calculation.php
-
 		-
 			message: "#^Method PhpOffice\\\\PhpSpreadsheet\\\\Calculation\\\\Calculation\\:\\:dataTestReference\\(\\) has no return type specified\\.$#"
 			count: 1

src/PhpSpreadsheet/Calculation/Calculation.php

@@ -294,7 +294,7 @@ class Calculation
         ],
         'ARABIC' => [
             'category' => Category::CATEGORY_MATH_AND_TRIG,
-            'functionCall' => [MathTrig\Arabic::class, 'evaluate'],
+            'functionCall' => [MathTrig\Arabic::class, 'toRoman'],
             'argumentCount' => '1',
         ],
         'AREAS' => [
@@ -2141,7 +2141,7 @@ class Calculation
         ],
         'ROMAN' => [
             'category' => Category::CATEGORY_MATH_AND_TRIG,
-            'functionCall' => [MathTrig\Roman::class, 'evaluate'],
+            'functionCall' => [MathTrig\Roman::class, 'toArabic'],
             'argumentCount' => '1,2',
         ],
         'ROUND' => [
@@ -3176,7 +3176,7 @@ private static function translateFormula(array $from, array $to, string $formula
 
     private static $functionReplaceToLocale;
 
-    public function _translateFormulaToLocale($formula)
+    public function translateFormulaToLocale(string $formula): string
     {
         // Build list of function names and constants for translation
         if (self::$functionReplaceFromExcel === null) {
@@ -3212,7 +3212,7 @@ public function _translateFormulaToLocale($formula)
 
     private static $functionReplaceToExcel;
 
-    public function _translateFormulaToEnglish($formula)
+    public function translateFormulaToEnglish(string $formula): string
     {
         if (self::$functionReplaceFromLocale === null) {
             self::$functionReplaceFromLocale = [];
@@ -3350,7 +3350,7 @@ public function calculateCellValue(?Cell $cell = null, $resetLog = true)
         ];
 
         try {
-            $result = self::unwrapResult($this->_calculateFormulaValue($cell->getValue(), $cell->getCoordinate(), $cell));
+            $result = self::unwrapResult($this->calculateFormulaValue($cell->getValue(), $cell->getCoordinate(), $cell));
             $cellAddress = array_pop($this->cellStack);
             $this->spreadsheet->getSheetByName($cellAddress['sheet'])->getCell($cellAddress['cell']);
         } catch (\Exception $e) {
@@ -3447,7 +3447,7 @@ public function calculateFormula($formula, $cellID = null, ?Cell $cell = null)
 
         //    Execute the calculation
         try {
-            $result = self::unwrapResult($this->_calculateFormulaValue($formula, $cellID, $cell));
+            $result = self::unwrapResult($this->calculateFormulaValue($formula, $cellID, $cell));
         } catch (\Exception $e) {
             throw new Exception($e->getMessage());
         }
@@ -3500,7 +3500,7 @@ public function saveValueToCache($cellReference, $cellValue): void
      *
      * @return mixed
      */
-    public function _calculateFormulaValue($formula, $cellID = null, ?Cell $cell = null)
+    public function calculateFormulaValue($formula, $cellID = null, ?Cell $cell = null)
     {
         $cellValue = null;
 
@@ -5431,7 +5431,7 @@ private function evaluateDefinedName(Cell $cell, DefinedName $namedRange, Worksh
         $recursiveCalculator = new self($this->spreadsheet);
         $recursiveCalculator->getDebugLog()->setWriteDebugLog($this->getDebugLog()->getWriteDebugLog());
         $recursiveCalculator->getDebugLog()->setEchoDebugLog($this->getDebugLog()->getEchoDebugLog());
-        $result = $recursiveCalculator->_calculateFormulaValue($definedNameValue, $recursiveCalculationCellAddress, $recursiveCalculationCell);
+        $result = $recursiveCalculator->calculateFormulaValue($definedNameValue, $recursiveCalculationCellAddress, $recursiveCalculationCell);
 
         if ($this->getDebugLog()->getWriteDebugLog()) {
             $this->debugLog->mergeDebugLog(array_slice($recursiveCalculator->getDebugLog()->getLog(), 3));

src/PhpSpreadsheet/Calculation/Database/DatabaseAbstract.php

@@ -142,7 +142,7 @@ private static function executeQuery(array $database, string $query, array $crit
             }
 
             //    evaluate the criteria against the row data
-            $result = Calculation::getInstance()->_calculateFormulaValue('=' . $conditions);
+            $result = Calculation::getInstance()->calculateFormulaValue('=' . $conditions);
 
             //    If the row failed to meet the criteria, remove it from the database
             if ($result !== true) {

src/PhpSpreadsheet/Calculation/MathTrig/Arabic.php

@@ -79,7 +79,7 @@ private static function strSplit(string $roman): array
      *         If an array of numbers is passed as the argument, then the returned result will also be an array
      *            with the same dimensions
      */
-    public static function evaluate($roman)
+    public static function toRoman($roman)
     {
         if (is_array($roman)) {
             return self::evaluateSingleArgumentArray([self::class, __FUNCTION__], $roman);

src/PhpSpreadsheet/Calculation/MathTrig/Roman.php

@@ -825,7 +825,7 @@ public static function calculateRoman(int $aValue, int $style): string
      *         If an array of numbers is passed as an argument, then the returned result will also be an array
      *            with the same dimensions
      */
-    public static function evaluate($aValue, $style = 0)
+    public static function toArabic($aValue, $style = 0)
     {
         if (is_array($aValue) || is_array($style)) {
             return self::evaluateArrayArguments([self::class, __FUNCTION__], $aValue, $style);

src/PhpSpreadsheet/Chart/DataSeriesValues.php

@@ -357,7 +357,7 @@ public function refresh(Worksheet $worksheet, $flatten = true): void
         if ($this->dataSource !== null) {
             $calcEngine = Calculation::getInstance($worksheet->getParent());
             $newDataValues = Calculation::unwrapResult(
-                $calcEngine->_calculateFormulaValue(
+                $calcEngine->calculateFormulaValue(
                     '=' . $this->dataSource,
                     null,
                     $worksheet->getCell('A1')

src/PhpSpreadsheet/Shared/StringHelper.php

@@ -565,7 +565,7 @@ public static function convertToNumberIfFraction(&$operand)
         if (preg_match('/^' . self::STRING_REGEXP_FRACTION . '$/i', $operand, $match)) {
             $sign = ($match[1] == '-') ? '-' : '+';
             $fractionFormula = '=' . $sign . $match[2] . $sign . $match[3];
-            $operand = Calculation::getInstance()->_calculateFormulaValue($fractionFormula);
+            $operand = Calculation::getInstance()->calculateFormulaValue($fractionFormula);
 
             return true;
         }

tests/PhpSpreadsheetTests/Calculation/ArrayFormulaTest.php

@@ -40,7 +40,7 @@ protected function tearDown(): void
      */
     public function testArrayFormula(string $formula, $expectedResult): void
     {
-        $result = Calculation::getInstance()->_calculateFormulaValue($formula);
+        $result = Calculation::getInstance()->calculateFormulaValue($formula);
         self::assertEquals($expectedResult, $result);
     }
 

tests/PhpSpreadsheetTests/Calculation/CalculationErrorTest.php

@@ -14,7 +14,7 @@ public function testCalculationException(): void
         $this->expectException(CalcException::class);
         $this->expectExceptionMessage('Formula Error:');
         $calculation = Calculation::getInstance();
-        $result = $calculation->_calculateFormulaValue('=SUM(');
+        $result = $calculation->calculateFormulaValue('=SUM(');
         self::assertFalse($result);
     }
 
@@ -25,7 +25,7 @@ public function testCalculationError(): void
         $error = false;
 
         try {
-            $calculation->_calculateFormulaValue('=SUM(');
+            $calculation->calculateFormulaValue('=SUM(');
         } catch (Throwable $e) {
             self::assertSame("Formula Error: Expecting ')'", $e->getMessage());
             self::assertSame('PHPUnit\\Framework\\Error\\Error', get_class($e));
@@ -47,7 +47,7 @@ public function testCalculationErrorTrulySuppressed(): void
         $calculation = Calculation::getInstance();
         $calculation->suppressFormulaErrors = true;
         set_error_handler([self::class, 'errhandler2']);
-        $result = $calculation->_calculateFormulaValue('=SUM(');
+        $result = $calculation->calculateFormulaValue('=SUM(');
         restore_error_handler();
         self::assertFalse($result);
     }