martin-helmich/typo3-typoscript-parser

View on GitHub
src/Tokenizer/Tokenizer.php

Summary

Maintainability
C
1 day
Test Coverage
A
99%

Function tokenizeString has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

    public function tokenizeString(string $inputString): array
    {
        $inputString = $this->preprocessor->preprocess($inputString);

        $tokens = new TokenStreamBuilder();
Severity: Minor
Found in src/Tokenizer/Tokenizer.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

File Tokenizer.php has 258 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Helmich\TypoScriptParser\Tokenizer;
Severity: Minor
Found in src/Tokenizer/Tokenizer.php - About 2 hrs to fix

    Method tokenizeBinaryObjectOperation has 49 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        private function tokenizeBinaryObjectOperation(TokenStreamBuilder $tokens, array $matches, int $currentLine): void
        {
            $tokens->append(
                $this->getTokenTypeForBinaryOperator($matches[3]),
                $matches[3],
    Severity: Minor
    Found in src/Tokenizer/Tokenizer.php - About 1 hr to fix

      Method tokenizeString has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function tokenizeString(string $inputString): array
          {
              $inputString = $this->preprocessor->preprocess($inputString);
      
              $tokens = new TokenStreamBuilder();
      Severity: Minor
      Found in src/Tokenizer/Tokenizer.php - About 1 hr to fix

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

            private function tokenizeBinaryObjectOperation(TokenStreamBuilder $tokens, array $matches, int $currentLine): void
            {
                $tokens->append(
                    $this->getTokenTypeForBinaryOperator($matches[3]),
                    $matches[3],
        Severity: Minor
        Found in src/Tokenizer/Tokenizer.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

        Function tokenizeObjectOperation has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            private function tokenizeObjectOperation(
                TokenStreamBuilder $tokens,
                MultilineTokenBuilder $state,
                ScannerLine $line
            ): bool {
        Severity: Minor
        Found in src/Tokenizer/Tokenizer.php - About 35 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

        Avoid too many return statements within this method.
        Open

                        return TokenInterface::TYPE_OPERATOR_DELETE;
        Severity: Major
        Found in src/Tokenizer/Tokenizer.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                      return;
          Severity: Major
          Found in src/Tokenizer/Tokenizer.php - About 30 mins to fix

            The method tokenizeString() has an NPath complexity of 258. The configured NPath complexity threshold is 200.
            Open

                public function tokenizeString(string $inputString): array
                {
                    $inputString = $this->preprocessor->preprocess($inputString);
            
                    $tokens = new TokenStreamBuilder();
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.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

            The method tokenizeBinaryObjectOperation() has an NPath complexity of 288. The configured NPath complexity threshold is 200.
            Open

                private function tokenizeBinaryObjectOperation(TokenStreamBuilder $tokens, array $matches, int $currentLine): void
                {
                    $tokens->append(
                        $this->getTokenTypeForBinaryOperator($matches[3]),
                        $matches[3],
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.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

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

                public function tokenizeString(string $inputString): array
                {
                    $inputString = $this->preprocessor->preprocess($inputString);
            
                    $tokens = new TokenStreamBuilder();
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.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 tokenizeBinaryObjectOperation() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
            Open

                private function tokenizeBinaryObjectOperation(TokenStreamBuilder $tokens, array $matches, int $currentLine): void
                {
                    $tokens->append(
                        $this->getTokenTypeForBinaryOperator($matches[3]),
                        $matches[3],
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.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 class Tokenizer has a coupling between objects value of 13. Consider to reduce the number of dependencies under 13.
            Open

            class Tokenizer implements TokenizerInterface
            {
                const OBJECT_ACCESSOR = '((?:\.)|(?:[a-zA-Z0-9_\-\\\\:\$\{\}/]+(?:\.[a-zA-Z0-9_\-\\\\:\$\{\}/]*)*))';
            
                const TOKEN_WHITESPACE = ',^[ \t\n]+,s';
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            CouplingBetweenObjects

            Since: 1.1.0

            A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

            Example

            class Foo {
                /**
                 * @var \foo\bar\X
                 */
                private $x = null;
            
                /**
                 * @var \foo\bar\Y
                 */
                private $y = null;
            
                /**
                 * @var \foo\bar\Z
                 */
                private $z = null;
            
                public function setFoo(\Foo $foo) {}
                public function setBar(\Bar $bar) {}
                public function setBaz(\Baz $baz) {}
            
                /**
                 * @return \SplObjectStorage
                 * @throws \OutOfRangeException
                 * @throws \InvalidArgumentException
                 * @throws \ErrorException
                 */
                public function process(\Iterator $it) {}
            
                // ...
            }

            Source https://phpmd.org/rules/design.html#couplingbetweenobjects

            Missing class import via use statement (line '150', column '23').
            Open

                        throw new \InvalidArgumentException("could not open file '$inputStream'");
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            MissingImport

            Since: 2.7.0

            Importing all external classes in a file through use statements makes them clearly visible.

            Example

            function make() {
                return new \stdClass();
            }

            Source http://phpmd.org/rules/cleancode.html#MissingImport

            Avoid assigning values to variables in if clauses and the like (line '345', column '14').
            Open

                private function tokenizeObjectOperation(
                    TokenStreamBuilder $tokens,
                    MultilineTokenBuilder $state,
                    ScannerLine $line
                ): bool {
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            IfStatementAssignment

            Since: 2.7.0

            Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

            Example

            class Foo
            {
                public function bar($flag)
                {
                    if ($foo = 'bar') { // possible typo
                        // ...
                    }
                    if ($baz = 0) { // always false
                        // ...
                    }
                }
            }

            Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

            Avoid assigning values to variables in if clauses and the like (line '325', column '18').
            Open

                private function tokenizeSimpleStatements(TokenStreamBuilder $tokens, ScannerLine $line): bool
                {
                    $simpleTokens = [
                        self::TOKEN_COMMENT_ONELINE       => TokenInterface::TYPE_COMMENT_ONELINE,
                        self::TOKEN_NESTING_END           => TokenInterface::TYPE_BRACE_CLOSE,
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            IfStatementAssignment

            Since: 2.7.0

            Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

            Example

            class Foo
            {
                public function bar($flag)
                {
                    if ($foo = 'bar') { // possible typo
                        // ...
                    }
                    if ($baz = 0) { // always false
                        // ...
                    }
                }
            }

            Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

            Avoid assigning values to variables in if clauses and the like (line '275', column '14').
            Open

                private function tokenizeMultilineComment(
                    TokenStreamBuilder $tokens,
                    MultilineTokenBuilder $state,
                    ScannerLine $line
                ): void {
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            IfStatementAssignment

            Since: 2.7.0

            Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

            Example

            class Foo
            {
                public function bar($flag)
                {
                    if ($foo = 'bar') { // possible typo
                        // ...
                    }
                    if ($baz = 0) { // always false
                        // ...
                    }
                }
            }

            Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

            Avoid assigning values to variables in if clauses and the like (line '279', column '14').
            Open

                private function tokenizeMultilineComment(
                    TokenStreamBuilder $tokens,
                    MultilineTokenBuilder $state,
                    ScannerLine $line
                ): void {
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            IfStatementAssignment

            Since: 2.7.0

            Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

            Example

            class Foo
            {
                public function bar($flag)
                {
                    if ($foo = 'bar') { // possible typo
                        // ...
                    }
                    if ($baz = 0) { // always false
                        // ...
                    }
                }
            }

            Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

            Avoid assigning values to variables in if clauses and the like (line '108', column '18').
            Open

                public function tokenizeString(string $inputString): array
                {
                    $inputString = $this->preprocessor->preprocess($inputString);
            
                    $tokens = new TokenStreamBuilder();
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpmd

            IfStatementAssignment

            Since: 2.7.0

            Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

            Example

            class Foo
            {
                public function bar($flag)
                {
                    if ($foo = 'bar') { // possible typo
                        // ...
                    }
                    if ($baz = 0) { // always false
                        // ...
                    }
                }
            }

            Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

            Expected 0 spaces after opening bracket; newline found
            Open

                        if (
            Severity: Minor
            Found in src/Tokenizer/Tokenizer.php by phpcodesniffer

            There are no issues that match your filters.

            Category
            Status