gavinggordon/htmlentities

View on GitHub

Showing 62 of 62 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private $encodedChars = array(
        '0' => '?',
        '1' => '!',
        '2' => '@',
        '3' => '#',
Severity: Major
Found in src/HtmlEntities.php and 1 other location - About 1 wk to fix
src/HtmlEntities.php on lines 9..287

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 1392.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

    private $decodedChars = array(
        '0' => '?',
        '1' => '!',
        '2' => '@',
        '3' => '#',
Severity: Major
Found in src/HtmlEntities.php and 1 other location - About 1 wk to fix
src/HtmlEntities.php on lines 288..566

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 1392.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

File HtmlEntities.php has 690 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace GGG;

class HtmlEntities
Severity: Major
Found in src/HtmlEntities.php - About 1 day to fix

Function encode has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

    public function encode($input)
    {
        $encoded = null;
        $key = null;
        $decodedChars = $this->decodedChars;
Severity: Minor
Found in src/HtmlEntities.php - About 3 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 decode has a Cognitive Complexity of 23 (exceeds 5 allowed). Consider refactoring.
Open

    public function decode($input)
    {
        $decoded = null;
        $key = null;
        $encodedChars = $this->encodedChars;
Severity: Minor
Found in src/HtmlEntities.php - About 3 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 decode has 54 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function decode($input)
    {
        $decoded = null;
        $key = null;
        $encodedChars = $this->encodedChars;
Severity: Major
Found in src/HtmlEntities.php - About 2 hrs to fix

Method encode has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function encode($input)
    {
        $encoded = null;
        $key = null;
        $decodedChars = $this->decodedChars;
Severity: Major
Found in src/HtmlEntities.php - About 2 hrs to fix

Similar blocks of code found in 2 locations. Consider refactoring.
Open

        if (is_array($input)) 
        {
            $encoded = array();
            foreach ($input as $index => $char) 
            {
Severity: Major
Found in src/HtmlEntities.php and 1 other location - About 1 hr to fix
src/HtmlEntities.php on lines 579..595

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 110.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

        if (is_array($input)) 
        {
            $decoded = array();
            foreach ($input as $index => $char)
            {
Severity: Major
Found in src/HtmlEntities.php and 1 other location - About 1 hr to fix
src/HtmlEntities.php on lines 642..658

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 110.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

The closing brace for the class must go on the next line after the body
Open

}
Severity: Minor
Found in src/HtmlEntities.php by phpcodesniffer

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

               {
                   $encoded[$index] = $char;
               }
Severity: Minor
Found in src/HtmlEntities.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 encode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                    {
                        $encoded[$index] = $char;
                    }
Severity: Minor
Found in src/HtmlEntities.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 decode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                {
                    $decoded[$index] = $char;
                }
Severity: Minor
Found in src/HtmlEntities.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 decode uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

                    {
                        $decoded[$index] = $char;
                    }
Severity: Minor
Found in src/HtmlEntities.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 encode() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
Open

    public function encode($input)
    {
        $encoded = null;
        $key = null;
        $decodedChars = $this->decodedChars;
Severity: Minor
Found in src/HtmlEntities.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 decode() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
Open

    public function decode($input)
    {
        $decoded = null;
        $key = null;
        $encodedChars = $this->encodedChars;
Severity: Minor
Found in src/HtmlEntities.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

Whitespace found at end of line
Open

                foreach ($chars as $index => $char) 
Severity: Minor
Found in src/HtmlEntities.php by phpcodesniffer

Whitespace found at end of line
Open

                    if (in_array($char, $encodedChars)) 
Severity: Minor
Found in src/HtmlEntities.php by phpcodesniffer

Line indented incorrectly; expected at least 16 spaces, found 15
Open

               {
Severity: Minor
Found in src/HtmlEntities.php by phpcodesniffer

Whitespace found at end of line
Open

                if (in_array($char, $encodedChars)) 
Severity: Minor
Found in src/HtmlEntities.php by phpcodesniffer
Severity
Category
Status
Source
Language