Sign upLogin

iranianpep/php-table-generator

View on GitHub
Star

Showing 16 of 16 total issues

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

    public function addRow(Row $row, $index = -1)
    {
        try {
            if (!is_numeric($index)) {
                throw new TableException('index in addRow() must be numeric');
Severity: Major
Found in src/PhpTableGenerator/Body.php and 1 other location - About 3 hrs to fix
src/PhpTableGenerator/Row.php on lines 48..73

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 145.

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

    public function addCell(Cell $cell, $index = -1)
    {
        try {
            if (!is_numeric($index)) {
                throw new TableException('index in addCell() must be numeric');
Severity: Major
Found in src/PhpTableGenerator/Row.php and 1 other location - About 3 hrs to fix
src/PhpTableGenerator/Body.php on lines 48..73

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 145.

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

<?php
/**
 * Contains Head class.
 */
Severity: Major
Found in src/PhpTableGenerator/Head.php and 1 other location - About 3 hrs to fix
src/PhpTableGenerator/Footer.php on lines 1..67

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 143.

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

<?php
/**
 * Contains Footer class.
 */
Severity: Major
Found in src/PhpTableGenerator/Footer.php and 1 other location - About 3 hrs to fix
src/PhpTableGenerator/Head.php on lines 1..67

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 143.

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

HeadCell has 22 functions (exceeds 20 allowed). Consider refactoring.
Open

class HeadCell extends Cell
{
    /**
     * head cell title.
     *
Severity: Minor
Found in src/PhpTableGenerator/HeadCell.php - About 2 hrs to fix

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

        public function __construct($class = '', $id = '', $style = '')
    Severity: Minor
    Found in src/PhpTableGenerator/TableGenerator.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 $id. Configured minimum length is 3.
    Open

        public $id;
    Severity: Minor
    Found in src/PhpTableGenerator/TableGenerator.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

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

        public function getAttributeHtml($attribute)
    {
        if (empty($this->$attribute)) {
            return '';
        }
    Severity: Minor
    Found in src/PhpTableGenerator/TableGenerator.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

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

        public function getHtml()
    {
        $attributesHtml = $this->getAllAttributesHtml();

        $html = "<tr{$attributesHtml}>";
    Severity: Minor
    Found in src/PhpTableGenerator/Row.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

    The method __construct has a boolean flag argument $htmlspecialchars, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function __construct($title = null, $alias = null, $content = null, $htmlspecialchars = false)
    Severity: Minor
    Found in src/PhpTableGenerator/HeadCell.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

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

                throw new \Exception("'{$searchPattern}' is not a valid search pattern");
    Severity: Minor
    Found in src/PhpTableGenerator/HeadCell.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

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

                throw new \Exception("config: {$key} does not exist");
    Severity: Minor
    Found in src/PhpTableGenerator/TableGeneratorConfig.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

    The method __construct has a boolean flag argument $htmlspecialchars, which is a certain sign of a Single Responsibility Principle violation.
    Open

        public function __construct($content = '', $htmlspecialchars = false)
    Severity: Minor
    Found in src/PhpTableGenerator/Cell.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

    Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

    Function getHtml has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getHtml()
    {
        $attributesHtml = $this->getAllAttributesHtml();

        $html = "<table{$attributesHtml}>";
    Severity: Minor
    Found in src/PhpTableGenerator/Table.php - About 25 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 addCell uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                // insert the item in
                array_splice($cells, $index, 0, [$cell]);
            }
    Severity: Minor
    Found in src/PhpTableGenerator/Row.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 addRow uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

                } else {
                // insert the item in
                array_splice($rows, $index, 0, [$row]);
            }
    Severity: Minor
    Found in src/PhpTableGenerator/Body.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

    Severity
    Category
    Status
    Source
    Language