CompositeAggregation - Code Metrics - Inspection of "Add support for size and after property into compo..." - ongr-io/ElasticsearchDSL - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#281)

by Bohuslav

created 2019-05-26 09:47 UTC

CompositeAggregation A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	11
lcom	1
cbo	3
dl	0
loc	122
rs	10
c	0
b	0
f	0

8 Methods

Rating	Name	Size	Complexity
A	__construct()	8	2
A	addSource()	8	1
A	getArray()	16	3
A	getType()	4	1
A	setSize()	4	1
A	getSize()	4	1
A	setAfter()	4	1
A	getAfter()	4	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchDSL\Aggregation\Bucketing;

use ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation;
use ONGR\ElasticsearchDSL\Aggregation\Type\BucketingTrait;
use ONGR\ElasticsearchDSL\BuilderInterface;

/**
 * Class representing composite aggregation.
 *
 * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html
 */
class CompositeAggregation extends AbstractAggregation
{
    use BucketingTrait;

    /**
     * @var BuilderInterface[]
     */
    private $sources = [];

    /**
     * @var int
     */
    private $size;

    /**
     * @var array
     */
    private $after;

    /**
     * Inner aggregations container init.
     *
     * @param string             $name
     * @param BuilderInterface[] $sources
     */
    public function __construct($name, $sources = [])
    {
        parent::__construct($name);

        foreach ($sources as $agg) {
            $this->addSource($agg);
        }
    }

