mambax7/publisher

View on GitHub
class/Metagen.php

Summary

Maintainability
C
1 day
Test Coverage

The class Metagen has 12 public methods. Consider refactoring Metagen to keep number of public methods under 10.
Open

class Metagen
{
    /**
     * @var Helper
     */
Severity: Minor
Found in class/Metagen.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

File Metagen.php has 280 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace XoopsModules\Publisher;
Severity: Minor
Found in class/Metagen.php - About 2 hrs to fix

    Method generateSeoTitle has 63 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public static function generateSeoTitle($title = '', $withExt = true)
        {
            // Transformation de la chaine en minuscule
            // Codage de la chaine afin d'éviter les erreurs 500 en cas de caractères imprévus
            $title = \rawurlencode(\mb_strtolower($title));
    Severity: Major
    Found in class/Metagen.php - About 2 hrs to fix

      Method html2text has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function html2text($document)
          {
              if (empty($document)) {
                  return '';
              }
      Severity: Minor
      Found in class/Metagen.php - About 1 hr to fix

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

            public function setTitle($title)
            {
                $this->title         = $this->html2text($title);
                $this->originalTitle = $this->title;
                $titleTag            = [];
        Severity: Minor
        Found in class/Metagen.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 findMetaKeywords has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
        Open

            public function findMetaKeywords($text, $minChar)
            {
                $keywords         = [];
                $text             = $this->purifyText($text);
                $text             = $this->html2text($text);
        Severity: Minor
        Found in class/Metagen.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

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

            public function setTitle($title)
            {
                $this->title         = $this->html2text($title);
                $this->originalTitle = $this->title;
                $titleTag            = [];
        Severity: Minor
        Found in class/Metagen.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 purifyText has a boolean flag argument $keyword, which is a certain sign of a Single Responsibility Principle violation.
        Open

            public function purifyText($text, $keyword = false)
        Severity: Minor
        Found in class/Metagen.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

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

            public static function generateSeoTitle($title = '', $withExt = true)
        Severity: Minor
        Found in class/Metagen.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

        Avoid using static access to class '\MyTextSanitizer' in method '__construct'.
        Open

                $this->myts   = \MyTextSanitizer::getInstance();
        Severity: Minor
        Found in class/Metagen.php by phpmd

        StaticAccess

        Since: 1.4.0

        Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

        Example

        class Foo
        {
            public function bar()
            {
                Bar::baz();
            }
        }

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

        Avoid using static access to class 'XoopsModules\Publisher\Helper' in method '__construct'.
        Open

                $this->helper = Helper::getInstance();
        Severity: Minor
        Found in class/Metagen.php by phpmd

        StaticAccess

        Since: 1.4.0

        Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

        Example

        class Foo
        {
            public function bar()
            {
                Bar::baz();
            }
        }

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

        Avoid unused parameters such as '$maxWords'.
        Open

            public function createMetaDescription($maxWords = 30)
        Severity: Minor
        Found in class/Metagen.php by phpmd

        UnusedFormalParameter

        Since: 0.2

        Avoid passing parameters to methods or constructors and then not using those parameters.

        Example

        class Foo
        {
            private function bar($howdy)
            {
                // $howdy is not used
            }
        }

        Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

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

                $pattern = [
                    '/%09/', // Tab
                    '/%20/', // Space
                    '/%21/', // !
                    '/%22/', // "
        Severity: Major
        Found in class/Metagen.php and 3 other locations - About 35 mins to fix
        class/Metagen.php on lines 309..309
        class/Seo.php on lines 55..84
        class/Seo.php on lines 85..85

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

        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 4 locations. Consider refactoring.
        Open

                $repPat  = ['-', '-', '-', '-', '-', '-100', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-', '-at-', '-', '-', '-', '-', '-', '-', '-', '-', '-'];
        Severity: Major
        Found in class/Metagen.php and 3 other locations - About 35 mins to fix
        class/Metagen.php on lines 279..308
        class/Seo.php on lines 55..84
        class/Seo.php on lines 85..85

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

        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

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

                $i           = 1;
        Severity: Minor
        Found in class/Metagen.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

        A file should declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it should execute logic with side effects, but should not do both. The first symbol is defined on line 30 and the first side effect is on line 25.
        Open

        <?php
        Severity: Minor
        Found in class/Metagen.php by phpcodesniffer

        Line indented incorrectly; expected 8 spaces, found 12
        Open

                    },
        Severity: Minor
        Found in class/Metagen.php by phpcodesniffer

        Line indented incorrectly; expected 8 spaces, found 12
        Open

                    static function ($matches) {
        Severity: Minor
        Found in class/Metagen.php by phpcodesniffer

        There are no issues that match your filters.

        Category
        Status