Sign upLogin

uruba/FinanCalc

View on GitHub
Star
src/Calculators/AnnuityCalculator.php

Summary

Maintainability
B
6 hrs
Test Coverage

AnnuityCalculator has 23 functions (exceeds 20 allowed). Consider refactoring.
Open

    class AnnuityCalculator extends CalculatorAbstract
    {

        // amount of each individual payment = 'K'
        protected $annuitySinglePaymentAmount;
Severity: Minor
Found in src/Calculators/AnnuityCalculator.php - About 2 hrs to fix

    Method getAnnuityValue has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

            public function getAnnuityValue(
            AnnuityPaymentTypes $annuityPaymentType = null,
            AnnuityValueTypes $annuityValueType
        ) {
            // if the number of the annuity's compounding periods
    Severity: Major
    Found in src/Calculators/AnnuityCalculator.php - About 2 hrs to fix

      Function getAnnuityValue has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

              public function getAnnuityValue(
            AnnuityPaymentTypes $annuityPaymentType = null,
            AnnuityValueTypes $annuityValueType
        ) {
            // if the number of the annuity's compounding periods
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php - About 1 hr to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      The method getAnnuityValue() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
      Open

              public function getAnnuityValue(
            AnnuityPaymentTypes $annuityPaymentType = null,
            AnnuityValueTypes $annuityValueType
        ) {
            // if the number of the annuity's compounding periods
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpmd

      CyclomaticComplexity

      Since: 0.1

      Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

      Example

      // Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a == $b) {
3           if ($a1 == $b1) {
                fiddle();
4           } elseif ($a2 == $b2) {
                fiddle();
            } else {
                fiddle();
            }
5       } elseif ($c == $d) {
6           while ($c == $d) {
                fiddle();
            }
7        } elseif ($e == $f) {
8           for ($n = 0; $n < $h; $n++) {
                fiddle();
            }
        } else {
            switch ($z) {
9               case 1:
                    fiddle();
                    break;
10              case 2:
                    fiddle();
                    break;
11              case 3:
                    fiddle();
                    break;
                default:
                    fiddle();
                    break;
            }
        }
    }
}

      Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

      Blank line found at start of control structure
      Open

                  if (Helpers::checkIfNotNull($annuityPaymentType)) {
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Only one argument is allowed per line in a multi-line function call
      Open

                  $this->setProperty("annuityNoOfCompoundingPeriods", $annuityNoOfCompoundingPeriods,
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Line indented incorrectly; expected at least 16 spaces, found 12
      Open

                  "annuityPresentValue" =>
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Multi-line function call not indented correctly; expected 12 spaces but found 16
      Open

                      Lambdas::checkIfNotNegative());
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Multi-line function call not indented correctly; expected 20 spaces but found 24
      Open

                              $this->annuityInterest)
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Opening parenthesis of a multi-line function call must be the last content on the line
      Open

                  $this->setProperty("annuityNoOfCompoundingPeriods", $annuityNoOfCompoundingPeriods,
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Closing parenthesis of a multi-line function call must be on a line by itself
      Open

                      Lambdas::checkIfNotNegative());
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Closing parenthesis of a multi-line function call must be on a line by itself
      Open

                                      $denominator),
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Multi-line function call not indented correctly; expected 28 spaces but found 32
      Open

                                      $denominator),
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Line indented incorrectly; expected at least 16 spaces, found 12
      Open

                  "annuityFutureValue" =>
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Closing parenthesis of a multi-line function call must be on a line by itself
      Open

                                  $this->annuitySinglePaymentAmount);
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Closing parenthesis of a multi-line function call must be on a line by itself
      Open

                              $this->annuityInterest)
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      Multi-line function call not indented correctly; expected 24 spaces but found 28
      Open

                                  $this->annuitySinglePaymentAmount);
      Severity: Minor
      Found in src/Calculators/AnnuityCalculator.php by phpcodesniffer

      There are no issues that match your filters.

      Category
      Status