yiisoft/yii2

View on GitHub
framework/db/Schema.php

Summary

Maintainability
A
3 hrs
Test Coverage

The class Schema has 19 public methods. Consider refactoring Schema to keep number of public methods under 10.
Open

abstract class Schema extends BaseObject
{
    // The following are the supported abstract column data types.
    const TYPE_PK = 'pk';
    const TYPE_UPK = 'upk';
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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'.

Source: http://phpmd.org/rules/codesize.txt

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

abstract class Schema extends BaseObject
{
    // The following are the supported abstract column data types.
    const TYPE_PK = 'pk';
    const TYPE_UPK = 'upk';
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 0.2.5

The Weighted Method Count (WMC) of a class is a good indicator of how much time and effort is required to modify and maintain this class. The WMC metric is defined as the sum of complexities of all methods declared in a class. A large number of methods also means that this class has a greater potential impact on derived classes.

Example:

class Foo {
      public function bar() {
          if ($a == $b)  {
              if ($a1 == $b1) {
                  fiddle();
              } elseif ($a2 == $b2) {
                  fiddle();
              } else {
              }
          }
      }
      public function baz() {
          if ($a == $b) {
              if ($a1 == $b1) {
                  fiddle();
              } elseif ($a2 == $b2) {
                  fiddle();
              } else {
              }
          }
      }
      // Several other complex methods
  }

Source: http://phpmd.org/rules/codesize.txt

The class Schema has 27 non-getter- and setter-methods. Consider refactoring Schema to keep number of methods under 25.
Open

abstract class Schema extends BaseObject
{
    // The following are the supported abstract column data types.
    const TYPE_PK = 'pk';
    const TYPE_UPK = 'upk';
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 0.1

A class with too many 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'. The default was changed from 10 to 25 in PHPMD 2.3.

Source: http://phpmd.org/rules/codesize.txt

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

    protected function getTableMetadata($name, $type, $refresh)
    {
        $cache = null;
        if ($this->db->enableSchemaCache && !in_array($name, $this->db->schemaCacheExclude, true)) {
            $schemaCache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
Severity: Minor
Found in framework/db/Schema.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 class Schema has a coupling between objects value of 18. Consider to reduce the number of dependencies under 13.
Open

abstract class Schema extends BaseObject
{
    // The following are the supported abstract column data types.
    const TYPE_PK = 'pk';
    const TYPE_UPK = 'upk';
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 1.1.0

A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability

Example:

class Foo {
      /**
       * @var \foo\bar\X
       */
      private $x = null;

      /**
       * @var \foo\bar\Y
       */
      private $y = null;

      /**
       * @var \foo\bar\Z
       */
      private $z = null;

      public function setFoo(\Foo $foo) {}
      public function setBar(\Bar $bar) {}
      public function setBaz(\Baz $baz) {}

      /**
       * @return \SplObjectStorage
       * @throws \OutOfRangeException
       * @throws \InvalidArgumentException
       * @throws \ErrorException
       */
      public function process(\Iterator $it) {}

      // ...
  }

Source: http://phpmd.org/rules/design.txt

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

    public function getTableSchemas($schema = '', $refresh = false)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/cleancode.txt

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

    public function getTableSchema($name, $refresh = false)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/cleancode.txt

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

    public function getSchemaNames($refresh = false)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/cleancode.txt

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

    public function getTableNames($schema = '', $refresh = false)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/cleancode.txt

Avoid unused parameters such as '$schema'.
Open

    protected function findTableNames($schema = '')
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/unusedcode.txt

Avoid unused parameters such as '$name'.
Open

    protected function resolveTableName($name)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/unusedcode.txt

Avoid unused parameters such as '$table'.
Open

    public function findUniqueIndexes($table)
Severity: Minor
Found in framework/db/Schema.php by phpmd

Since: PHPMD 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: http://phpmd.org/rules/unusedcode.txt

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

    public function getPdoType($data)
    {
        static $typeMap = [
            // php type => PDO type
            'boolean' => \PDO::PARAM_BOOL,
Severity: Major
Found in framework/db/Schema.php and 1 other location - About 1 hr to fix
framework/db/cubrid/Schema.php on lines 331..344

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

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 unquoteSimpleTableName($name)
    {
        if (is_string($this->tableQuoteCharacter)) {
            $startingCharacter = $this->tableQuoteCharacter;
        } else {
Severity: Minor
Found in framework/db/Schema.php and 1 other location - About 45 mins to fix
framework/db/Schema.php on lines 593..601

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

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 unquoteSimpleColumnName($name)
    {
        if (is_string($this->columnQuoteCharacter)) {
            $startingCharacter = $this->columnQuoteCharacter;
        } else {
Severity: Minor
Found in framework/db/Schema.php and 1 other location - About 45 mins to fix
framework/db/Schema.php on lines 575..583

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

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

There are no issues that match your filters.

Category
Status