VSVverkeerskunde/gvq-api

View on GitHub
src/Dashboard/Controllers/DashboardViewController.php

Summary

Maintainability
A
3 hrs
Test Coverage

Method dashboard has 59 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function dashboard(?string $companyId): Response
    {
        $activeCompany = $this->getCompany($companyId);
        $companies = $this->getCompaniesForUser();

Severity: Major
Found in src/Dashboard/Controllers/DashboardViewController.php - About 2 hrs to fix

    Method __construct has 10 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            Year $year,
            UserRepository $userRepository,
            CompanyRepository $companyRepository,
            DashboardService $dashboardService,
            StatisticsService $statisticsService,
    Severity: Major
    Found in src/Dashboard/Controllers/DashboardViewController.php - About 1 hr to fix

      The method __construct has 10 parameters. Consider reducing the number of parameters to less than 10.
      Open

          public function __construct(
              Year $year,
              UserRepository $userRepository,
              CompanyRepository $companyRepository,
              DashboardService $dashboardService,

      This function has 10 parameters, which is greater than the 7 authorized.
      Open

          public function __construct(
              Year $year,
              UserRepository $userRepository,
              CompanyRepository $companyRepository,
              DashboardService $dashboardService,

      A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

      Noncompliant Code Example

      With a maximum number of 4 parameters:

      function doSomething($param1, $param2, $param3, $param4, $param5) {
      ...
      }
      

      Compliant Solution

      function doSomething($param1, $param2, $param3, $param4) {
      ...
      }
      

      The class DashboardViewController has a coupling between objects value of 14. Consider to reduce the number of dependencies under 13.
      Open

      class DashboardViewController extends CompanyAwareController
      {
          /**
           * @var Year
           */

      CouplingBetweenObjects

      Since: 1.1.0

      A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

      Example

      class Foo {
          /**
           * @var \foo\bar\X
           */
          private $x = null;
      
          /**
           * @var \foo\bar\Y
           */
          private $y = null;
      
          /**
           * @var \foo\bar\Z
           */
          private $z = null;
      
          public function setFoo(\Foo $foo) {}
          public function setBar(\Bar $bar) {}
          public function setBaz(\Baz $baz) {}
      
          /**
           * @return \SplObjectStorage
           * @throws \OutOfRangeException
           * @throws \InvalidArgumentException
           * @throws \ErrorException
           */
          public function process(\Iterator $it) {}
      
          // ...
      }

      Source https://phpmd.org/rules/design.html#couplingbetweenobjects

      Missing class import via use statement (line '205', column '23').
      Open

                  throw new \InvalidArgumentException('Found no active company!');

      MissingImport

      Since: 2.7.0

      Importing all external classes in a file through use statements makes them clearly visible.

      Example

      function make() {
          return new \stdClass();
      }

      Source http://phpmd.org/rules/cleancode.html#MissingImport

      Avoid excessively long variable names like $uniqueParticipantCounts. Keep variable name length under 20.
      Open

              $uniqueParticipantCounts = $this->statisticsService->getUniqueParticipantCounts();

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $passedUniqueParticipantPercentage. Keep variable name length under 20.
      Open

              $passedUniqueParticipantPercentage = $this->statisticsService->getPassedUniqueParticipantPercentages();

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyParticipantRanker. Keep variable name length under 20.
      Open

          private $companyParticipantRanker;

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $questionDifficultyRepositoryFactory. Keep variable name length under 20.
      Open

          private $questionDifficultyRepositoryFactory;

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $employeeParticipationRatio. Keep variable name length under 20.
      Open

              $employeeParticipationRatio = $this->dashboardService->getEmployeeParticipationRatio(

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyParticipantRanker. Keep variable name length under 20.
      Open

              CompanyParticipantRanker $companyParticipantRanker,

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyUniqueParticipantCounts. Keep variable name length under 20.
      Open

              $companyUniqueParticipantCounts = $this->dashboardService->uniqueParticipants($activeCompany->getId());

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $detailedTopScoreAverages. Keep variable name length under 20.
      Open

              $detailedTopScoreAverages = $this->statisticsService->getDetailedTopScoreAverages();

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $questionDifficultyRepository. Keep variable name length under 20.
      Open

              $questionDifficultyRepository = $this->questionDifficultyRepositoryFactory->forCompany($activeCompany->getId());

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $passedUniqueParticipantCounts. Keep variable name length under 20.
      Open

              $passedUniqueParticipantCounts = $this->statisticsService->getPassedUniqueParticipantCounts();

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyPassedUniqueParticipantCounts. Keep variable name length under 20.
      Open

              $companyPassedUniqueParticipantCounts = $this->dashboardService->uniquePassedParticipants($activeCompany->getId());

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyDetailedTopScoreAverages. Keep variable name length under 20.
      Open

              $companyDetailedTopScoreAverages = $this->dashboardService->averageTopscores($activeCompany->getId());

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $questionDifficultyRepositoryFactory. Keep variable name length under 20.
      Open

              CompanyQuestionDifficultyRepositoryFactory $questionDifficultyRepositoryFactory,

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid excessively long variable names like $companyPassedUniqueParticipantPercentage. Keep variable name length under 20.
      Open

              $companyPassedUniqueParticipantPercentage = $this->dashboardService->uniquePassedParticipantsPercentages($activeCompany->getId());

      LongVariable

      Since: 0.2

      Detects when a field, formal or local variable is declared with a long name.

      Example

      class Something {
          protected $reallyLongIntName = -3; // VIOLATION - Field
          public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
              $otherReallyLongName = -5; // VIOLATION - Local
              for ($interestingIntIndex = 0; // VIOLATION - For
                   $interestingIntIndex < 10;
                   $interestingIntIndex++ ) {
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#longvariable

      Avoid variables with short names like $fr. Configured minimum length is 3.
      Open

              $fr = new Language('fr');

      ShortVariable

      Since: 0.2

      Detects when a field, local, or parameter has a very short name.

      Example

      class Something {
          private $q = 15; // VIOLATION - Field
          public static function main( array $as ) { // VIOLATION - Formal
              $r = 20 + $this->q; // VIOLATION - Local
              for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                  $r += $this->q;
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#shortvariable

      Avoid variables with short names like $nl. Configured minimum length is 3.
      Open

              $nl = new Language('nl');

      ShortVariable

      Since: 0.2

      Detects when a field, local, or parameter has a very short name.

      Example

      class Something {
          private $q = 15; // VIOLATION - Field
          public static function main( array $as ) { // VIOLATION - Formal
              $r = 20 + $this->q; // VIOLATION - Local
              for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                  $r += $this->q;
              }
          }
      }

      Source https://phpmd.org/rules/naming.html#shortvariable

      Line exceeds 120 characters; contains 138 characters
      Open

              $companyPassedUniqueParticipantPercentage = $this->dashboardService->uniquePassedParticipantsPercentages($activeCompany->getId());

      Line exceeds 120 characters; contains 123 characters
      Open

              $companyPassedUniqueParticipantCounts = $this->dashboardService->uniquePassedParticipants($activeCompany->getId());

      There are no issues that match your filters.

      Category
      Status