ampache/ampache

View on GitHub
src/Module/Util/ZipHandler.php

Summary

Maintainability
A
1 hr
Test Coverage

Function zip has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public function zip(string $name, array $media_files, bool $flat_path): void
    {
        $art      = $this->configContainer->get(ConfigurationKeyEnum::ALBUM_ART_PREFERRED_FILENAME);
        $addart   = $this->configContainer->isFeatureEnabled(ConfigurationKeyEnum::ART_ZIP_ADD);
        $filter   = preg_replace('/[^a-zA-Z0-9. -]/', '', $name);
Severity: Minor
Found in src/Module/Util/ZipHandler.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

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

    public function zip(string $name, array $media_files, bool $flat_path): void
    {
        $art      = $this->configContainer->get(ConfigurationKeyEnum::ALBUM_ART_PREFERRED_FILENAME);
        $addart   = $this->configContainer->isFeatureEnabled(ConfigurationKeyEnum::ART_ZIP_ADD);
        $filter   = preg_replace('/[^a-zA-Z0-9. -]/', '', $name);
Severity: Minor
Found in src/Module/Util/ZipHandler.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

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

        foreach ($media_files as $dir => $files) {
Severity: Minor
Found in src/Module/Util/ZipHandler.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

syntax error, unexpected 'ConfigContainerInterface' (T_STRING), expecting function (T_FUNCTION) or const (T_CONST)
Open

    private ConfigContainerInterface $configContainer;
Severity: Critical
Found in src/Module/Util/ZipHandler.php by phan

The parameter $object_type is not named in camelCase.
Open

    public function isZipable(string $object_type): bool
    {
        return in_array(
            $object_type,
            $this->configContainer->getTypesAllowedForZip()
Severity: Minor
Found in src/Module/Util/ZipHandler.php by phpmd

CamelCaseParameterName

Since: 0.2

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

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $media_files is not named in camelCase.
Open

    public function zip(string $name, array $media_files, bool $flat_path): void
    {
        $art      = $this->configContainer->get(ConfigurationKeyEnum::ALBUM_ART_PREFERRED_FILENAME);
        $addart   = $this->configContainer->isFeatureEnabled(ConfigurationKeyEnum::ART_ZIP_ADD);
        $filter   = preg_replace('/[^a-zA-Z0-9. -]/', '', $name);
Severity: Minor
Found in src/Module/Util/ZipHandler.php by phpmd

CamelCaseParameterName

Since: 0.2

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

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

The parameter $flat_path is not named in camelCase.
Open

    public function zip(string $name, array $media_files, bool $flat_path): void
    {
        $art      = $this->configContainer->get(ConfigurationKeyEnum::ALBUM_ART_PREFERRED_FILENAME);
        $addart   = $this->configContainer->isFeatureEnabled(ConfigurationKeyEnum::ART_ZIP_ADD);
        $filter   = preg_replace('/[^a-zA-Z0-9. -]/', '', $name);
Severity: Minor
Found in src/Module/Util/ZipHandler.php by phpmd

CamelCaseParameterName

Since: 0.2

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

Example

class ClassName {
    public function doSomething($user_name) {
    }
}

Source

There are no issues that match your filters.

Category
Status