# gdbots/query-parser-php

src/Builder/AbstractQueryBuilder.php

### Summary

D
2 days

#### AbstractQueryBuilder has 42 functions (exceeds 20 allowed). Consider refactoring. Open

abstract class AbstractQueryBuilder implements QueryBuilder
{
/** @var Field */
private $currentField;  Found in src/Builder/AbstractQueryBuilder.php - About 5 hrs to fix #### File AbstractQueryBuilder.php has 370 lines of code (exceeds 250 allowed). Consider refactoring. Open <?php declare(strict_types=1); namespace Gdbots\QueryParser\Builder;  Found in src/Builder/AbstractQueryBuilder.php - About 4 hrs to fix #### The class AbstractQueryBuilder has an overall complexity of 80 which is very high. The configured complexity threshold is 50. Open abstract class AbstractQueryBuilder implements QueryBuilder { /** @var Field */ private$currentField;


Found in src/Builder/AbstractQueryBuilder.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
}

#### The class AbstractQueryBuilder has 34 non-getter- and setter-methods. Consider refactoring AbstractQueryBuilder to keep number of methods under 25. Open

abstract class AbstractQueryBuilder implements QueryBuilder
{
/** @var Field */
private $currentField;  Found in src/Builder/AbstractQueryBuilder.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 #### The class AbstractQueryBuilder has 17 public methods. Consider refactoring AbstractQueryBuilder to keep number of public methods under 10. Open abstract class AbstractQueryBuilder implements QueryBuilder { /** @var Field */ private$currentField;


Found in src/Builder/AbstractQueryBuilder.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

#### Consider simplifying this complex logical expression. Open

        if ($node->useFuzzy() ||$this->supportsFullTextSearch($field->getName()) ||$node instanceof Subquery
|| $node instanceof WordRange ||$node instanceof Phrase
Found in src/Builder/AbstractQueryBuilder.php - About 1 hr to fix

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

    private function handleText(Node $node): void { if ($this->inField && !$this->supportsFullTextSearch($this->currentField->getName())) {
$this->handleTerm($node);
return;
Found in src/Builder/AbstractQueryBuilder.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"

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

    protected function queryOnFieldIsCacheable(Field $field): bool { if ($field->isOptional() || $field->useBoost()) { return false; } Found in src/Builder/AbstractQueryBuilder.php by phpmd Since: PHPMD 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;
}
}
}
}

#### The class AbstractQueryBuilder has a coupling between objects value of 19. Consider to reduce the number of dependencies under 13. Open

abstract class AbstractQueryBuilder implements QueryBuilder
{
/** @var Field */
private $currentField;  Found in src/Builder/AbstractQueryBuilder.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) {}

// ...
}

#### The method endField has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation. Open  protected function endField(Field$field, bool $cacheable = false): void Found in src/Builder/AbstractQueryBuilder.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) {
}
}

#### The method mustNotMatchTerm has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation. Open  abstract protected function mustNotMatchTerm(Node$node, ?Field $field = null, bool$cacheable = false): void;
Found in src/Builder/AbstractQueryBuilder.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) { } } #### The method startField has a boolean flag argument$cacheable, which is a certain sign of a Single Responsibility Principle violation. Open

    protected function startField(Field $field, bool$cacheable = false): void
Found in src/Builder/AbstractQueryBuilder.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) { } } #### The method mustMatchTerm has a boolean flag argument$cacheable, which is a certain sign of a Single Responsibility Principle violation. Open

    abstract protected function mustMatchTerm(Node $node, ?Field$field = null, bool $cacheable = false): void; Found in src/Builder/AbstractQueryBuilder.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) {
}
}

#### The method handleRange has a boolean flag argument $cacheable, which is a certain sign of a Single Responsibility Principle violation. Open  abstract protected function handleRange(Range$range, Field $field, bool$cacheable = false): void;
Found in src/Builder/AbstractQueryBuilder.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 {
{
{
if ($flag) { // one branch } else { // another branch } } } #### Avoid unused parameters such as '$subquery'. Open

    protected function startSubquery(Subquery $subquery, ?Field$field = null): void
Found in src/Builder/AbstractQueryBuilder.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
}
}

{
// $howdy is not used } } #### Avoid unused parameters such as '$field'. Open

    protected function endSubquery(Subquery $subquery, ?Field$field = null): void
Found in src/Builder/AbstractQueryBuilder.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
}
}

{
// $howdy is not used } } #### Avoid unused parameters such as '$field'. Open

    protected function endField(Field $field, bool$cacheable = false): void
Found in src/Builder/AbstractQueryBuilder.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
}
}

{
// $howdy is not used } } #### Avoid unused parameters such as '$cacheable'. Open

    protected function startField(Field $field, bool$cacheable = false): void
Found in src/Builder/AbstractQueryBuilder.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
}
}

{
// $howdy is not used } } #### Similar blocks of code found in 4 locations. Consider refactoring. Open  final public function addEmoticon(Emoticon$emoticon): QueryBuilder
{
if ($this->inField || null ===$this->emoticonFieldName) {
$this->handleTerm($emoticon);
return $this; Found in src/Builder/AbstractQueryBuilder.php and 3 other locations - About 1 hr to fix src/Builder/AbstractQueryBuilder.php on lines 251..267 src/Builder/AbstractQueryBuilder.php on lines 314..330 src/Builder/AbstractQueryBuilder.php on lines 335..351 ## 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 4 locations. Consider refactoring. Open  final public function addMention(Mention$mention): QueryBuilder
{
if ($this->inField || null ===$this->mentionFieldName) {
$this->handleTerm($mention);
return $this; Found in src/Builder/AbstractQueryBuilder.php and 3 other locations - About 1 hr to fix src/Builder/AbstractQueryBuilder.php on lines 251..267 src/Builder/AbstractQueryBuilder.php on lines 272..288 src/Builder/AbstractQueryBuilder.php on lines 314..330 ## 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 4 locations. Consider refactoring. Open  final public function addEmoji(Emoji$emoji): QueryBuilder
{
if ($this->inField || null ===$this->emojiFieldName) {
$this->handleTerm($emoji);
return $this; Found in src/Builder/AbstractQueryBuilder.php and 3 other locations - About 1 hr to fix src/Builder/AbstractQueryBuilder.php on lines 272..288 src/Builder/AbstractQueryBuilder.php on lines 314..330 src/Builder/AbstractQueryBuilder.php on lines 335..351 ## 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 4 locations. Consider refactoring. Open  final public function addHashtag(Hashtag$hashtag): QueryBuilder
{
if ($this->inField || null ===$this->hashtagFieldName) {
$this->handleTerm($hashtag);
return \$this;
Found in src/Builder/AbstractQueryBuilder.php and 3 other locations - About 1 hr to fix
src/Builder/AbstractQueryBuilder.php on lines 251..267
src/Builder/AbstractQueryBuilder.php on lines 272..288
src/Builder/AbstractQueryBuilder.php on lines 335..351

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