Sign upLogin

gdbots/pbjc-php

View on GitHub
Star
src/FieldDescriptor.php

Summary

Maintainability
C
1 day
Test Coverage

FieldDescriptor has 30 functions (exceeds 20 allowed). Consider refactoring.
Open

final class FieldDescriptor
{
    /**
     * Regular expression pattern for matching a valid field name.  The pattern allows
     * for camelCase fields name but snake_case is recommend.
Severity: Minor
Found in src/FieldDescriptor.php - About 3 hrs to fix

    The class FieldDescriptor has an overall complexity of 73 which is very high. The configured complexity threshold is 50.
    Open

    final class FieldDescriptor
{
    /**
     * Regular expression pattern for matching a valid field name.  The pattern allows
     * for camelCase fields name but snake_case is recommend.
    Severity: Minor
    Found in src/FieldDescriptor.php by phpmd

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

        public function __construct($name, array $parameters)
    {
        if (!$name || strlen($name) > 127 || preg_match(self::VALID_NAME_PATTERN, $name) === false) {
            throw new \InvalidArgumentException(
                sprintf(
    Severity: Minor
    Found in src/FieldDescriptor.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 __construct has 63 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public function __construct($name, array $parameters)
    {
        if (!$name || strlen($name) > 127 || preg_match(self::VALID_NAME_PATTERN, $name) === false) {
            throw new \InvalidArgumentException(
                sprintf(
    Severity: Major
    Found in src/FieldDescriptor.php - About 2 hrs to fix

      File FieldDescriptor.php has 258 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      <?php

namespace Gdbots\Pbjc;

use Gdbots\Common\Util\NumberUtils;
      Severity: Minor
      Found in src/FieldDescriptor.php - About 2 hrs to fix

        The class FieldDescriptor has 20 fields. Consider redesigning FieldDescriptor to keep the number of fields under 15.
        Open

        final class FieldDescriptor
{
    /**
     * Regular expression pattern for matching a valid field name.  The pattern allows
     * for camelCase fields name but snake_case is recommend.
        Severity: Minor
        Found in src/FieldDescriptor.php by phpmd

        TooManyFields

        Since: 0.1

        Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.

        Example

        class Person {
   protected $one;
   private $two;
   private $three;
   [... many more fields ...]
}

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

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

            private function applyNumericOptions()
    {
        if (null !== $this->min) {
            if (null !== $this->max) {
                if ($this->min > $this->max) {
        Severity: Minor
        Found in src/FieldDescriptor.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 __construct() has a Cyclomatic Complexity of 27. The configured cyclomatic complexity threshold is 10.
        Open

            public function __construct($name, array $parameters)
    {
        if (!$name || strlen($name) > 127 || preg_match(self::VALID_NAME_PATTERN, $name) === false) {
            throw new \InvalidArgumentException(
                sprintf(
        Severity: Minor
        Found in src/FieldDescriptor.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

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

                    throw new \InvalidArgumentException(
        Severity: Minor
        Found in src/FieldDescriptor.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 '194', column '23').
        Open

                    throw new \InvalidArgumentException(
        Severity: Minor
        Found in src/FieldDescriptor.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

        Avoid using static access to class '\Gdbots\Common\Util\StringUtils' in method '__construct'.
        Open

                                    StringUtils::toCamelFromSlug($parameters['type'])
        Severity: Minor
        Found in src/FieldDescriptor.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

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

                } else {
            // arbitrary string minimum range
            $this->minLength = NumberUtils::bound($this->minLength, 0, $this->type->getMaxBytes());
        }
        Severity: Minor
        Found in src/FieldDescriptor.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 using static access to class '\Gdbots\Pbjc\Enum\FieldRule' in method '__construct'.
        Open

                                    $value = FieldRule::create($value);
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Common\Util\StringUtils' in method '__construct'.
        Open

                    $classProperty = lcfirst(StringUtils::toCamelFromSlug($key));
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\Format' in method '__construct'.
        Open

                                    $value = Format::create($value);
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\FieldRule' in method 'applyFieldRule'.
        Open

                $this->rule = $this->rule ?: FieldRule::A_SINGLE_VALUE();
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Common\Util\NumberUtils' in method 'applyStringOptions'.
        Open

                    $this->minLength = NumberUtils::bound($this->minLength, 0, $this->type->getMaxBytes());
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Common\Util\NumberUtils' in method 'applyNumericOptions'.
        Open

                $this->precision = NumberUtils::bound($this->precision, 0, 65); // range 1-65 (we use 0 to ignore when generating class)
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Common\Util\NumberUtils' in method 'applyStringOptions'.
        Open

                    $this->minLength = NumberUtils::bound($this->minLength, 0, $this->maxLength);
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\Format' in method 'applyDefaults'.
        Open

                $this->format = $this->format ?: Format::UNKNOWN();
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\FieldRule' in method '__construct'.
        Open

                                if (null !== $value && in_array($value, FieldRule::values())) {
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\Format' in method '__construct'.
        Open

                                if (null !== $value && in_array($value, Format::values())) {
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Common\Util\NumberUtils' in method 'applyNumericOptions'.
        Open

                $this->scale = NumberUtils::bound($this->scale, 0, $this->precision);
        Severity: Minor
        Found in src/FieldDescriptor.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 '\Gdbots\Pbjc\Enum\Format' in method 'getFormat'.
        Open

                if ($this->format === Format::UNKNOWN()) {
        Severity: Minor
        Found in src/FieldDescriptor.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

        Line exceeds 120 characters; contains 128 characters
        Open

                $this->precision = NumberUtils::bound($this->precision, 0, 65); // range 1-65 (we use 0 to ignore when generating class)
        Severity: Minor
        Found in src/FieldDescriptor.php by phpcodesniffer

        There are no issues that match your filters.

        Category
        Status