beardcoder/sitemap_generator

View on GitHub
Classes/Domain/Repository/SitemapRepository.php

Summary

Maintainability
D
2 days
Test Coverage

Function mapToEntries has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
Open

    protected function mapToEntries(array $typoScriptUrlEntry)
    {
        if ($typoScriptUrlEntry['table'] && $typoScriptUrlEntry['active'] == 1) {
            $records = $this->getRecordsFromDatabase($typoScriptUrlEntry);
            if ($this->getDatabaseConnection()->sql_num_rows($records)) {
Severity: Minor
Found in Classes/Domain/Repository/SitemapRepository.php - About 3 hrs 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

File SitemapRepository.php has 316 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php
namespace Markussom\SitemapGenerator\Domain\Repository;

/**
 * This file is part of the TYPO3 CMS project.
Severity: Minor
Found in Classes/Domain/Repository/SitemapRepository.php - About 3 hrs to fix

    The class SitemapRepository has an overall complexity of 68 which is very high. The configured complexity threshold is 50.
    Open

    class SitemapRepository
    {
        /**
         * @var FieldValueService
         */

    Since: PHPMD 0.2.5

    The Weighted Method Count (WMC) of a class is a good indicator of how much time and effort is required to modify and maintain this class. The WMC metric is defined as the sum of complexities of all methods declared in a class. A large number of methods also means that this class has a greater potential impact on derived classes.

    Example:

    class Foo {
          public function bar() {
              if ($a == $b)  {
                  if ($a1 == $b1) {
                      fiddle();
                  } elseif ($a2 == $b2) {
                      fiddle();
                  } else {
                  }
              }
          }
          public function baz() {
              if ($a == $b) {
                  if ($a1 == $b1) {
                      fiddle();
                  } elseif ($a2 == $b2) {
                      fiddle();
                  } else {
                  }
              }
          }
          // Several other complex methods
      }

    Source: http://phpmd.org/rules/codesize.txt

    Function mapGoogleNewsEntries has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function mapGoogleNewsEntries(array $typoScriptUrlEntry)
        {
            $records = $this->getRecordsFromDatabase($typoScriptUrlEntry);
            $urlEntries = [];
            if ($this->getDatabaseConnection()->sql_num_rows($records)) {
    Severity: Minor
    Found in Classes/Domain/Repository/SitemapRepository.php - About 2 hrs 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

    SitemapRepository has 22 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class SitemapRepository
    {
        /**
         * @var FieldValueService
         */
    Severity: Minor
    Found in Classes/Domain/Repository/SitemapRepository.php - About 2 hrs to fix

      Method mapToEntries has 38 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          protected function mapToEntries(array $typoScriptUrlEntry)
          {
              if ($typoScriptUrlEntry['table'] && $typoScriptUrlEntry['active'] == 1) {
                  $records = $this->getRecordsFromDatabase($typoScriptUrlEntry);
                  if ($this->getDatabaseConnection()->sql_num_rows($records)) {
      Severity: Minor
      Found in Classes/Domain/Repository/SitemapRepository.php - About 1 hr to fix

        Method mapGoogleNewsEntries has 33 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            protected function mapGoogleNewsEntries(array $typoScriptUrlEntry)
            {
                $records = $this->getRecordsFromDatabase($typoScriptUrlEntry);
                $urlEntries = [];
                if ($this->getDatabaseConnection()->sql_num_rows($records)) {
        Severity: Minor
        Found in Classes/Domain/Repository/SitemapRepository.php - About 1 hr to fix

          Method getRecordsFromDatabase has 26 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              private function getRecordsFromDatabase($typoScriptUrlEntry)
              {
                  if (!isset($GLOBALS['TCA'][$typoScriptUrlEntry['table']])
                      || !is_array($GLOBALS['TCA'][$typoScriptUrlEntry['table']]['ctrl'])
                  ) {
          Severity: Minor
          Found in Classes/Domain/Repository/SitemapRepository.php - About 1 hr to fix

            Function getEntriesFromPages has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
            Open

                public function getEntriesFromPages($pages)
                {
                    foreach ($pages as $page) {
                        if ($this->hasPageAnAllowedDoktype($page)) {
                            $urlEntry = GeneralUtility::makeInstance(UrlEntry::class);
            Severity: Minor
            Found in Classes/Domain/Repository/SitemapRepository.php - About 55 mins 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

            Avoid deeply nested control flow statements.
            Open

                                    if (isset($typoScriptUrlEntry['changefreq'])) {
                                        $urlEntry->setChangefreq(
                                            $this->fieldValueService->getFieldValue('changefreq', $typoScriptUrlEntry, $row)
                                        );
                                    }
            Severity: Major
            Found in Classes/Domain/Repository/SitemapRepository.php - About 45 mins to fix

              Avoid deeply nested control flow statements.
              Open

                                      if (isset($typoScriptUrlEntry['lastmod'])) {
                                          $urlEntry->setLastmod(
                                              date(
                                                  'Y-m-d',
                                                  $this->fieldValueService->getFieldValue('lastmod', $typoScriptUrlEntry, $row)
              Severity: Major
              Found in Classes/Domain/Repository/SitemapRepository.php - About 45 mins to fix

                Avoid deeply nested control flow statements.
                Open

                                        if (isset($typoScriptUrlEntry['priority'])) {
                                            $urlEntry->setPriority(
                                                number_format(
                                                    $this->fieldValueService->getFieldValue('priority', $typoScriptUrlEntry, $row) / 10,
                                                    1,
                Severity: Major
                Found in Classes/Domain/Repository/SitemapRepository.php - About 45 mins to fix

                  Function hidePagesIfNotTranslated has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                  Open

                      private function hidePagesIfNotTranslated($pages)
                      {
                          $language = GeneralUtility::_GET('L');
                          if ($this->isPageNotTranslated($language)) {
                              foreach ($pages as $key => $page) {
                  Severity: Minor
                  Found in Classes/Domain/Repository/SitemapRepository.php - About 25 mins 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 class SitemapRepository has a coupling between objects value of 19. Consider to reduce the number of dependencies under 13.
                  Open

                  class SitemapRepository
                  {
                      /**
                       * @var FieldValueService
                       */

                  Since: PHPMD 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: http://phpmd.org/rules/design.txt

                  The method getPages uses an else expression. Else is never necessary and you can simplify the code to work without else.
                  Open

                          } else {
                              $pages = $this->getSubPagesRecursive($rootPageId);
                              $this->cacheInstance->set($cacheIdentifier, $pages, ['pagesForSitemap']);
                          }

                  Since: PHPMD 1.4.0

                  An if expression with an else branch is never necessary. You can rewrite the conditions in a way that the else is not necessary and the code becomes simpler to read. To achieve this use early return statements. To achieve this you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

                  Example:

                  class Foo
                    {
                        public function bar($flag)
                        {
                            if ($flag) {
                                // one branch
                            } else {
                                // another branch
                            }
                        }
                    }

                  Source: http://phpmd.org/rules/cleancode.txt

                  Line exceeds 120 characters; contains 127 characters
                  Open

                          return $record['sys_language_uid'] !== '-1' && (int)$language !== 0 && (int)$recordConfig['hideIfNotTranslated'] === 1;

                  There are no issues that match your filters.

                  Category
                  Status