AbstractQuery::append() - Code Metrics - Inspection of "Changed namespace path to leopard." - triadev/Leopard - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — master (8cb5b2)

by Christopher

created 2018-12-17 13:11 UTC

AbstractQuery::append() A

↳ Parent: AbstractQuery

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
ccs	3
cts	3
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace Triadev\Leopard\Business\Dsl;


use ONGR\ElasticsearchDSL\BuilderInterface;
use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
use ONGR\ElasticsearchDSL\Search;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Triadev\Leopard\Busines\Dsl\Query\Specialized;
use Triadev\Leopard\Business\Dsl\Query\TermLevel;
use Triadev\Leopard\Business\Dsl\Query\Fulltext;
use Triadev\Leopard\Business\Dsl\Query\Geo;
use Triadev\Leopard\Business\Dsl\Query\Joining;
use Triadev\Leopard\Business\Dsl\Query\InnerHit;

abstract class AbstractQuery

{

    /** @var \ONGR\ElasticsearchDSL\Search */

    public $search;

    
    /** @var string */

    public $boolState = BoolQuery::MUST;
    
    /**
     * BoolQuery constructor.
     * @param Search|null $search

     */
    public function __construct(?Search $search = null)

    {
        $this->search = $search ?: new Search();

    }

    
    /**
     * To dsl
     *
     * @return array
     */
    public function toDsl() : array
    {
        return $this->search->toArray();
    }

    
    /**
     * Get search
     *
     * @return Search
     */
    public function getSearch() : Search
    {
        return $this->search;
    }

    
    /**
     * Get query
     *
     * @return BuilderInterface
     */
    public function getQuery() : BuilderInterface
    {
        return $this->search->getQueries();
    }

    
    /**
     * Append
     *
     * @param BuilderInterface $query

     * @return AbstractQuery|TermLevel|Fulltext|Geo|\Triadev\Leopard\Business\Dsl\Search|Joining|Specialized|InnerHit

     */
    public function append(BuilderInterface $query) : AbstractQuery
    {
        $this->search->addQuery($query, $this->boolState);
        return $this;
    }

    
    /**
     * Bool state: must
     *
     * @return AbstractQuery|TermLevel|Fulltext|Geo|\Triadev\Leopard\Business\Dsl\Search|Joining|Specialized|InnerHit

     */
    public function must(): AbstractQuery
    {
        $this->boolState = BoolQuery::MUST;
        return $this;
    }

    
    /**
     * Bool state: must not
     *
     * @return AbstractQuery|TermLevel|Fulltext|Geo|\Triadev\Leopard\Business\Dsl\Search|Joining|Specialized|InnerHit

     */
    public function mustNot(): AbstractQuery
    {
        $this->boolState = BoolQuery::MUST_NOT;
        return $this;
    }

    
    /**
     * Bool state: should
     *
     * @return AbstractQuery|TermLevel|Fulltext|Geo|\Triadev\Leopard\Business\Dsl\Search|Joining|Specialized|InnerHit

     */
    public function should(): AbstractQuery
    {
        $this->boolState = BoolQuery::SHOULD;
        return $this;
    }

    
    /**
     * Bool state: filter
     *
     * @return AbstractQuery|TermLevel|Fulltext|Geo|\Triadev\Leopard\Business\Dsl\Search|Joining|Specialized|InnerHit

     */
    public function filter(): AbstractQuery
    {
        $this->boolState = BoolQuery::FILTER;
        return $this;
    }

}



1		<?php
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The PHP open tag does not have a corresponding PHP close tag Loading history...
2		namespace Triadev\Leopard\Business\Dsl;
		0 ignored issues – show Coding Style introduced 2018-12-17 12:41 UTC by Report Bug Copy Issue Report Missing file doc comment Loading history...
