qcubed/framework

View on GitHub
includes/framework/QCache.class.php

Summary

Maintainability
B
4 hrs
Test Coverage

Function ClearNamespace has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

        public static function ClearNamespace($strNamespace) { 
            $strNamespace = trim(strtolower($strNamespace));
            $strCachePath = strtolower(QCache::$CachePath) . "/";
            
            if (substr_count($strNamespace, $strCachePath) == 0) {
Severity: Minor
Found in includes/framework/QCache.class.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

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

        public function GetData() {
            // First, ensure that the cache file exits
            if (file_exists($this->GetFilePath())) {
                if (count($this->strCheckFilesArray)) {
                    // Now, get the current hash of the checkfiles
Severity: Minor
Found in includes/framework/QCache.class.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 ClearNamespace has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        public static function ClearNamespace($strNamespace) { 
            $strNamespace = trim(strtolower($strNamespace));
            $strCachePath = strtolower(QCache::$CachePath) . "/";
            
            if (substr_count($strNamespace, $strCachePath) == 0) {
Severity: Minor
Found in includes/framework/QCache.class.php - About 1 hr to fix

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

            public static function ClearNamespace($strNamespace) { 
                $strNamespace = trim(strtolower($strNamespace));
                $strCachePath = strtolower(QCache::$CachePath) . "/";
                
                if (substr_count($strNamespace, $strCachePath) == 0) {
    Severity: Minor
    Found in includes/framework/QCache.class.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 method ClearNamespace uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                        } else {
                            if(false === self::ClearNamespace($strDir.'/'.$filename)) {
                                return false;
                            }
                            rmdir($strDir.'/'.$filename);
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though 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 https://phpmd.org/rules/cleancode.html#elseexpression

    The method ClearNamespace uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                    $strDir = $strNamespace;
                }
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though 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 https://phpmd.org/rules/cleancode.html#elseexpression

    The method GetFilePath is not named in camelCase.
    Open

            public function GetFilePath() {
                return sprintf('%s/%s/%s.%s', QCache::$CachePath, $this->strNamespace, $this->strKey, $this->strExtension);
            }
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method DeleteData is not named in camelCase.
    Open

            public function DeleteData() {
                if (!is_dir($this->GetCacheDirectory())) {
                    return;
                }
                
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method GetData is not named in camelCase.
    Open

            public function GetData() {
                // First, ensure that the cache file exits
                if (file_exists($this->GetFilePath())) {
                    if (count($this->strCheckFilesArray)) {
                        // Now, get the current hash of the checkfiles
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method SaveData is not named in camelCase.
    Open

            public function SaveData($strData) {
                if (!is_dir($this->GetCacheDirectory())) {
                    mkdir($this->GetCacheDirectory(),0777,true);
                }
    
    
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method ClearNamespace is not named in camelCase.
    Open

            public static function ClearNamespace($strNamespace) { 
                $strNamespace = trim(strtolower($strNamespace));
                $strCachePath = strtolower(QCache::$CachePath) . "/";
                
                if (substr_count($strNamespace, $strCachePath) == 0) {
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method GetCheckFilesHash is not named in camelCase.
    Open

            protected function GetCheckFilesHash() {
                $intFoundFileCount = 0;
                $strData = '';
                foreach($this->strCheckFilesArray as $strCheckFile) {
                    if (file_exists($strCheckFile)) {
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    The method GetCacheDirectory is not named in camelCase.
    Open

            protected function GetCacheDirectory() {
                return sprintf('%s/%s', QCache::$CachePath, $this->strNamespace);
            }
    Severity: Minor
    Found in includes/framework/QCache.class.php by phpmd

    CamelCaseMethodName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name methods.

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status