Sign upLogin

mrcnpdlk/unoconv-api

View on GitHub
Star

Showing 56 of 57 total issues

Method wsGetPdf has 50 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function wsGetPdf(string $sourceFile, ?string $destination): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
Severity: Minor
Found in src/Api.php - About 2 hrs to fix

    Method transcode has 48 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function transcode(string $sourceFile, ?FormatType $format, ?string $destination, array $exportOpts = []): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
    Severity: Minor
    Found in src/Api.php - About 1 hr to fix

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

          public function wsGetPdf(string $sourceFile, ?string $destination): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
      Severity: Minor
      Found in src/Api.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

      Function transcode has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          public function transcode(string $sourceFile, ?FormatType $format, ?string $destination, array $exportOpts = []): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
      Severity: Minor
      Found in src/Api.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

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

          private $ws;
      Severity: Minor
      Found in src/Api.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

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

              $ch = curl_init();
      Severity: Minor
      Found in src/Api.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

      The method getExtension() has 104 lines of code. Current threshold is set to 100. Avoid really long methods.
      Open

          public function getExtension(): string
    {
        $tMap = [
            self::BIB       => 'bib',
            self::DOC       => 'doc',
      Severity: Minor
      Found in src/Enum/FormatType.php by phpmd

      The method wsGetPdf() has an NPath complexity of 216. The configured NPath complexity threshold is 200.
      Open

          public function wsGetPdf(string $sourceFile, ?string $destination): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
      Severity: Minor
      Found in src/Api.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

      Constant Changes should be defined in uppercase
      Open

          public const Changes                               = 'Changes';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant ExportNotes should be defined in uppercase
      Open

          public const ExportNotes                           = 'ExportNotes';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant CenterWindow should be defined in uppercase
      Open

          public const CenterWindow                          = 'CenterWindow';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant Printing should be defined in uppercase
      Open

          public const Printing                              = 'Printing';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant DocumentOpenPassword should be defined in uppercase
      Open

          public const DocumentOpenPassword                  = 'DocumentOpenPassword';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant Quality should be defined in uppercase
      Open

          public const Quality                               = 'Quality';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

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

          public function transcode(string $sourceFile, ?FormatType $format, ?string $destination, array $exportOpts = []): SplFileObject
    {
        $sourceFile = realpath($sourceFile);

        if (!is_file($sourceFile)) {
      Severity: Minor
      Found in src/Api.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

      Constant EmbedStandardFonts should be defined in uppercase
      Open

          public const EmbedStandardFonts                    = 'EmbedStandardFonts';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant ExportBookmarksToPDFDestination should be defined in uppercase
      Open

          public const ExportBookmarksToPDFDestination       = 'ExportBookmarksToPDFDestination';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant OpenBookmarkLevels should be defined in uppercase
      Open

          public const OpenBookmarkLevels                    = 'OpenBookmarkLevels';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant PDFViewSelection should be defined in uppercase
      Open

          public const PDFViewSelection                      = 'PDFViewSelection';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Constant EnableCopyingOfContent should be defined in uppercase
      Open

          public const EnableCopyingOfContent                = 'EnableCopyingOfContent';
      Severity: Minor
      Found in src/Enum/ExportType.php by phpmd

      ConstantNamingConventions

      Since: 0.2

      Class/Interface constant names should always be defined in uppercase.

      Example

      class Foo {
    const MY_NUM = 0; // ok
    const myTest = ""; // fail
}

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

      Severity
      Category
      Status
      Source
      Language