GemsTracker/gemstracker-library

View on GitHub
classes/Gems/Tracker/Token/TokenLibrary.php

Summary

Maintainability
B
5 hrs
Test Coverage
C
73%

Function checkRegistryRequestsAnswers has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

    public function checkRegistryRequestsAnswers()
    {
        if (isset($this->project->tokens['chars'])) {
            $this->tokenChars = $this->project->tokens['chars'];
        } else {
Severity: Minor
Found in classes/Gems/Tracker/Token/TokenLibrary.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

Method checkRegistryRequestsAnswers has 36 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function checkRegistryRequestsAnswers()
    {
        if (isset($this->project->tokens['chars'])) {
            $this->tokenChars = $this->project->tokens['chars'];
        } else {
Severity: Minor
Found in classes/Gems/Tracker/Token/TokenLibrary.php - About 1 hr to fix

    Function filter has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

        public function filter($token)
        {
            // Apply replacements
            if ($this->tokenFrom) {
                $token = strtr($token, $this->tokenFrom, $this->tokenTo);
    Severity: Minor
    Found in classes/Gems/Tracker/Token/TokenLibrary.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

    Method filter has 30 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function filter($token)
        {
            // Apply replacements
            if ($this->tokenFrom) {
                $token = strtr($token, $this->tokenFrom, $this->tokenTo);
    Severity: Minor
    Found in classes/Gems/Tracker/Token/TokenLibrary.php - About 1 hr to fix

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

          protected $db;

      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

      The 'getCaseSensitive()' method which returns a boolean should be named 'is...()' or 'has...()'
      Open

          public function getCaseSensitive()
          {
              return $this->tokenCaseSensitive;
          }

      BooleanGetMethodName

      Since: 0.2

      Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.

      Example

      class Foo {
          /**
           * @return boolean
           */
          public function getFoo() {} // bad
          /**
           * @return bool
           */
          public function isFoo(); // ok
          /**
           * @return boolean
           */
          public function getFoo($bar); // ok, unless checkParameterizedMethods=true
      }

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

      There are no issues that match your filters.

      Category
      Status