diff --git a/src/PhpSpreadsheet/Calculation/Engineering.php b/src/PhpSpreadsheet/Calculation/Engineering.php index d7ed6e31..f311fe99 100644 --- a/src/PhpSpreadsheet/Calculation/Engineering.php +++ b/src/PhpSpreadsheet/Calculation/Engineering.php @@ -17,7 +17,7 @@ class Engineering * * Parses a complex number into its real and imaginary parts, and an I or J suffix * - * @deprecated 2.0.0 No longer used by internal code. Please use the \Complex\Complex class instead + * @deprecated 1.12.0 No longer used by internal code. Please use the \Complex\Complex class instead * * @param string $complexNumber The complex number * @@ -43,7 +43,9 @@ class Engineering * Excel Function: * BESSELI(x,ord) * - * @Deprecated 2.0.0 Use the BESSELI() method in the Engineering\BesselI class instead + * @Deprecated 1.17.0 + * + * @see Use the BESSELI() method in the Engineering\BesselI class instead * * @param float $x The value at which to evaluate the function. * If x is nonnumeric, BESSELI returns the #VALUE! error value. @@ -67,7 +69,9 @@ class Engineering * Excel Function: * BESSELJ(x,ord) * - * @Deprecated 2.0.0 Use the BESSELJ() method in the Engineering\BesselJ class instead + * @Deprecated 1.17.0 + * + * @see Use the BESSELJ() method in the Engineering\BesselJ class instead * * @param float $x The value at which to evaluate the function. * If x is nonnumeric, BESSELJ returns the #VALUE! error value. @@ -91,7 +95,9 @@ class Engineering * Excel Function: * BESSELK(x,ord) * - * @Deprecated 2.0.0 Use the BESSELK() method in the Engineering\BesselK class instead + * @Deprecated 1.17.0 + * + * @see Use the BESSELK() method in the Engineering\BesselK class instead * * @param float $x The value at which to evaluate the function. * If x is nonnumeric, BESSELK returns the #VALUE! error value. @@ -114,7 +120,9 @@ class Engineering * Excel Function: * BESSELY(x,ord) * - * @Deprecated 2.0.0 Use the BESSELY() method in the Engineering\BesselY class instead + * @Deprecated 1.17.0 + * + * @see Use the BESSELY() method in the Engineering\BesselY class instead * * @param float $x The value at which to evaluate the function. * If x is nonnumeric, BESSELY returns the #VALUE! error value. @@ -137,7 +145,9 @@ class Engineering * Excel Function: * BIN2DEC(x) * - * @Deprecated 2.0.0 Use the toDecimal() method in the Engineering\ConvertBinary class instead + * @Deprecated 1.17.0 + * + * @see Use the toDecimal() method in the Engineering\ConvertBinary class instead * * @param string $x The binary number (as a string) that you want to convert. The number * cannot contain more than 10 characters (10 bits). The most significant @@ -161,7 +171,9 @@ class Engineering * Excel Function: * BIN2HEX(x[,places]) * - * @Deprecated 2.0.0 Use the toHex() method in the Engineering\ConvertBinary class instead + * @Deprecated 1.17.0 + * + * @see Use the toHex() method in the Engineering\ConvertBinary class instead * * @param string $x The binary number (as a string) that you want to convert. The number * cannot contain more than 10 characters (10 bits). The most significant @@ -191,7 +203,9 @@ class Engineering * Excel Function: * BIN2OCT(x[,places]) * - * @Deprecated 2.0.0 Use the toOctal() method in the Engineering\ConvertBinary class instead + * @Deprecated 1.17.0 + * + * @see Use the toOctal() method in the Engineering\ConvertBinary class instead * * @param string $x The binary number (as a string) that you want to convert. The number * cannot contain more than 10 characters (10 bits). The most significant @@ -221,7 +235,9 @@ class Engineering * Excel Function: * DEC2BIN(x[,places]) * - * @Deprecated 2.0.0 Use the toBinary() method in the Engineering\ConvertDecimal class instead + * @Deprecated 1.17.0 + * + * @see Use the toBinary() method in the Engineering\ConvertDecimal class instead * * @param string $x The decimal integer you want to convert. If number is negative, * valid place values are ignored and DEC2BIN returns a 10-character @@ -255,7 +271,9 @@ class Engineering * Excel Function: * DEC2HEX(x[,places]) * - * @Deprecated 2.0.0 Use the toHex() method in the Engineering\ConvertDecimal class instead + * @Deprecated 1.17.0 + * + * @see Use the toHex() method in the Engineering\ConvertDecimal class instead * * @param string $x The decimal integer you want to convert. If number is negative, * places is ignored and DEC2HEX returns a 10-character (40-bit) @@ -289,7 +307,9 @@ class Engineering * Excel Function: * DEC2OCT(x[,places]) * - * @Deprecated 2.0.0 Use the toOctal() method in the Engineering\ConvertDecimal class instead + * @Deprecated 1.17.0 + * + * @see Use the toOctal() method in the Engineering\ConvertDecimal class instead * * @param string $x The decimal integer you want to convert. If number is negative, * places is ignored and DEC2OCT returns a 10-character (30-bit) @@ -323,7 +343,9 @@ class Engineering * Excel Function: * HEX2BIN(x[,places]) * - * @Deprecated 2.0.0 Use the toBinary() method in the Engineering\ConvertHex class instead + * @Deprecated 1.17.0 + * + * @see Use the toBinary() method in the Engineering\ConvertHex class instead * * @param string $x the hexadecimal number you want to convert. * Number cannot contain more than 10 characters. @@ -357,7 +379,9 @@ class Engineering * Excel Function: * HEX2DEC(x) * - * @Deprecated 2.0.0 Use the toDecimal() method in the Engineering\ConvertHex class instead + * @Deprecated 1.17.0 + * + * @see Use the toDecimal() method in the Engineering\ConvertHex class instead * * @param string $x The hexadecimal number you want to convert. This number cannot * contain more than 10 characters (40 bits). The most significant @@ -382,7 +406,9 @@ class Engineering * Excel Function: * HEX2OCT(x[,places]) * - * @Deprecated 2.0.0 Use the toOctal() method in the Engineering\ConvertHex class instead + * @Deprecated 1.17.0 + * + * @see Use the toOctal() method in the Engineering\ConvertHex class instead * * @param string $x The hexadecimal number you want to convert. Number cannot * contain more than 10 characters. The most significant bit of @@ -420,7 +446,9 @@ class Engineering * Excel Function: * OCT2BIN(x[,places]) * - * @Deprecated 2.0.0 Use the toBinary() method in the Engineering\ConvertOctal class instead + * @Deprecated 1.17.0 + * + * @see Use the toBinary() method in the Engineering\ConvertOctal class instead * * @param string $x The octal number you want to convert. Number may not * contain more than 10 characters. The most significant @@ -460,7 +488,9 @@ class Engineering * Excel Function: * OCT2DEC(x) * - * @Deprecated 2.0.0 Use the toDecimal() method in the Engineering\ConvertOctal class instead + * @Deprecated 1.17.0 + * + * @see Use the toDecimal() method in the Engineering\ConvertOctal class instead * * @param string $x The octal number you want to convert. Number may not contain * more than 10 octal characters (30 bits). The most significant @@ -485,7 +515,9 @@ class Engineering * Excel Function: * OCT2HEX(x[,places]) * - * @Deprecated 2.0.0 Use the toHex() method in the Engineering\ConvertOctal class instead + * @Deprecated 1.17.0 + * + * @see Use the toHex() method in the Engineering\ConvertOctal class instead * * @param string $x The octal number you want to convert. Number may not contain * more than 10 octal characters (30 bits). The most significant @@ -1098,7 +1130,9 @@ class Engineering * Excel Function: * DELTA(a[,b]) * - * @Deprecated 2.0.0 Use the DELTA() method in the Engineering\Compare class instead + * @Deprecated 1.17.0 + * + * @see Use the DELTA() method in the Engineering\Compare class instead * * @param float $a the first number * @param float $b The second number. If omitted, b is assumed to be zero. @@ -1120,7 +1154,9 @@ class Engineering * Use this function to filter a set of values. For example, by summing several GESTEP * functions you calculate the count of values that exceed a threshold. * - * @Deprecated 2.0.0 Use the GESTEP() method in the Engineering\Compare class instead + * @Deprecated 1.17.0 + * + * @see Use the GESTEP() method in the Engineering\Compare class instead * * @param float $number the value to test against step * @param float $step The threshold value. If you omit a value for step, GESTEP uses zero. @@ -1140,7 +1176,9 @@ class Engineering * Excel Function: * BITAND(number1, number2) * - * @Deprecated 2.0.0 Use the BITAND() method in the Engineering\BitWise class instead + * @Deprecated 1.17.0 + * + * @see Use the BITAND() method in the Engineering\BitWise class instead * * @param int $number1 * @param int $number2 @@ -1160,7 +1198,9 @@ class Engineering * Excel Function: * BITOR(number1, number2) * - * @Deprecated 2.0.0 Use the BITOR() method in the Engineering\BitWise class instead + * @Deprecated 1.17.0 + * + * @see Use the BITOR() method in the Engineering\BitWise class instead * * @param int $number1 * @param int $number2 @@ -1180,7 +1220,9 @@ class Engineering * Excel Function: * BITXOR(number1, number2) * - * @Deprecated 2.0.0 Use the BITXOR() method in the Engineering\BitWise class instead + * @Deprecated 1.17.0 + * + * @see Use the BITXOR() method in the Engineering\BitWise class instead * * @param int $number1 * @param int $number2 @@ -1200,7 +1242,9 @@ class Engineering * Excel Function: * BITLSHIFT(number, shift_amount) * - * @Deprecated 2.0.0 Use the BITLSHIFT() method in the Engineering\BitWise class instead + * @Deprecated 1.17.0 + * + * @see Use the BITLSHIFT() method in the Engineering\BitWise class instead * * @param int $number * @param int $shiftAmount @@ -1220,7 +1264,9 @@ class Engineering * Excel Function: * BITRSHIFT(number, shift_amount) * - * @Deprecated 2.0.0 Use the BITRSHIFT() method in the Engineering\BitWise class instead + * @Deprecated 1.17.0 + * + * @see Use the BITRSHIFT() method in the Engineering\BitWise class instead * * @param int $number * @param int $shiftAmount @@ -1245,7 +1291,9 @@ class Engineering * Excel Function: * ERF(lower[,upper]) * - * @Deprecated 2.0.0 Use the ERF() method in the Engineering\Erf class instead + * @Deprecated 1.17.0 + * + * @see Use the ERF() method in the Engineering\Erf class instead * * @param float $lower lower bound for integrating ERF * @param float $upper upper bound for integrating ERF. @@ -1266,7 +1314,9 @@ class Engineering * Excel Function: * ERF.PRECISE(limit) * - * @Deprecated 2.0.0 Use the ERFPRECISE() method in the Engineering\Erf class instead + * @Deprecated 1.17.0 + * + * @see Use the ERFPRECISE() method in the Engineering\Erf class instead * * @param float $limit bound for integrating ERF * @@ -1290,7 +1340,9 @@ class Engineering * Excel Function: * ERFC(x) * - * @Deprecated 2.0.0 Use the ERFC() method in the Engineering\ErfC class instead + * @Deprecated 1.17.0 + * + * @see Use the ERFC() method in the Engineering\ErfC class instead * * @param float $x The lower bound for integrating ERFC * @@ -1305,7 +1357,9 @@ class Engineering * getConversionGroups * Returns a list of the different conversion groups for UOM conversions. * - * @Deprecated 2.0.0 Use the getConversionCategories() method in the Engineering\ConvertUOM class instead + * @Deprecated 1.16.0 + * + * @see Use the getConversionCategories() method in the Engineering\ConvertUOM class instead * * @return array */ @@ -1318,7 +1372,9 @@ class Engineering * getConversionGroupUnits * Returns an array of units of measure, for a specified conversion group, or for all groups. * - * @Deprecated Use the getConversionCategoryUnits() method in the ConvertUOM class instead + * @Deprecated 1.16.0 + * + * @see Use the getConversionCategoryUnits() method in the ConvertUOM class instead * * @param null|mixed $category * @@ -1332,7 +1388,9 @@ class Engineering /** * getConversionGroupUnitDetails. * - * @Deprecated Use the getConversionCategoryUnitDetails() method in the ConvertUOM class instead + * @Deprecated 1.16.0 + * + * @see Use the getConversionCategoryUnitDetails() method in the ConvertUOM class instead * * @param null|mixed $category * @@ -1347,7 +1405,9 @@ class Engineering * getConversionMultipliers * Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM(). * - * @Deprecated Use the getConversionMultipliers() method in the ConvertUOM class instead + * @Deprecated 1.16.0 + * + * @see Use the getConversionMultipliers() method in the ConvertUOM class instead * * @return array of mixed */ @@ -1357,10 +1417,14 @@ class Engineering } /** - * getBinaryConversionMultipliers - * Returns an array of the additional Multiplier prefixes that can be used with Information Units of Measure in CONVERTUOM(). + * getBinaryConversionMultipliers. * - * @Deprecated Use the getBinaryConversionMultipliers() method in the ConvertUOM class instead + * Returns an array of the additional Multiplier prefixes that can be used with Information Units of Measure + * in CONVERTUOM(). + * + * @Deprecated 1.16.0 + * + * @see Use the getBinaryConversionMultipliers() method in the ConvertUOM class instead * * @return array of mixed */ @@ -1379,7 +1443,9 @@ class Engineering * Excel Function: * CONVERT(value,fromUOM,toUOM) * - * @Deprecated Use the CONVERT() method in the ConvertUOM class instead + * @Deprecated 1.16.0 + * + * @see Use the CONVERT() method in the ConvertUOM class instead * * @param float|int $value the value in fromUOM to convert * @param string $fromUOM the units for value diff --git a/src/PhpSpreadsheet/Calculation/Logical.php b/src/PhpSpreadsheet/Calculation/Logical.php index 802ceb26..b267e1f0 100644 --- a/src/PhpSpreadsheet/Calculation/Logical.php +++ b/src/PhpSpreadsheet/Calculation/Logical.php @@ -4,6 +4,9 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; use PhpOffice\PhpSpreadsheet\Calculation\Logical\Boolean; +/** + * @deprecated 1.17.0 + */ class Logical { /** @@ -14,7 +17,10 @@ class Logical * Excel Function: * =TRUE() * - * @Deprecated Use the TRUE() method in the Logical\Boolean class instead + * @Deprecated 1.17.0 + * + * @see Logical\Boolean::TRUE() + * Use the TRUE() method in the Logical\Boolean class instead * * @return bool True */ @@ -31,7 +37,10 @@ class Logical * Excel Function: * =FALSE() * - * @Deprecated Use the FALSE() method in the Logical\Boolean class instead + * @Deprecated 1.17.0 + * + * @see Logical\Boolean::FALSE() + * Use the FALSE() method in the Logical\Boolean class instead * * @return bool False */ @@ -56,7 +65,10 @@ class Logical * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string * holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * - * @Deprecated Use the logicalAnd() method in the Logical\Operations class instead + * @Deprecated 1.17.0 + * + * @see Logical\Operations::logicalAnd() + * Use the logicalAnd() method in the Logical\Operations class instead * * @param mixed ...$args Data values * @@ -83,7 +95,10 @@ class Logical * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string * holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * - * @Deprecated Use the logicalOr() method in the Logical\Operations class instead + * @Deprecated 1.17.0 + * + * @see Logical\Operations::logicalOr() + * Use the logicalOr() method in the Logical\Operations class instead * * @param mixed $args Data values * @@ -112,7 +127,10 @@ class Logical * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string * holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * - * @Deprecated Use the logicalXor() method in the Logical\Operations class instead + * @Deprecated 1.17.0 + * + * @see Logical\Operations::logicalXor() + * Use the logicalXor() method in the Logical\Operations class instead * * @param mixed $args Data values * @@ -138,7 +156,10 @@ class Logical * If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string * holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value * - * @Deprecated Use the NOT() method in the Logical\Operations class instead + * @Deprecated 1.17.0 + * + * @see Logical\Operations::NOT() + * Use the NOT() method in the Logical\Operations class instead * * @param mixed $logical A value or expression that can be evaluated to TRUE or FALSE * @@ -174,7 +195,10 @@ class Logical * If condition is FALSE and ReturnIfFalse is blank, then the value 0 (zero) is returned. * ReturnIfFalse can be another formula. * - * @Deprecated Use the statementIf() method in the Logical\Conditional class instead + * @Deprecated 1.17.0 + * + * @see Logical\Conditional::statementIf() + * Use the statementIf() method in the Logical\Conditional class instead * * @param mixed $condition Condition to evaluate * @param mixed $returnIfTrue Value to return when condition is true @@ -207,7 +231,10 @@ class Logical * Optional. It is the default to return if expression does not match any of the values * (value1, value2, ... value_n). * - * @Deprecated Use the statementSwitch() method in the Logical\Conditional class instead + * @Deprecated 1.17.0 + * + * @see Logical\Conditional::statementSwitch() + * Use the statementSwitch() method in the Logical\Conditional class instead * * @param mixed $arguments Statement arguments * @@ -224,7 +251,10 @@ class Logical * Excel Function: * =IFERROR(testValue,errorpart) * - * @Deprecated Use the IFERROR() method in the Logical\Conditional class instead + * @Deprecated 1.17.0 + * + * @see Logical\Conditional::IFERROR() + * Use the IFERROR() method in the Logical\Conditional class instead * * @param mixed $testValue Value to check, is also the value returned when no error * @param mixed $errorpart Value to return when testValue is an error condition @@ -242,7 +272,10 @@ class Logical * Excel Function: * =IFNA(testValue,napart) * - * @Deprecated Use the IFNA() method in the Logical\Conditional class instead + * @Deprecated 1.17.0 + * + * @see Logical\Conditional::IFNA() + * Use the IFNA() method in the Logical\Conditional class instead * * @param mixed $testValue Value to check, is also the value returned when not an NA * @param mixed $napart Value to return when testValue is an NA condition @@ -265,7 +298,10 @@ class Logical * returnIfTrue1 ... returnIfTrue_n * Value returned if corresponding testValue (nth) was true * - * @Deprecated Use the IFS() method in the Logical\Conditional class instead + * @Deprecated 1.17.0 + * + * @see Logical\Conditional::IFS() + * Use the IFS() method in the Logical\Conditional class instead * * @param mixed ...$arguments Statement arguments * diff --git a/src/PhpSpreadsheet/Calculation/MathTrig.php b/src/PhpSpreadsheet/Calculation/MathTrig.php index a4b335d1..0ba109f3 100644 --- a/src/PhpSpreadsheet/Calculation/MathTrig.php +++ b/src/PhpSpreadsheet/Calculation/MathTrig.php @@ -218,7 +218,9 @@ class MathTrig * Excel Function: * CEILING(number[,significance]) * - * @Deprecated 2.0.0 Use the funcCeiling method in the MathTrig\Ceiling class instead + * @Deprecated 1.17.0 + * + * @see Use the funcCeiling() method in the MathTrig\Ceiling class instead * * @param float $number the number you want to round * @param float $significance the multiple to which you want to round @@ -385,7 +387,9 @@ class MathTrig * Excel Function: * FLOOR(number[,significance]) * - * @Deprecated 2.0.0 Use the funcFloor method in the MathTrig\Floor class instead + * @Deprecated 1.17.0 + * + * @see Use the funcFloor() method in the MathTrig\Floor class instead * * @param float $number Number to round * @param float $significance Significance @@ -407,7 +411,9 @@ class MathTrig * Excel Function: * FLOOR.MATH(number[,significance[,mode]]) * - * @Deprecated 2.0.0 Use the funcFloorMath method in the MathTrig\FloorMath class instead + * @Deprecated 1.17.0 + * + * @see Use the funcFloorMath() method in the MathTrig\FloorMath class instead * * @param float $number Number to round * @param float $significance Significance @@ -430,7 +436,9 @@ class MathTrig * Excel Function: * FLOOR.PRECISE(number[,significance]) * - * @Deprecated 2.0.0 Use the funcFloorPrecise method in the MathTrig\FloorPrecise class instead + * @Deprecated 1.17.0 + * + * @see Use the funcFloorPrecise() method in the MathTrig\FloorPrecise class instead * * @param float $number Number to round * @param float $significance Significance @@ -457,7 +465,9 @@ class MathTrig * Excel Function: * INT(number) * - * @Deprecated 2.0.0 Use the funcInt method in the MathTrig\IntClass class instead + * @Deprecated 1.17.0 + * + * @see Use the funcInt() method in the MathTrig\IntClass class instead * * @param float $number Number to cast to an integer * @@ -779,7 +789,9 @@ class MathTrig * * Rounds a number to the nearest multiple of a specified value * - * @Deprecated 2.0.0 Use the funcMround method in the MathTrig\Mround class instead + * @Deprecated 1.17.0 + * + * @see Use the funcMround() method in the MathTrig\Mround class instead * * @param float $number Number to round * @param int $multiple Multiple to which you want to round $number @@ -995,7 +1007,9 @@ class MathTrig * * Converts a number to Roman numeral * - * @Deprecated 2.0.0 Use the funcRoman method in the MathTrig\Roman class instead + * @Deprecated 1.17.0 + * + * @see Use the funcRoman() method in the MathTrig\Roman class instead * * @param mixed $aValue Number to convert * @param mixed $style Number indicating one of five possible forms @@ -1014,7 +1028,9 @@ class MathTrig * * Rounds a number up to a specified number of decimal places * - * @Deprecated 2.0.0 Use the funcRoundUp method in the MathTrig\RoundUp class instead + * @Deprecated 1.17.0 + * + * @see Use the funcRoundUp() method in the MathTrig\RoundUp class instead * * @param float $number Number to round * @param int $digits Number of digits to which you want to round $number @@ -1033,7 +1049,9 @@ class MathTrig * * Rounds a number down to a specified number of decimal places * - * @Deprecated 2.0.0 Use the funcRoundDown method in the MathTrig\RoundDown class instead + * @Deprecated 1.17.0 + * + * @see Use the funcRoundDown() method in the MathTrig\RoundDown class instead * * @param float $number Number to round * @param int $digits Number of digits to which you want to round $number @@ -1517,7 +1535,9 @@ class MathTrig * * Truncates value to the number of fractional digits by number_digits. * - * @Deprecated 2.0.0 Use the funcTrunc method in the MathTrig\Trunc class instead + * @Deprecated 1.17.0 + * + * @see Use the funcTrunc() method in the MathTrig\Trunc class instead * * @param float $value * @param int $digits @@ -1722,7 +1742,9 @@ class MathTrig * * Returns the result of builtin function round after validating args. * - * @Deprecated 2.0.0 Use the builtinRound method in the MathTrig\Round class instead + * @Deprecated 1.17.0 + * + * @see Use the builtinRound() method in the MathTrig\Round class instead * * @param mixed $number Should be numeric * @param mixed $precision Should be int diff --git a/src/PhpSpreadsheet/Calculation/Statistical.php b/src/PhpSpreadsheet/Calculation/Statistical.php index 5792b78f..f7d0c05f 100644 --- a/src/PhpSpreadsheet/Calculation/Statistical.php +++ b/src/PhpSpreadsheet/Calculation/Statistical.php @@ -2,6 +2,7 @@ namespace PhpOffice\PhpSpreadsheet\Calculation; +use PhpOffice\PhpSpreadsheet\Calculation\Statistical\Permutations; use PhpOffice\PhpSpreadsheet\Shared\Trend\Trend; class Statistical @@ -2923,7 +2924,10 @@ class Statistical * combinations, for which the internal order is not significant. Use this function * for lottery-style probability calculations. * - * @Deprecated 2.0.0 Use the PERMUT() method in the Statistical\Permutations class instead + * @Deprecated 1.17.0 + * + * @see Statistical\Permutations::PERMUT() + * Use the PERMUT() method in the Statistical\Permutations class instead * * @param int $numObjs Number of different objects * @param int $numInSet Number of objects in each permutation