Litipk /
php-bignumbers
Complex classes like Decimal often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Decimal, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | class Decimal |
||
| 18 | { |
||
| 19 | const DEFAULT_SCALE = 16; |
||
| 20 | const CLASSIC_DECIMAL_NUMBER_REGEXP = '/^([+\-]?)0*(([1-9][0-9]*|[0-9])(\.[0-9]+)?)$/'; |
||
| 21 | const EXP_NOTATION_NUMBER_REGEXP = '/^ (?P<sign> [+\-]?) 0*(?P<mantissa> [0-9](?P<decimals> \.[0-9]+)?) [eE] (?P<expSign> [+\-]?)(?P<exp> \d+)$/x'; |
||
| 22 | const EXP_NUM_GROUPS_NUMBER_REGEXP = '/^ (?P<int> \d*) (?: \. (?P<dec> \d+) ) E (?P<sign>[\+\-]) (?P<exp>\d+) $/x'; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * Internal numeric value |
||
| 26 | * @var string |
||
| 27 | */ |
||
| 28 | protected $value; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * Number of digits behind the point |
||
| 32 | * @var integer |
||
| 33 | */ |
||
| 34 | private $scale; |
||
| 35 | |||
| 36 | 182 | private function __construct(string $value, int $scale) |
|
| 41 | |||
| 42 | private function __clone() |
||
| 45 | |||
| 46 | /** |
||
| 47 | * Decimal "constructor". |
||
| 48 | * |
||
| 49 | * @param mixed $value |
||
| 50 | * @param int $scale |
||
| 51 | * @return Decimal |
||
| 52 | */ |
||
| 53 | 9 | public static function create($value, int $scale = null): Decimal |
|
| 70 | |||
| 71 | 98 | public static function fromInteger(int $intValue): Decimal |
|
| 77 | |||
| 78 | /** |
||
| 79 | * @param float $fltValue |
||
| 80 | * @param int $scale |
||
| 81 | * @return Decimal |
||
| 82 | */ |
||
| 83 | 60 | public static function fromFloat(float $fltValue, int $scale = null): Decimal |
|
| 119 | |||
| 120 | /** |
||
| 121 | * @param string $strValue |
||
| 122 | * @param integer $scale |
||
| 123 | * @return Decimal |
||
| 124 | */ |
||
| 125 | 133 | public static function fromString(string $strValue, int $scale = null): Decimal |
|
| 158 | |||
| 159 | /** |
||
| 160 | * Constructs a new Decimal object based on a previous one, |
||
| 161 | * but changing it's $scale property. |
||
| 162 | * |
||
| 163 | * @param Decimal $decValue |
||
| 164 | * @param null|int $scale |
||
| 165 | * @return Decimal |
||
| 166 | */ |
||
| 167 | 3 | public static function fromDecimal(Decimal $decValue, int $scale = null): Decimal |
|
| 181 | |||
| 182 | /** |
||
| 183 | * Adds two Decimal objects |
||
| 184 | * @param Decimal $b |
||
| 185 | * @param null|int $scale |
||
| 186 | * @return Decimal |
||
| 187 | */ |
||
| 188 | 40 | public function add(Decimal $b, int $scale = null): Decimal |
|
| 197 | |||
| 198 | /** |
||
| 199 | * Subtracts two BigNumber objects |
||
| 200 | * @param Decimal $b |
||
| 201 | * @param integer $scale |
||
| 202 | * @return Decimal |
||
| 203 | */ |
||
| 204 | 33 | public function sub(Decimal $b, int $scale = null): Decimal |
|
| 213 | |||
| 214 | /** |
||
| 215 | * Multiplies two BigNumber objects |
||
| 216 | * @param Decimal $b |
||
| 217 | * @param integer $scale |
||
| 218 | * @return Decimal |
||
| 219 | */ |
||
| 220 | 48 | public function mul(Decimal $b, int $scale = null): Decimal |
|
| 233 | |||
| 234 | /** |
||
| 235 | * Divides the object by $b . |
||
| 236 | * Warning: div with $scale == 0 is not the same as |
||
| 237 | * integer division because it rounds the |
||
| 238 | * last digit in order to minimize the error. |
||
| 239 | * |
||
| 240 | * @param Decimal $b |
||
| 241 | * @param integer $scale |
||
| 242 | * @return Decimal |
||
| 243 | */ |
||
| 244 | 65 | public function div(Decimal $b, int $scale = null): Decimal |
|
| 279 | |||
| 280 | /** |
||
| 281 | * Returns the square root of this object |
||
| 282 | * @param integer $scale |
||
| 283 | * @return Decimal |
||
| 284 | */ |
||
| 285 | 4 | public function sqrt(int $scale = null): Decimal |
|
| 302 | |||
| 303 | /** |
||
| 304 | * Powers this value to $b |
||
| 305 | * |
||
| 306 | * @param Decimal $b exponent |
||
| 307 | * @param integer $scale |
||
| 308 | * @return Decimal |
||
| 309 | */ |
||
| 310 | 10 | public function pow(Decimal $b, int $scale = null): Decimal |
|
| 365 | |||
| 366 | /** |
||
| 367 | * Returns the object's logarithm in base 10 |
||
| 368 | * @param integer $scale |
||
| 369 | * @return Decimal |
||
| 370 | */ |
||
| 371 | 7 | public function log10(int $scale = null): Decimal |
|
| 388 | |||
| 389 | 96 | public function isZero(int $scale = null): bool |
|
| 395 | |||
| 396 | 31 | public function isPositive(): bool |
|
| 400 | |||
| 401 | 71 | public function isNegative(): bool |
|
| 405 | |||
| 406 | 3 | public function isInteger(): bool |
|
| 410 | |||
| 411 | /** |
||
| 412 | * Equality comparison between this object and $b |
||
| 413 | * @param Decimal $b |
||
| 414 | * @param integer $scale |
||
| 415 | * @return boolean |
||
| 416 | */ |
||
| 417 | 115 | public function equals(Decimal $b, int $scale = null): bool |
|
| 435 | |||
| 436 | /** |
||
| 437 | * $this > $b : returns 1 , $this < $b : returns -1 , $this == $b : returns 0 |
||
| 438 | * |
||
| 439 | * @param Decimal $b |
||
| 440 | * @param integer $scale |
||
| 441 | * @return integer |
||
| 442 | */ |
||
| 443 | 56 | public function comp(Decimal $b, int $scale = null): int |
|
| 459 | |||
| 460 | |||
| 461 | /** |
||
| 462 | * Returns true if $this > $b, otherwise false |
||
| 463 | * |
||
| 464 | * @param Decimal $b |
||
| 465 | * @param integer $scale |
||
| 466 | * @return bool |
||
| 467 | */ |
||
| 468 | 3 | public function isGreaterThan(Decimal $b, int $scale = null): bool |
|
| 472 | |||
| 473 | /** |
||
| 474 | * Returns true if $this >= $b |
||
| 475 | * |
||
| 476 | * @param Decimal $b |
||
| 477 | * @param integer $scale |
||
| 478 | * @return bool |
||
| 479 | */ |
||
| 480 | 3 | public function isGreaterOrEqualTo(Decimal $b, int $scale = null): bool |
|
| 486 | |||
| 487 | /** |
||
| 488 | * Returns true if $this < $b, otherwise false |
||
| 489 | * |
||
| 490 | * @param Decimal $b |
||
| 491 | * @param integer $scale |
||
| 492 | * @return bool |
||
| 493 | */ |
||
| 494 | 3 | public function isLessThan(Decimal $b, int $scale = null): bool |
|
| 498 | |||
| 499 | /** |
||
| 500 | * Returns true if $this <= $b, otherwise false |
||
| 501 | * |
||
| 502 | * @param Decimal $b |
||
| 503 | * @param integer $scale |
||
| 504 | * @return bool |
||
| 505 | */ |
||
| 506 | 3 | public function isLessOrEqualTo(Decimal $b, int $scale = null): bool |
|
| 512 | |||
| 513 | /** |
||
| 514 | * Returns the element's additive inverse. |
||
| 515 | * @return Decimal |
||
| 516 | */ |
||
| 517 | 15 | public function additiveInverse(): Decimal |
|
| 529 | |||
| 530 | |||
| 531 | /** |
||
| 532 | * "Rounds" the Decimal to have at most $scale digits after the point |
||
| 533 | * @param integer $scale |
||
| 534 | * @return Decimal |
||
| 535 | */ |
||
| 536 | 52 | public function round(int $scale = 0): Decimal |
|
| 544 | |||
| 545 | /** |
||
| 546 | * "Ceils" the Decimal to have at most $scale digits after the point |
||
| 547 | * @param integer $scale |
||
| 548 | * @return Decimal |
||
| 549 | */ |
||
| 550 | 4 | public function ceil($scale = 0): Decimal |
|
| 562 | |||
| 563 | 28 | private function innerTruncate(int $scale = 0, bool $ceil = true): Decimal |
|
| 586 | |||
| 587 | /** |
||
| 588 | * "Floors" the Decimal to have at most $scale digits after the point |
||
| 589 | * @param integer $scale |
||
| 590 | * @return Decimal |
||
| 591 | */ |
||
| 592 | 47 | public function floor(int $scale = 0): Decimal |
|
| 604 | |||
| 605 | /** |
||
| 606 | * Returns the absolute value (always a positive number) |
||
| 607 | * @return Decimal |
||
| 608 | */ |
||
| 609 | 23 | public function abs(): Decimal |
|
| 615 | |||
| 616 | /** |
||
| 617 | * Calculate modulo with a decimal |
||
| 618 | * @param Decimal $d |
||
| 619 | * @param integer $scale |
||
| 620 | * @return $this % $d |
||
| 621 | */ |
||
| 622 | 27 | public function mod(Decimal $d, int $scale = null): Decimal |
|
| 627 | |||
| 628 | /** |
||
| 629 | * Calculates the sine of this method with the highest possible accuracy |
||
| 630 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 631 | * |
||
| 632 | * @param integer $scale |
||
| 633 | * @return Decimal sin($this) |
||
| 634 | */ |
||
| 635 | 13 | public function sin(int $scale = null): Decimal |
|
| 654 | |||
| 655 | /** |
||
| 656 | * Calculates the cosecant of this with the highest possible accuracy |
||
| 657 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 658 | * |
||
| 659 | * @param integer $scale |
||
| 660 | * @return Decimal |
||
| 661 | */ |
||
| 662 | 3 | public function cosec(int $scale = null): Decimal |
|
| 673 | |||
| 674 | /** |
||
| 675 | * Calculates the cosine of this method with the highest possible accuracy |
||
| 676 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 677 | * |
||
| 678 | * @param integer $scale |
||
| 679 | * @return Decimal cos($this) |
||
| 680 | */ |
||
| 681 | 13 | public function cos(int $scale = null): Decimal |
|
| 700 | |||
| 701 | /** |
||
| 702 | * Calculates the secant of this with the highest possible accuracy |
||
| 703 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 704 | * |
||
| 705 | * @param integer $scale |
||
| 706 | * @return Decimal |
||
| 707 | */ |
||
| 708 | 3 | public function sec(int $scale = null): Decimal |
|
| 719 | |||
| 720 | /** |
||
| 721 | * Calculates the arcsine of this with the highest possible accuracy |
||
| 722 | * |
||
| 723 | * @param integer $scale |
||
| 724 | * @return Decimal |
||
| 725 | */ |
||
| 726 | 5 | public function arcsin(int $scale = null): Decimal |
|
| 752 | |||
| 753 | /** |
||
| 754 | * Calculates the arccosine of this with the highest possible accuracy |
||
| 755 | * |
||
| 756 | * @param integer $scale |
||
| 757 | * @return Decimal |
||
| 758 | */ |
||
| 759 | 5 | public function arccos(int $scale = null): Decimal |
|
| 789 | |||
| 790 | /** |
||
| 791 | * Calculates the arctangente of this with the highest possible accuracy |
||
| 792 | * |
||
| 793 | * @param integer $scale |
||
| 794 | * @return Decimal |
||
| 795 | */ |
||
| 796 | 3 | public function arctan(int $scale = null): Decimal |
|
| 818 | |||
| 819 | /** |
||
| 820 | * Calculates the arccotangente of this with the highest possible accuracy |
||
| 821 | * |
||
| 822 | * @param integer $scale |
||
| 823 | * @return Decimal |
||
| 824 | */ |
||
| 825 | 3 | public function arccot(int $scale = null): Decimal |
|
| 850 | |||
| 851 | /** |
||
| 852 | * Calculates the arcsecant of this with the highest possible accuracy |
||
| 853 | * |
||
| 854 | * @param integer $scale |
||
| 855 | * @return Decimal |
||
| 856 | */ |
||
| 857 | 5 | public function arcsec(int $scale = null): Decimal |
|
| 884 | |||
| 885 | /** |
||
| 886 | * Calculates the arccosecant of this with the highest possible accuracy |
||
| 887 | * |
||
| 888 | * @param integer $scale |
||
| 889 | * @return Decimal |
||
| 890 | */ |
||
| 891 | 5 | public function arccsc(int $scale = null): Decimal |
|
| 914 | |||
| 915 | /** |
||
| 916 | * Returns exp($this), said in other words: e^$this . |
||
| 917 | * |
||
| 918 | * @param integer $scale |
||
| 919 | * @return Decimal |
||
| 920 | */ |
||
| 921 | 11 | public function exp(int $scale = null): Decimal |
|
| 936 | |||
| 937 | /** |
||
| 938 | * Internal method used to compute sin, cos and exp |
||
| 939 | * |
||
| 940 | * @param Decimal $x |
||
| 941 | * @param Decimal $firstTerm |
||
| 942 | * @param callable $generalTerm |
||
| 943 | * @param $scale |
||
| 944 | * @return Decimal |
||
| 945 | */ |
||
| 946 | 28 | private static function factorialSerie (Decimal $x, Decimal $firstTerm, callable $generalTerm, int $scale): Decimal |
|
| 970 | |||
| 971 | |||
| 972 | /** |
||
| 973 | * Internal method used to compute arcsine and arcosine |
||
| 974 | * |
||
| 975 | * @param Decimal $x |
||
| 976 | * @param Decimal $firstTerm |
||
| 977 | * @param $scale |
||
| 978 | * @return Decimal |
||
| 979 | */ |
||
| 980 | 6 | private static function powerSerie (Decimal $x, Decimal $firstTerm, int $scale): Decimal |
|
| 1020 | |||
| 1021 | /** |
||
| 1022 | * Internal method used to compute arctan and arccotan |
||
| 1023 | * |
||
| 1024 | * @param Decimal $x |
||
| 1025 | * @param Decimal $firstTerm |
||
| 1026 | * @param $scale |
||
| 1027 | * @return Decimal |
||
| 1028 | */ |
||
| 1029 | 2 | private static function simplePowerSerie (Decimal $x, Decimal $firstTerm, int $scale): Decimal |
|
| 1058 | |||
| 1059 | /** |
||
| 1060 | * Calculates the tangent of this method with the highest possible accuracy |
||
| 1061 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 1062 | * |
||
| 1063 | * @param integer $scale |
||
| 1064 | * @return Decimal tan($this) |
||
| 1065 | */ |
||
| 1066 | 4 | public function tan(int $scale = null): Decimal |
|
| 1077 | |||
| 1078 | /** |
||
| 1079 | * Calculates the cotangent of this method with the highest possible accuracy |
||
| 1080 | * Note that accuracy is limited by the accuracy of predefined PI; |
||
| 1081 | * |
||
| 1082 | * @param integer $scale |
||
| 1083 | * @return Decimal cotan($this) |
||
| 1084 | */ |
||
| 1085 | 4 | public function cotan(int $scale = null): Decimal |
|
| 1096 | |||
| 1097 | /** |
||
| 1098 | * Indicates if the passed parameter has the same sign as the method's bound object. |
||
| 1099 | * |
||
| 1100 | * @param Decimal $b |
||
| 1101 | * @return bool |
||
| 1102 | */ |
||
| 1103 | public function hasSameSign(Decimal $b): bool |
||
| 1107 | |||
| 1108 | 5 | public function asFloat(): float |
|
| 1112 | |||
| 1113 | 1 | public function asInteger(): int |
|
| 1117 | |||
| 1118 | /** |
||
| 1119 | * WARNING: use with caution! Return the inner representation of the class. |
||
| 1120 | */ |
||
| 1121 | 22 | public function innerValue(): string |
|
| 1125 | |||
| 1126 | /** |
||
| 1127 | * @return string |
||
| 1128 | */ |
||
| 1129 | 58 | public function __toString(): string |
|
| 1133 | |||
| 1134 | /* |
||
| 1135 | * |
||
| 1136 | */ |
||
| 1137 | 7 | private static function fromExpNotationString( |
|
| 1167 | |||
| 1168 | /** |
||
| 1169 | * "Rounds" the decimal string to have at most $scale digits after the point |
||
| 1170 | * |
||
| 1171 | * @param string $value |
||
| 1172 | * @param int $scale |
||
| 1173 | * @return string |
||
| 1174 | */ |
||
| 1175 | 159 | private static function innerRound(string $value, int $scale = 0): string |
|
| 1190 | |||
| 1191 | /** |
||
| 1192 | * Calculates the logarithm (in base 10) of $value |
||
| 1193 | * |
||
| 1194 | * @param string $value The number we want to calculate its logarithm (only positive numbers) |
||
| 1195 | * @param int $in_scale Expected scale used by $value (only positive numbers) |
||
| 1196 | * @param int $out_scale Scale used by the return value (only positive numbers) |
||
| 1197 | * @return string |
||
| 1198 | */ |
||
| 1199 | 25 | private static function innerLog10(string $value, int $in_scale, int $out_scale): string |
|
| 1236 | |||
| 1237 | /** |
||
| 1238 | * Returns $base^$exponent |
||
| 1239 | * |
||
| 1240 | * @param string $base |
||
| 1241 | * @param string $exponent 0 < $exponent < 1 |
||
| 1242 | * @param int $exp_scale Number of $exponent's significative digits |
||
| 1243 | * @param int $out_scale Number of significative digits that we want to compute |
||
| 1244 | * @return string |
||
| 1245 | */ |
||
| 1246 | 3 | private static function innerPowWithLittleExponent( |
|
| 1274 | |||
| 1275 | /** |
||
| 1276 | * Auxiliar method. It helps us to decompose the exponent into many summands. |
||
| 1277 | * |
||
| 1278 | * @param string $exponent_remaining |
||
| 1279 | * @param int $actual_index |
||
| 1280 | * @param int $exp_scale Number of $exponent's significative digits |
||
| 1281 | * @param int $inner_scale ceil($exp_scale*log(10)/log(2))+1; |
||
| 1282 | * @return array |
||
| 1283 | */ |
||
| 1284 | 3 | private static function computeSquareIndex( |
|
| 1302 | |||
| 1303 | /** |
||
| 1304 | * Auxiliar method. Computes $base^((1/2)^$index) |
||
| 1305 | * |
||
| 1306 | * @param string $base |
||
| 1307 | * @param integer $index |
||
| 1308 | * @param integer $out_scale |
||
| 1309 | * @return string |
||
| 1310 | */ |
||
| 1311 | 3 | private static function compute2NRoot(string $base, int $index, int $out_scale): string |
|
| 1321 | |||
| 1322 | /** |
||
| 1323 | * Validates basic constructor's arguments |
||
| 1324 | * @param mixed $value |
||
| 1325 | * @param null|int $scale |
||
| 1326 | */ |
||
| 1327 | 185 | protected static function paramsValidation($value, int $scale = null) |
|
| 1337 | |||
| 1338 | /** |
||
| 1339 | * @return string |
||
| 1340 | */ |
||
| 1341 | 131 | private static function normalizeSign(string $sign): string |
|
| 1349 | |||
| 1350 | /** |
||
| 1351 | * Counts the number of significant digits of $val. |
||
| 1352 | * Assumes a consistent internal state (without zeros at the end or the start). |
||
| 1353 | * |
||
| 1354 | * @param Decimal $val |
||
| 1355 | * @param Decimal $abs $val->abs() |
||
| 1356 | * @return int |
||
| 1357 | */ |
||
| 1358 | 22 | private static function countSignificativeDigits(Decimal $val, Decimal $abs): int |
|
| 1364 | } |
||
| 1365 |
Loading history...
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.