    /**
     * @param BuilderInterface $agg
     *
     * @throws \LogicException
     *
     * @return self
     */
    public function addSource(BuilderInterface $agg)
    {
        $this->sources[] = [
            $agg->getName() => [ $agg->getType() => $agg->getArray() ]
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        ];

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getArray()
    {
        $array = [
            'sources' => $this->sources,
        ];

        if ($this->size !== null) {
            $array['size'] = $this->size;
        }

        if (!empty($this->after)) {
            $array['after'] = $this->after;
        }

        return $array;
    }

    /**
     * {@inheritdoc}
     */
    public function getType()
    {
        return 'composite';
    }

    /**
     * Sets size
     *
     * @param int $size Size
     *
     * @return void
     */
    public function setSize($size)
    {
        $this->size = $size;
    }

    /**
     * Returns size
     *
     * @return int
     */
    public function getSize()
    {
        return $this->size;
    }

    /**
     * Sets after
     *
     * @param array $after After
     *
     * @return void
     */
    public function setAfter(array $after)
    {
        $this->after = $after;
    }

    /**
     * Returns after
     *
     * @return array
     */
    public function getAfter()
    {
        return $this->after;
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\ElasticsearchDSL\Aggregation\Bucketing;
13
14			use ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation;
15			use ONGR\ElasticsearchDSL\Aggregation\Type\BucketingTrait;
16			use ONGR\ElasticsearchDSL\BuilderInterface;
17
18			/**
19			* Class representing composite aggregation.
20			*
21			* @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-composite-aggregation.html
22			*/
23			class CompositeAggregation extends AbstractAggregation
24			{
25			use BucketingTrait;
26
27			/**
28			* @var BuilderInterface[]
29			*/
30			private $sources = [];
31
32			/**
33			* @var int
34			*/
35			private $size;
36
37			/**
38			* @var array
39			*/
40			private $after;
41
42			/**
43			* Inner aggregations container init.
44			*
45			* @param string $name
46			* @param BuilderInterface[] $sources
47			*/
48			public function __construct($name, $sources = [])
49			{
50			parent::__construct($name);
51
52			foreach ($sources as $agg) {
53			$this->addSource($agg);
54			}
55			}
56
57			/**
58			* @param BuilderInterface $agg
59			*
60			* @throws \LogicException
61			*
62			* @return self
63			*/
64			public function addSource(BuilderInterface $agg)
65			{
66			$this->sources[] = [
67			$agg->getName() => [ $agg->getType() => $agg->getArray() ]
			0 ignored issues – show Bug introduced 2019-01-24 21:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `ONGR\ElasticsearchDSL\BuilderInterface` as the method `getName()` does only exist in the following implementations of said interface: `ONGR\ElasticsearchDSL\Ag...ion\AbstractAggregation`, `ONGR\ElasticsearchDSL\Ag...acencyMatrixAggregation`, `ONGR\ElasticsearchDSL\Ag...ateHistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ing\ChildrenAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\CompositeAggregation`, `ONGR\ElasticsearchDSL\Ag...ateHistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\DateRangeAggregation`, `ONGR\ElasticsearchDSL\Ag...ifiedSamplerAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\FilterAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\FiltersAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoDistanceAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoHashGridAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\GlobalAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\HistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\Ipv4RangeAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\MissingAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\NestedAggregation`, `ONGR\ElasticsearchDSL\Ag...keting\RangeAggregation`, `ONGR\ElasticsearchDSL\Ag...everseNestedAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\SamplerAggregation`, `ONGR\ElasticsearchDSL\Ag...ificantTermsAggregation`, `ONGR\ElasticsearchDSL\Ag...nificantTextAggregation`, `ONGR\ElasticsearchDSL\Ag...keting\TermsAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Matrix\MaxAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\AvgAggregation`, `ONGR\ElasticsearchDSL\Ag...\CardinalityAggregation`, `ONGR\ElasticsearchDSL\Ag...xtendedStatsAggregation`, `ONGR\ElasticsearchDSL\Ag...ic\GeoBoundsAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoCentroidAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\MaxAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\MinAggregation`, `ONGR\ElasticsearchDSL\Ag...centileRanksAggregation`, `ONGR\ElasticsearchDSL\Ag...\PercentilesAggregation`, `ONGR\ElasticsearchDSL\Ag...riptedMetricAggregation`, `ONGR\ElasticsearchDSL\Ag...Metric\StatsAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\SumAggregation`, `ONGR\ElasticsearchDSL\Ag...tric\TopHitsAggregation`, `ONGR\ElasticsearchDSL\Ag...c\ValueCountAggregation`, `ONGR\ElasticsearchDSL\Ag...ractPipelineAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\AvgBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...BucketScriptAggregation`, `ONGR\ElasticsearchDSL\Ag...cketSelectorAggregation`, `ONGR\ElasticsearchDSL\Ag...e\BucketSortAggregation`, `ONGR\ElasticsearchDSL\Ag...umulativeSumAggregation`, `ONGR\ElasticsearchDSL\Ag...e\DerivativeAggregation`, `ONGR\ElasticsearchDSL\Ag...dStatsBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\MaxBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\MinBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ovingAverageAggregation`, `ONGR\ElasticsearchDSL\Ag...vingFunctionAggregation`, `ONGR\ElasticsearchDSL\Ag...ntilesBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...DifferencingAggregation`, `ONGR\ElasticsearchDSL\Ag...\StatsBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\SumBucketAggregation`, `ONGR\ElasticsearchDSL\InnerHit\NestedInnerHit`, `ONGR\ElasticsearchDSL\InnerHit\ParentInnerHit`, `ONGR\ElasticsearchDSL\Suggest\Suggest`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string / public function getDisplayName(); } Loading history... Bug introduced 2019-01-24 21:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `ONGR\ElasticsearchDSL\BuilderInterface` as the method `getArray()` does only exist in the following implementations of said interface: `ONGR\ElasticsearchDSL\Ag...ion\AbstractAggregation`, `ONGR\ElasticsearchDSL\Ag...acencyMatrixAggregation`, `ONGR\ElasticsearchDSL\Ag...ateHistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ing\ChildrenAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\CompositeAggregation`, `ONGR\ElasticsearchDSL\Ag...ateHistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\DateRangeAggregation`, `ONGR\ElasticsearchDSL\Ag...ifiedSamplerAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\FilterAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\FiltersAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoDistanceAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoHashGridAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\GlobalAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\HistogramAggregation`, `ONGR\ElasticsearchDSL\Ag...ng\Ipv4RangeAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\MissingAggregation`, `ONGR\ElasticsearchDSL\Ag...eting\NestedAggregation`, `ONGR\ElasticsearchDSL\Ag...keting\RangeAggregation`, `ONGR\ElasticsearchDSL\Ag...everseNestedAggregation`, `ONGR\ElasticsearchDSL\Ag...ting\SamplerAggregation`, `ONGR\ElasticsearchDSL\Ag...ificantTermsAggregation`, `ONGR\ElasticsearchDSL\Ag...nificantTextAggregation`, `ONGR\ElasticsearchDSL\Ag...keting\TermsAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Matrix\MaxAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\AvgAggregation`, `ONGR\ElasticsearchDSL\Ag...\CardinalityAggregation`, `ONGR\ElasticsearchDSL\Ag...xtendedStatsAggregation`, `ONGR\ElasticsearchDSL\Ag...ic\GeoBoundsAggregation`, `ONGR\ElasticsearchDSL\Ag...\GeoCentroidAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\MaxAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\MinAggregation`, `ONGR\ElasticsearchDSL\Ag...centileRanksAggregation`, `ONGR\ElasticsearchDSL\Ag...\PercentilesAggregation`, `ONGR\ElasticsearchDSL\Ag...riptedMetricAggregation`, `ONGR\ElasticsearchDSL\Ag...Metric\StatsAggregation`, `ONGR\ElasticsearchDSL\Ag...n\Metric\SumAggregation`, `ONGR\ElasticsearchDSL\Ag...tric\TopHitsAggregation`, `ONGR\ElasticsearchDSL\Ag...c\ValueCountAggregation`, `ONGR\ElasticsearchDSL\Ag...ractPipelineAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\AvgBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...BucketScriptAggregation`, `ONGR\ElasticsearchDSL\Ag...cketSelectorAggregation`, `ONGR\ElasticsearchDSL\Ag...e\BucketSortAggregation`, `ONGR\ElasticsearchDSL\Ag...umulativeSumAggregation`, `ONGR\ElasticsearchDSL\Ag...e\DerivativeAggregation`, `ONGR\ElasticsearchDSL\Ag...dStatsBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\MaxBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\MinBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ovingAverageAggregation`, `ONGR\ElasticsearchDSL\Ag...vingFunctionAggregation`, `ONGR\ElasticsearchDSL\Ag...ntilesBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...DifferencingAggregation`, `ONGR\ElasticsearchDSL\Ag...\StatsBucketAggregation`, `ONGR\ElasticsearchDSL\Ag...ne\SumBucketAggregation`. Let’s take a look at an example: interface User { /* @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
68			];
69
70			return $this;
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			public function getArray()
77			{
78			$array = [
79			'sources' => $this->sources,
80			];
81
82			if ($this->size !== null) {
83			$array['size'] = $this->size;
84			}
85
86			if (!empty($this->after)) {
87			$array['after'] = $this->after;
88			}
89
90			return $array;
91			}
92
93			/**
94			* {@inheritdoc}
95			*/
96			public function getType()
97			{
98			return 'composite';
99			}
100
101			/**
102			* Sets size
103			*
104			* @param int $size Size
105			*
106			* @return void
107			*/
108			public function setSize($size)
109			{
110			$this->size = $size;
111			}
112
113			/**
114			* Returns size
115			*
116			* @return int
117			*/
118			public function getSize()
119			{
120			return $this->size;
121			}
122
123			/**
124			* Sets after
125			*
126			* @param array $after After
127			*
128			* @return void
129			*/
130			public function setAfter(array $after)
131			{
132			$this->after = $after;
133			}
134
135			/**
136			* Returns after
137			*
138			* @return array
139			*/
140			public function getAfter()
141			{
142			return $this->after;
143			}
144			}
145

ongr-io / ElasticsearchDSL

Pull Request — master (#281)

CompositeAggregation A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like