AbstractAggregation - Code Metrics - ongr-io/ElasticsearchDSL - Measure and Improve Code Quality continuously with Scrutinizer

AbstractAggregation A
last analyzed 2020-02-05 16:55 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	17
lcom	1
cbo	3
dl	0
loc	151
rs	10
c	0
b	0
f	0

11 Methods

Rating	Name	Size	Complexity
	supportsNesting()	1	?
	getArray()	1	?
A	__construct()	4	1
A	setField()	6	1
A	getField()	4	1
A	addAggregation()	10	2
A	getAggregations()	8	2
A	getAggregation()	8	3
A	toArray()	17	4
A	collectNestedAggregations()	10	2
A	createBuilderBag()	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;

use ONGR\ElasticsearchDSL\BuilderBag;
use ONGR\ElasticsearchDSL\NameAwareTrait;
use ONGR\ElasticsearchDSL\NamedBuilderInterface;
use ONGR\ElasticsearchDSL\ParametersTrait;

/**
 * AbstractAggregation class.
 */
abstract class AbstractAggregation implements NamedBuilderInterface
{
    use ParametersTrait;
    use NameAwareTrait;

    /**
     * @var string
     */
    private $field;

    /**
     * @var BuilderBag
     */
    private $aggregations;

    /**
     * Abstract supportsNesting method.
     *
     * @return bool
     */
    abstract protected function supportsNesting();

    /**
     * @return array|\stdClass
     */
    abstract protected function getArray();

    /**
     * Inner aggregations container init.
     *
     * @param string $name
     */
    public function __construct($name)
    {
        $this->setName($name);
    }

    /**
     * @param string $field
     *
     * @return $this
     */
    public function setField($field)
    {
        $this->field = $field;

        return $this;
    }

    /**
     * @return string
     */
    public function getField()
    {
        return $this->field;
    }

    /**
     * Adds a sub-aggregation.
     *
     * @param AbstractAggregation $abstractAggregation
     *
     * @return $this
     */
    public function addAggregation(AbstractAggregation $abstractAggregation)
    {
        if (!$this->aggregations) {
            $this->aggregations = $this->createBuilderBag();
        }

        $this->aggregations->add($abstractAggregation);
        
        return $this;
    }

    /**
     * Returns all sub aggregations.
     *
     * @return BuilderBag[]|NamedBuilderInterface[]
     */
    public function getAggregations()
    {
        if ($this->aggregations) {
            return $this->aggregations->all();
        } else {
            return [];
        }
    }

    /**
     * Returns sub aggregation.
     * @param string $name Aggregation name to return.
     *
     * @return AbstractAggregation|NamedBuilderInterface|null
     */
    public function getAggregation($name)
    {
        if ($this->aggregations && $this->aggregations->has($name)) {
            return $this->aggregations->get($name);
        } else {
            return null;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function toArray()
    {
        $array = $this->getArray();
        $result = [
            $this->getType() => is_array($array) ? $this->processArray($array) : $array,
        ];

        if ($this->supportsNesting()) {
            $nestedResult = $this->collectNestedAggregations();

            if (!empty($nestedResult)) {
                $result['aggregations'] = $nestedResult;
            }
        }

        return $result;
    }

    /**
     * Process all nested aggregations.
     *
     * @return array
     */
    protected function collectNestedAggregations()
    {
        $result = [];
        /** @var AbstractAggregation $aggregation */
        foreach ($this->getAggregations() as $aggregation) {
            $result[$aggregation->getName()] = $aggregation->toArray();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        return $result;
    }

    /**
     * Creates BuilderBag new instance.
     *
     * @return BuilderBag
     */
    private function createBuilderBag()
    {
        return new BuilderBag();
    }
}


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;
13
14			use ONGR\ElasticsearchDSL\BuilderBag;
15			use ONGR\ElasticsearchDSL\NameAwareTrait;
16			use ONGR\ElasticsearchDSL\NamedBuilderInterface;
17			use ONGR\ElasticsearchDSL\ParametersTrait;
18
19			/**
20			* AbstractAggregation class.
21			*/
22			abstract class AbstractAggregation implements NamedBuilderInterface
23			{
24			use ParametersTrait;
25			use NameAwareTrait;
26
27			/**
28			* @var string
29			*/
30			private $field;
31
32			/**
33			* @var BuilderBag
34			*/
35			private $aggregations;
36
37			/**
38			* Abstract supportsNesting method.
39			*
40			* @return bool
41			*/
42			abstract protected function supportsNesting();
43
44			/**
45			* @return array\|\stdClass
46			*/
47			abstract protected function getArray();
48
49			/**
50			* Inner aggregations container init.
51			*
52			* @param string $name
53			*/
54			public function __construct($name)
55			{
56			$this->setName($name);
57			}
58
59			/**
60			* @param string $field
61			*
62			* @return $this
63			*/
64			public function setField($field)
65			{
66			$this->field = $field;
67
68			return $this;
69			}
70
71			/**
72			* @return string
73			*/
74			public function getField()
75			{
76			return $this->field;
77			}
78
79			/**
80			* Adds a sub-aggregation.
81			*
82			* @param AbstractAggregation $abstractAggregation
83			*
84			* @return $this
85			*/
86			public function addAggregation(AbstractAggregation $abstractAggregation)
87			{
88			if (!$this->aggregations) {
89			$this->aggregations = $this->createBuilderBag();
90			}
91
92			$this->aggregations->add($abstractAggregation);
93
94			return $this;
95			}
96
97			/**
98			* Returns all sub aggregations.
99			*
100			* @return BuilderBag[]\|NamedBuilderInterface[]
101			*/
102			public function getAggregations()
103			{
104			if ($this->aggregations) {
105			return $this->aggregations->all();
106			} else {
107			return [];
108			}
109			}
110
111			/**
112			* Returns sub aggregation.
113			* @param string $name Aggregation name to return.
114			*
115			* @return AbstractAggregation\|NamedBuilderInterface\|null
116			*/
117			public function getAggregation($name)
118			{
119			if ($this->aggregations && $this->aggregations->has($name)) {
120			return $this->aggregations->get($name);
121			} else {
122			return null;
123			}
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129			public function toArray()
130			{
131			$array = $this->getArray();
132			$result = [
133			$this->getType() => is_array($array) ? $this->processArray($array) : $array,
134			];
135
136			if ($this->supportsNesting()) {
137			$nestedResult = $this->collectNestedAggregations();
138
139			if (!empty($nestedResult)) {
140			$result['aggregations'] = $nestedResult;
141			}
142			}
143
144			return $result;
145			}
146
147			/**
148			* Process all nested aggregations.
149			*
150			* @return array
151			*/
152			protected function collectNestedAggregations()
153			{
154			$result = [];
155			/** @var AbstractAggregation $aggregation */
156			foreach ($this->getAggregations() as $aggregation) {
157			$result[$aggregation->getName()] = $aggregation->toArray();
			0 ignored issues – show Bug introduced 2019-02-18 07:57 UTC by Report Bug Copy Issue Report The method `getName` does only exist in `ONGR\ElasticsearchDSL\NamedBuilderInterface`, but not in `ONGR\ElasticsearchDSL\BuilderBag`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
158			}
159
160			return $result;
161			}
162
163			/**
164			* Creates BuilderBag new instance.
165			*
166			* @return BuilderBag
167			*/
168			private function createBuilderBag()
169			{
170			return new BuilderBag();
171			}
172			}
173

ongr-io / ElasticsearchDSL

AbstractAggregation A last analyzed 2020-02-05 16:55 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

AbstractAggregation A
last analyzed 2020-02-05 16:55 UTC