PHPSocialNetwork/phpfastcache

View on GitHub
lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php

Summary

Maintainability
D
1 day
Test Coverage

Function getPath has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
Open

    public function getPath($readonly = false): string
    {
        /**
         * Get the base system temporary directory
         */
Severity: Minor
Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.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 getPath has 57 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function getPath($readonly = false): string
    {
        /**
         * Get the base system temporary directory
         */
Severity: Major
Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php - About 2 hrs to fix

    Function htaccessGen has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

        protected function htaccessGen($path, $create = true)
        {
            if ($create === true) {
                if (!\is_writable($path)) {
                    try {
    Severity: Minor
    Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.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 htaccessGen has 31 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        protected function htaccessGen($path, $create = true)
        {
            if ($create === true) {
                if (!\is_writable($path)) {
                    try {
    Severity: Minor
    Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php - About 1 hr to fix

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

          protected function writefile($file, $data, $secureFileManipulation = false): bool
          {
              /**
               * @eventName CacheWriteFileOnDisk
               * @param ExtendedCacheItemPoolInterface $this
      Severity: Minor
      Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php - About 1 hr to fix

        Avoid deeply nested control flow statements.
        Open

                                    if (@\mkdir($full_path, $this->getDefaultChmod(), true) && !\is_dir($full_path)) {
                                        throw new PhpfastcacheIOException('The directory ' . $full_path . ' could not be created.');
                                    }
        Severity: Major
        Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php - About 45 mins to fix

          Function writefile has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
          Open

              protected function writefile($file, $data, $secureFileManipulation = false): bool
              {
                  /**
                   * @eventName CacheWriteFileOnDisk
                   * @param ExtendedCacheItemPoolInterface $this
          Severity: Minor
          Found in lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php - About 45 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 method getPath() has a Cyclomatic Complexity of 27. The configured cyclomatic complexity threshold is 10.
          Open

              public function getPath($readonly = false): string
              {
                  /**
                   * Get the base system temporary directory
                   */

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

          Avoid using static access to class '\Phpfastcache\Util\Directory' in method 'writefile'.
          Open

                      $tmpFilename = Directory::getAbsolutePath(
                          dirname($file) . '/tmp_' . $this->getConfig()->getDefaultFileNameHashFunction()(
                              \str_shuffle(\uniqid($this->getDriverName(), false))
                              . \str_shuffle(\uniqid($this->getDriverName(), false))
                          )

          Since: PHPMD 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example:

          class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

          Avoid using static access to class '\Phpfastcache\Util\Directory' in method 'getStats'.
          Open

                      ->setSize(Directory::dirSize($path))

          Since: PHPMD 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example:

          class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

          Avoid using static access to class '\Phpfastcache\Util\Directory' in method 'getPath'.
          Open

                  $full_path = Directory::getAbsolutePath($path . $path_suffix);

          Since: PHPMD 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example:

          class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

          Avoid using static access to class '\Phpfastcache\Util\Directory' in method 'getPath'.
          Open

                  $full_path_tmp = Directory::getAbsolutePath($tmp_dir . $path_suffix);

          Since: PHPMD 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example:

          class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

          Avoid using static access to class '\Phpfastcache\Util\Directory' in method 'getStats'.
          Open

                      ->setInfo('Number of files used to build the cache: ' . Directory::getFileCount($path));

          Since: PHPMD 1.4.0

          Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

          Example:

          class Foo
            {
                public function bar()
                {
                    Bar::baz();
                }
            }

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

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

              protected function writefile($file, $data, $secureFileManipulation = false): bool

          Since: PHPMD 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 $argumentsList[] ) { // VIOLATION - Formal
                    $otherReallyLongName = -5; // VIOLATION - Local
                    for ($interestingIntIndex = 0; // VIOLATION - For
                         $interestingIntIndex < 10;
                         $interestingIntIndex++ ) {
                    }
                }
            }

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

          There are no issues that match your filters.

          Category
          Status