growella/table-of-contents

View on GitHub

Showing 11 of 11 total issues

Method render_shortcode has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function render_shortcode( $atts ) {
    if ( ! extension_loaded( 'xml' ) ) {
        trigger_error(
            esc_html__( 'Unable to inject id attributes, as the PHP XML extension is not loaded', 'growella-table-of-contents' ),
            E_USER_NOTICE
Severity: Major
Found in includes/core.php - About 2 hrs to fix

    Avoid excessively long variable names like $libxml_use_internal_errors. Keep variable name length under 20.
    Open

        $libxml_use_internal_errors = libxml_use_internal_errors( true );
    Severity: Minor
    Found in includes/core.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

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

    Avoid excessively long variable names like $libxml_has_existing_errors. Keep variable name length under 20.
    Open

        $libxml_has_existing_errors = $libxml_use_internal_errors ? ! empty( libxml_get_errors() ) : false;
    Severity: Minor
    Found in includes/core.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
        protected $reallyLongIntName = -3; // VIOLATION - Field
        public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
            $otherReallyLongName = -5; // VIOLATION - Local
            for ($interestingIntIndex = 0; // VIOLATION - For
                 $interestingIntIndex < 10;
                 $interestingIntIndex++ ) {
            }
        }
    }

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

    Function inject_heading_ids has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

    function inject_heading_ids( $content, $args = array() ) {
        $args = wp_parse_args( $args, array(
            'tags' => 'h1,h2,h3,h4,h5,h6',
        ) );
    
    
    Severity: Minor
    Found in includes/headings.php - About 55 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 render_shortcode has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    function render_shortcode( $atts ) {
        if ( ! extension_loaded( 'xml' ) ) {
            trigger_error(
                esc_html__( 'Unable to inject id attributes, as the PHP XML extension is not loaded', 'growella-table-of-contents' ),
                E_USER_NOTICE
    Severity: Minor
    Found in includes/core.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

    Missing class import via use statement (line '80', column '15').
    Open

        $xpath = new \DOMXpath( $doc );
    Severity: Minor
    Found in includes/core.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 '76', column '18').
    Open

        $doc      = new \DOMDocument;
    Severity: Minor
    Found in includes/core.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 '66', column '13').
    Open

        $dom = new \DOMDocument;
    Severity: Minor
    Found in includes/headings.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 function render_shortcode() has an NPath complexity of 512. The configured NPath complexity threshold is 200.
    Open

    function render_shortcode( $atts ) {
        if ( ! extension_loaded( 'xml' ) ) {
            trigger_error(
                esc_html__( 'Unable to inject id attributes, as the PHP XML extension is not loaded', 'growella-table-of-contents' ),
                E_USER_NOTICE
    Severity: Minor
    Found in includes/core.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 function render_shortcode() has 108 lines of code. Current threshold is set to 100. Avoid really long methods.
    Open

    function render_shortcode( $atts ) {
        if ( ! extension_loaded( 'xml' ) ) {
            trigger_error(
                esc_html__( 'Unable to inject id attributes, as the PHP XML extension is not loaded', 'growella-table-of-contents' ),
                E_USER_NOTICE
    Severity: Minor
    Found in includes/core.php by phpmd

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

    function render_shortcode( $atts ) {
        if ( ! extension_loaded( 'xml' ) ) {
            trigger_error(
                esc_html__( 'Unable to inject id attributes, as the PHP XML extension is not loaded', 'growella-table-of-contents' ),
                E_USER_NOTICE
    Severity: Minor
    Found in includes/core.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

    Severity
    Category
    Status
    Source
    Language