GemsTracker/gemstracker-library

View on GitHub
classes/Gems/Util/SiteUtil.php

Summary

Maintainability
C
1 day
Test Coverage
F
46%

isRequestFromAllowedHost accesses the super-global variable $_SERVER.
Open

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Minor
Found in classes/Gems/Util/SiteUtil.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

isRequestFromAllowedHost accesses the super-global variable $_SERVER.
Open

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Minor
Found in classes/Gems/Util/SiteUtil.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

isRequestFromAllowedHost accesses the super-global variable $_SERVER.
Open

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Minor
Found in classes/Gems/Util/SiteUtil.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

isRequestFromAllowedHost accesses the super-global variable $_SERVER.
Open

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Minor
Found in classes/Gems/Util/SiteUtil.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

Function isRequestFromAllowedHost has a Cognitive Complexity of 41 (exceeds 5 allowed). Consider refactoring.
Open

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Minor
Found in classes/Gems/Util/SiteUtil.php - About 6 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

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

    public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
    {
        if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
            return null;
        }
Severity: Major
Found in classes/Gems/Util/SiteUtil.php - About 2 hrs to fix

    Avoid too many return statements within this method.
    Open

                                return \MUtil_String::beforeChars($referrer, '?&<>=');
    Severity: Major
    Found in classes/Gems/Util/SiteUtil.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

              return null;
      Severity: Major
      Found in classes/Gems/Util/SiteUtil.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                                return $site->getUrl();
        Severity: Major
        Found in classes/Gems/Util/SiteUtil.php - About 30 mins to fix

          The method isRequestFromAllowedHost() has an NPath complexity of 10416. The configured NPath complexity threshold is 200.
          Open

              public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
              {
                  if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
                      return null;
                  }
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.php by phpmd

          NPathComplexity

          Since: 0.1

          The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

          Example

          class Foo {
              function bar() {
                  // lots of complicated code
              }
          }

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

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

              public function isRequestFromAllowedHost(\Zend_Controller_Request_Abstract $request)
              {
                  if (\MUtil_Console::isConsole() || \Zend_Session::$_unitTestEnabled) {
                      return null;
                  }
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.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

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

          class SiteUtil extends UtilAbstract
          {
              CONST ORG_SEPARATOR = '|';
          
              /**
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.php by phpmd

          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

          Avoid unused local variables such as '$id'.
          Open

                      $id = self::ORG_SEPARATOR . intval($orgId) . self::ORG_SEPARATOR;
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.php by phpmd

          UnusedLocalVariable

          Since: 0.2

          Detects when a local variable is declared and/or assigned, but not used.

          Example

          class Foo {
              public function doSomething()
              {
                  $i = 5; // Unused
              }
          }

          Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

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

                  $existingOrganizations = array_keys($this->util->getDbLookup()->getOrganizations());
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.php by phpmd

          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 $id. Configured minimum length is 3.
          Open

                      $id = self::ORG_SEPARATOR . intval($orgId) . self::ORG_SEPARATOR;
          Severity: Minor
          Found in classes/Gems/Util/SiteUtil.php by phpmd

          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

          There are no issues that match your filters.

          Category
          Status