Sign upLogin

HuasoFoundries/jpgraph

View on GitHub
Star
src/text/TTF.php

Summary

Maintainability
D
1 day
Test Coverage

Method __construct has 197 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function __construct()
    {
        self::$FONT_BASEPATH = getenv('JPGRAPH_FONT_BASEPATH') ?
        getenv('JPGRAPH_FONT_BASEPATH') :
        dirname(__DIR__) . '/fonts/';
Severity: Major
Found in src/text/TTF.php - About 7 hrs to fix

    File TTF.php has 293 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    <?php

/**
 * JPGraph v4.0.3
 */
    Severity: Minor
    Found in src/text/TTF.php - About 3 hrs to fix

      Function File has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
      Open

          public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
      Severity: Minor
      Found in src/text/TTF.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

      Method File has 37 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
      Severity: Minor
      Found in src/text/TTF.php - About 1 hr to fix

        The method File() has an NPath complexity of 1160. The configured NPath complexity threshold is 200.
        Open

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.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 __construct() has 242 lines of code. Current threshold is set to 100. Avoid really long methods.
        Open

            public function __construct()
    {
        self::$FONT_BASEPATH = getenv('JPGRAPH_FONT_BASEPATH') ?
        getenv('JPGRAPH_FONT_BASEPATH') :
        dirname(__DIR__) . '/fonts/';
        Severity: Minor
        Found in src/text/TTF.php by phpmd

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

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.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

        Remove error control operator '@' on line 303.
        Open

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.php by phpmd

        ErrorControlOperator

        Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

        Example

        function foo($filePath) {
    $file = @fopen($filPath); // hides exceptions
    $key = @$array[$notExistingKey]; // assigns null to $key
}

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

        Remove error control operator '@' on line 299.
        Open

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.php by phpmd

        ErrorControlOperator

        Error suppression should be avoided if possible as it doesn't just suppress the error, that you are trying to stop, but will also suppress errors that you didn't predict would ever occur. Consider changing error_reporting() level and/or setting up your own error handler.

        Example

        function foo($filePath) {
    $file = @fopen($filPath); // hides exceptions
    $key = @$array[$notExistingKey]; // assigns null to $key
}

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

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

                    } else {
                $font_file = TTF_DIR . $font_file;
            }
        Severity: Minor
        Found in src/text/TTF.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

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

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.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 using static access to class '\Amenadiel\JpGraph\Util\JpGraphError' in method 'File'.
        Open

                    Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.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 assigning values to variables in if clauses and the like (line '329', column '17').
        Open

            public function File($family, $style = FS_NORMAL, $font_path = null)
    {
        $fam = @$this->font_files[$family];
        if (!$fam) {
            Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.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 using static access to class '\Amenadiel\JpGraph\Util\JpGraphError' in method 'File'.
        Open

                        Util\JpGraphError::RaiseL(25047, $this->style_names[$style], $this->font_files[$family][FS_NORMAL]);
        Severity: Minor
        Found in src/text/TTF.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 '\Amenadiel\JpGraph\Util\JpGraphError' in method 'File'.
        Open

                        Util\JpGraphError::RaiseL(25048, $fam); //("Unknown font style specification [$fam].");
        Severity: Minor
        Found in src/text/TTF.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 local variables such as '$jpgraph_font_dir'.
        Open

                $jpgraph_font_dir = dirname(dirname(__FILE__)) . '/fonts/';
        Severity: Minor
        Found in src/text/TTF.php by phpmd

        UnusedLocalVariable

        Since: 0.2

        Detects when a local variable is declared and/or assigned, but not used.

        Example

        class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

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

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

                $ff = @$fam[$style];
        Severity: Minor
        Found in src/text/TTF.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

        Method name "TTF::SetUserFont3" is not in camel caps format
        Open

            public function SetUserFont3($aNormal, $aBold = '', $aItalic = '', $aBoldIt = '')
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Method name "TTF::SetUserFont2" is not in camel caps format
        Open

            public function SetUserFont2($aNormal, $aBold = '', $aItalic = '', $aBoldIt = '')
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Method name "TTF::SetUserFont" is not in camel caps format
        Open

            public function SetUserFont($aNormal, $aBold = '', $aItalic = '', $aBoldIt = '')
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Method name "TTF::File" is not in camel caps format
        Open

            public function File($family, $style = FS_NORMAL, $font_path = null)
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Method name "TTF::SetUserFont1" is not in camel caps format
        Open

            public function SetUserFont1($aNormal, $aBold = '', $aItalic = '', $aBoldIt = '')
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        The 'getFullPathIfExists()' method which returns a boolean should be named 'is...()' or 'has...()'
        Open

            private static function getFullPathIfExists($font_file, $font_path = '')
    {
        $full_path = sprintf('%s%s', $font_path, $font_file);

        if (file_exists($full_path) && is_readable($full_path)) {
        Severity: Minor
        Found in src/text/TTF.php by phpmd

        BooleanGetMethodName

        Since: 0.2

        Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.

        Example

        class Foo {
    /**
     * @return boolean
     */
    public function getFoo() {} // bad
    /**
     * @return bool
     */
    public function isFoo(); // ok
    /**
     * @return boolean
     */
    public function getFoo($bar); // ok, unless checkParameterizedMethods=true
}

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

        Line exceeds 120 characters; contains 318 characters
        Open

                    Util\JpGraphError::RaiseL(25046, $family); //("Specified TTF font family (id=$family) is unknown or does not exist. Please note that TTF fonts are not distributed with JpGraph for copyright reasons. You can find the MS TTF WEB-fonts (arial, courier etc) for download at http://corefonts.sourceforge.net/");
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line exceeds 120 characters; contains 126 characters
        Open

                    //Util\JpGraphError::RaiseL(25049, $font_file); //("Font file \"$font_file\" is not readable or does not exist.");
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line exceeds 120 characters; contains 128 characters
        Open

             * @example ` $ttf->File(FF_DV_SANSSERIF, FS_BOLD); // would return <self::LIBRARY ROOT>/self::src/fonts/DejaVuSans-Bold-ttf
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line exceeds 120 characters; contains 133 characters
        Open

                    //('Style "'.$this->style_names[$style].'" is not available for font family '.$this->font_files[$family][FS_NORMAL].'.');
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line indented incorrectly; expected at least 12 spaces, found 8
        Open

                ];
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line indented incorrectly; expected at least 12 spaces, found 8
        Open

                ];
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line indented incorrectly; expected at least 12 spaces, found 8
        Open

                ];
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        Line indented incorrectly; expected at least 12 spaces, found 8
        Open

                ];
        Severity: Minor
        Found in src/text/TTF.php by phpcodesniffer

        There are no issues that match your filters.

        Category
        Status