3
4		use ONGR\ElasticsearchDSL\BuilderInterface;
5		use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
6		use ONGR\ElasticsearchDSL\Search;
		0 ignored issues – show Bug introduced 2018-12-17 12:41 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Triadev\Leopard\Business\Dsl\Search`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7		use Triadev\Leopard\Busines\Dsl\Query\Specialized;
8		use Triadev\Leopard\Business\Dsl\Query\TermLevel;
9		use Triadev\Leopard\Business\Dsl\Query\Fulltext;
10		use Triadev\Leopard\Business\Dsl\Query\Geo;
11		use Triadev\Leopard\Business\Dsl\Query\Joining;
12		use Triadev\Leopard\Business\Dsl\Query\InnerHit;
13
14		abstract class AbstractQuery
		0 ignored issues – show Coding Style Documentation introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
15		{
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Opening brace should be on the same line as the declaration for class AbstractQuery Loading history...
16		/** @var \ONGR\ElasticsearchDSL\Search */
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
17		public $search;
		1 ignored issue – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before member var; 0 found Loading history...
18
19		/** @var string */
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Missing short description in doc comment Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
20		public $boolState = BoolQuery::MUST;
21
22		/**
23		* BoolQuery constructor.
24		* @param Search\|null $search
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report There must be exactly one blank line before the tags in a doc comment Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history...
25		*/
26	35	public function __construct(?Search $search = null)
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines before function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Incorrect spacing between argument "$search" and equals sign; expected 0 but found 1 Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Incorrect spacing between default value and equals sign for argument "$search"; expected 0 but found 1 Loading history...
27		{
28	35	$this->search = $search ?: new Search();
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report The value of a comparison must not be assigned to a variable Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Inline IF statements are not allowed Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Inline shorthand IF statement requires brackets around comparison Loading history...
29	35	}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end __construct() Loading history...
30
31		/**
32		* To dsl
33		*
34		* @return array
35		*/
36	32	public function toDsl() : array
37		{
38	32	return $this->search->toArray();
39		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end toDsl() Loading history...
40
41		/**
42		* Get search
43		*
44		* @return Search
45		*/
46	4	public function getSearch() : Search
47		{
48	4	return $this->search;
49		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end getSearch() Loading history...
50
51		/**
52		* Get query
53		*
54		* @return BuilderInterface
55		*/
56	11	public function getQuery() : BuilderInterface
57		{
58	11	return $this->search->getQueries();
59		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end getQuery() Loading history...
60
61		/**
62		* Append
63		*
64		* @param BuilderInterface $query
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Missing parameter comment Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Tag value indented incorrectly; expected 2 spaces but found 1 Loading history...
65		* @return AbstractQuery\|TermLevel\|Fulltext\|Geo\|\Triadev\Leopard\Business\Dsl\Search\|Joining\|Specialized\|InnerHit
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Tag cannot be grouped with parameter tags in a doc comment Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 117 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
66		*/
67	31	public function append(BuilderInterface $query) : AbstractQuery
68		{
69	31	$this->search->addQuery($query, $this->boolState);
70	31	return $this;
71		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end append() Loading history...
72
73		/**
74		* Bool state: must
75		*
76		* @return AbstractQuery\|TermLevel\|Fulltext\|Geo\|\Triadev\Leopard\Business\Dsl\Search\|Joining\|Specialized\|InnerHit
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 117 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
77		*/
78	3	public function must(): AbstractQuery
79		{
80	3	$this->boolState = BoolQuery::MUST;
81	3	return $this;
82		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end must() Loading history...
83
84		/**
85		* Bool state: must not
86		*
87		* @return AbstractQuery\|TermLevel\|Fulltext\|Geo\|\Triadev\Leopard\Business\Dsl\Search\|Joining\|Specialized\|InnerHit
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 117 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
88		*/
89	1	public function mustNot(): AbstractQuery
90		{
91	1	$this->boolState = BoolQuery::MUST_NOT;
92	1	return $this;
93		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end mustNot() Loading history...
94
95		/**
96		* Bool state: should
97		*
98		* @return AbstractQuery\|TermLevel\|Fulltext\|Geo\|\Triadev\Leopard\Business\Dsl\Search\|Joining\|Specialized\|InnerHit
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 117 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
99		*/
100	1	public function should(): AbstractQuery
101		{
102	1	$this->boolState = BoolQuery::SHOULD;
103	1	return $this;
104		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 1 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end should() Loading history...
105
106		/**
107		* Bool state: filter
108		*
109		* @return AbstractQuery\|TermLevel\|Fulltext\|Geo\|\Triadev\Leopard\Business\Dsl\Search\|Joining\|Specialized\|InnerHit
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 100 characters; contains 117 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
110		*/
111	7	public function filter(): AbstractQuery
112		{
113	7	$this->boolState = BoolQuery::FILTER;
114	7	return $this;
115		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 2 blank lines after function; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected 1 blank line before closing function brace; 0 found Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end filter() Loading history...
116		}
		0 ignored issues – show Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report Expected //end class Loading history... Coding Style introduced 2018-12-17 12:25 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
117

triadev / Leopard

Branch — master (8cb5b2)

AbstractQuery::append() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like