DynamicAggregate::addViewDataItem() - Code Metrics - Inspection of "Duplicate value aggregation fix" - ongr-io/FilterManagerBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#203)

unknown

created 2016-10-24 10:43 UTC

DynamicAggregate::addViewDataItem() A

↳ Parent: DynamicAggregate

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	7
nc	1
nop	3

<?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\FilterManagerBundle\Filter\Widget\Dynamic;

use ONGR\ElasticsearchBundle\Result\Aggregation\AggregationValue;
use ONGR\ElasticsearchDSL\Aggregation\FilterAggregation;
use ONGR\ElasticsearchDSL\Aggregation\NestedAggregation;
use ONGR\ElasticsearchDSL\Aggregation\TermsAggregation;
use ONGR\ElasticsearchDSL\BuilderInterface;
use ONGR\ElasticsearchDSL\Query\BoolQuery;
use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
use ONGR\ElasticsearchDSL\Query\NestedQuery;
use ONGR\ElasticsearchDSL\Query\TermQuery;
use ONGR\ElasticsearchDSL\Search;
use ONGR\ElasticsearchBundle\Result\DocumentIterator;
use ONGR\FilterManagerBundle\Filter\FilterState;
use ONGR\FilterManagerBundle\Filter\Helper\SizeAwareTrait;
use ONGR\FilterManagerBundle\Filter\Helper\ViewDataFactoryInterface;
use ONGR\FilterManagerBundle\Filter\ViewData\AggregateViewData;
use ONGR\FilterManagerBundle\Filter\ViewData;
use ONGR\FilterManagerBundle\Filter\Widget\AbstractSingleRequestValueFilter;
use ONGR\FilterManagerBundle\Filter\Helper\FieldAwareInterface;
use ONGR\FilterManagerBundle\Filter\Helper\FieldAwareTrait;
use ONGR\FilterManagerBundle\Search\SearchRequest;
use Symfony\Component\HttpFoundation\Request;

/**
 * This class provides single terms choice.
 */
class DynamicAggregate extends AbstractSingleRequestValueFilter implements

    FieldAwareInterface,

    ViewDataFactoryInterface
{
    use FieldAwareTrait;


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

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

    /**
     * @var bool
     */
    private $showZeroChoices;

    /**
     * @param array $sortType
     */
    public function setSortType($sortType)
    {
        $this->sortType = $sortType;
    }

    /**
     * @return array
     */
    public function getSortType()
    {
        return $this->sortType;
    }

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

    /**
     * @param string $nameField
     */
    public function setNameField($nameField)
    {
        $this->nameField = $nameField;
    }

    /**
     * @return bool
     */
    public function getShowZeroChoices()
    {
        return $this->showZeroChoices;
    }

    /**
     * @param bool $showZeroChoices
     */
    public function setShowZeroChoices($showZeroChoices)
    {
        $this->showZeroChoices = $showZeroChoices;
    }

    /**
     * {@inheritdoc}
     */
    public function getState(Request $request)
    {
        $state = new FilterState();
        $value = $request->get($this->getRequestField());

        if (isset($value) && is_array($value)) {
            $state->setActive(true);
            $state->setValue($value);
            $state->setUrlParameters([$this->getRequestField() => $value]);
        }

        return $state;
    }

    /**
     * {@inheritdoc}
     */
    public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null)
    {
        list($path, $field) = explode('>', $this->getField());

        if ($state && $state->isActive()) {
            $boolQuery = new BoolQuery();
            foreach ($state->getValue() as $groupName => $value) {
                $innerBoolQuery = new BoolQuery();
                $nestedQuery = new NestedQuery($path, $innerBoolQuery);
                $innerBoolQuery->add(
                    new TermQuery($field, $value)
                );
                $innerBoolQuery->add(
                    new TermQuery($this->getNameField(), $groupName)
                );
                $boolQuery->add($nestedQuery);
            }
            $search->addPostFilter($boolQuery);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function preProcessSearch(Search $search, Search $relatedSearch, FilterState $state = null)
    {
        list($path, $field) = explode('>', $this->getField());
        $filter = !empty($filter = $relatedSearch->getPostFilters()) ? $filter : new MatchAllQuery();
        $aggregation = new NestedAggregation($state->getName(), $path);
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        $nameAggregation = new TermsAggregation('name', $this->getNameField());

        $valueAggregation = new TermsAggregation('value', $field);

        $filterAggregation = new FilterAggregation($state->getName() . '-filter');

        $nameAggregation->addAggregation($valueAggregation);
        $aggregation->addAggregation($nameAggregation);
        $filterAggregation->setFilter($filter);

        if ($this->getSortType()) {
            $valueAggregation->addParameter('order', [$this->getSortType()['type'] => $this->getSortType()['order']]);
        }

        if ($state->isActive()) {
            foreach ($state->getValue() as $key => $term) {
                $terms = $state->getValue();
                unset($terms[$key]);

                $this->addSubFilterAggregation(
                    $filterAggregation,
                    $aggregation,
                    $terms,
                    $key
                );
            }
        }

        $this->addSubFilterAggregation(
            $filterAggregation,
            $aggregation,
            $state->getValue() ? $state->getValue() : [],
            'all-selected'
        );

        $search->addAggregation($filterAggregation);

        if ($this->getShowZeroChoices()) {
            $search->addAggregation($aggregation);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function createViewData()
    {
        return new AggregateViewData();
    }

    /**
     * {@inheritdoc}
     */
    public function getViewData(DocumentIterator $result, ViewData $data)
    {
        $unsortedChoices = [];
        $activeNames = $data->getState()->isActive() ? array_keys($data->getState()->getValue()) : [];
        $filterAggregations = $this->fetchAggregation($result, $data->getName(), $data->getState()->getValue());

        if ($this->getShowZeroChoices()) {
            $unsortedChoices = $this->formInitialUnsortedChoices($result, $data);
        }

        /** @var AggregationValue $bucket */
        foreach ($filterAggregations as $activeName => $filterAggregation) {
            foreach ($filterAggregation as $nameAggregation) {
                $name = $nameAggregation['key'];

                if (($name != $activeName && $activeName != 'all-selected') ||
                    ($activeName == 'all-selected' && in_array($name, $activeNames))) {
                    continue;
                }

                foreach ($nameAggregation['value']['buckets'] as $bucket) {
                    $choice = $this->createChoice($data, $name, $activeName, $bucket);

                    $unsortedChoices[$name][$bucket['key']] = $choice;
                }

                $this->addViewDataItem($data, $name, $unsortedChoices[$name]);

                unset($unsortedChoices[$name]);
            }
        }

        if ($this->getShowZeroChoices() && !empty($unsortedChoices)) {
            foreach ($unsortedChoices as $name => $choices) {
                $this->addViewDataItem($data, $name, $unsortedChoices[$name]);

            }
        }

        /** @var AggregateViewData $data */
        $data->sortItems();

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function isRelated()
    {
        return true;
    }

    /**
     * Fetches buckets from search results.
     *
     * @param DocumentIterator $result     Search results.
     * @param string           $filterName Filter name.
     * @param array            $values     Values from the state object
     *
     * @return array Buckets.
     */
    protected function fetchAggregation(DocumentIterator $result, $filterName, $values)
    {
        $data = [];
        $values = empty($values) ? [] : $values;
        $aggregation = $result->getAggregation(sprintf('%s-filter', $filterName));

        foreach ($values as $name => $value) {
            $data[$name] = $aggregation->find(sprintf('%s.%s.name', $name, $filterName));
        }

        $data['all-selected'] = $aggregation->find(sprintf('all-selected.%s.name', $filterName));

        return $data;
    }

    /**
     * A method used to add an additional filter to the aggregations
     * in preProcessSearch
     *
     * @param FilterAggregation $filterAggregation
     * @param NestedAggregation $deepLevelAggregation
     * @param array             $terms Terms of additional filter
     * @param string            $aggName
     *
     * @return BuilderInterface
     */
    protected function addSubFilterAggregation(
        $filterAggregation,
        &$deepLevelAggregation,
        $terms,
        $aggName
    ) {
        list($path, $field) = explode('>', $this->getField());
        $boolQuery = new BoolQuery();

        foreach ($terms as $groupName => $term) {

            $nestedBoolQuery = new BoolQuery();
            $nestedBoolQuery->add(new TermQuery($field, $term));
            $nestedBoolQuery->add(new TermQuery($this->getNameField(), $groupName));
            $boolQuery->add(new NestedQuery($path, $nestedBoolQuery));
        }

        $boolQuery = !empty($boolQuery->getQueries()) ? $boolQuery : new MatchAllQuery();
        $innerFilterAggregation = new FilterAggregation($aggName, $boolQuery);

        $innerFilterAggregation->addAggregation($deepLevelAggregation);
        $filterAggregation->addAggregation($innerFilterAggregation);
    }

    /**
     * @param string   $key
     * @param string   $name
     * @param ViewData $data
     * @param bool     $active True when the choice is active
     *
     * @return array
     */
    protected function getOptionUrlParameters($key, $name, ViewData $data, $active)
    {
        $value = $data->getState()->getValue();
        $parameters = $data->getResetUrlParameters();

        if (!empty($value)) {

            if ($active) {
                unset($value[array_search($key, $value)]);
                $parameters[$this->getRequestField()] = $value;

                return $parameters;
            }

            $parameters[$this->getRequestField()] = $value;
        }

        $parameters[$this->getRequestField()][$name] = $key;

        return $parameters;
    }

    /**
     * Returns whether choice with the specified key is active.
     *
     * @param string   $key
     * @param ViewData $data
     * @param string   $activeName
     *
     * @return bool
     */
    protected function isChoiceActive($key, ViewData $data, $activeName)

    {
        if ($data->getState()->isActive()) {
            $value = $data->getState()->getValue();

            if (isset($value[$activeName]) && $key == $value[$activeName]) {
                return true;
            }
        }

        return false;
    }

    /**
     * Forms $unsortedChoices array with all possible choices.
     * 0 is assigned to the document count of the choices.
     *
     * @param DocumentIterator $result
     * @param ViewData         $data
     *
     * @return array
     */
    protected function formInitialUnsortedChoices($result, $data)
    {
        $unsortedChoices = [];
        $urlParameters = array_merge(
            $data->getResetUrlParameters(),
            $data->getState()->getUrlParameters()
        );

        foreach ($result->getAggregation($data->getName())->getAggregation('name') as $nameBucket) {
            $groupName = $nameBucket['key'];

            foreach ($nameBucket->getAggregation('value') as $bucket) {
                $bucketArray = ['key' => $bucket['key'], 'doc_count' => 0];
                $choice = $this->createChoice($data, $bucket['key'], '', $bucketArray, $urlParameters);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $unsortedChoices[$groupName][$bucket['key']] = $choice;
            }
        }

        return $unsortedChoices;
    }

    /**
     * @param AggregateViewData $data
     * @param string            $name
     * @param string            $activeName
     * @param AggregationValue  $bucket
     * @param array             $urlParameters
     * @return ViewData\Choice
     */
    protected function createChoice($data, $name, $activeName, $bucket, $urlParameters = null)
    {
        $active = $this->isChoiceActive($bucket['key'], $data, $activeName);

        if (empty($urlParameters)) {
            $urlParameters = $this->getOptionUrlParameters($bucket['key'], $name, $data, $active);
        }

        $choice = new ViewData\Choice();
        $choice->setLabel($bucket['key']);
        $choice->setCount($bucket['doc_count']);
        $choice->setActive($active);
        $choice->setUrlParameters($urlParameters);

        return $choice;
    }

    /**
     * @param AggregateViewData $data
     * @param string            $name
     * @param ViewData\Choice[] $choices
     */
    protected function addViewDataItem($data, $name, $choices)
    {
        $choiceViewData = new ViewData\ChoicesAwareViewData();
        $choiceViewData->setName($name);
        $choiceViewData->setChoices($choices);
        $choiceViewData->setUrlParameters([]);
        $choiceViewData->setResetUrlParameters($data->getResetUrlParameters());
        $data->addItem($choiceViewData);
    }
}


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\FilterManagerBundle\Filter\Widget\Dynamic;
13
14			use ONGR\ElasticsearchBundle\Result\Aggregation\AggregationValue;
15			use ONGR\ElasticsearchDSL\Aggregation\FilterAggregation;
16			use ONGR\ElasticsearchDSL\Aggregation\NestedAggregation;
17			use ONGR\ElasticsearchDSL\Aggregation\TermsAggregation;
18			use ONGR\ElasticsearchDSL\BuilderInterface;
19			use ONGR\ElasticsearchDSL\Query\BoolQuery;
20			use ONGR\ElasticsearchDSL\Query\MatchAllQuery;
21			use ONGR\ElasticsearchDSL\Query\NestedQuery;
22			use ONGR\ElasticsearchDSL\Query\TermQuery;
23			use ONGR\ElasticsearchDSL\Search;
24			use ONGR\ElasticsearchBundle\Result\DocumentIterator;
25			use ONGR\FilterManagerBundle\Filter\FilterState;
26			use ONGR\FilterManagerBundle\Filter\Helper\SizeAwareTrait;
27			use ONGR\FilterManagerBundle\Filter\Helper\ViewDataFactoryInterface;
28			use ONGR\FilterManagerBundle\Filter\ViewData\AggregateViewData;
29			use ONGR\FilterManagerBundle\Filter\ViewData;
30			use ONGR\FilterManagerBundle\Filter\Widget\AbstractSingleRequestValueFilter;
31			use ONGR\FilterManagerBundle\Filter\Helper\FieldAwareInterface;
32			use ONGR\FilterManagerBundle\Filter\Helper\FieldAwareTrait;
33			use ONGR\FilterManagerBundle\Search\SearchRequest;
34			use Symfony\Component\HttpFoundation\Request;
35
36			/**
37			* This class provides single terms choice.
38			*/
39			class DynamicAggregate extends AbstractSingleRequestValueFilter implements
			0 ignored issues – show Deprecated Code introduced 2016-10-12 13:07 UTC by Report Bug Copy Issue Report The class `ONGR\FilterManagerBundle...ingleRequestValueFilter` has been deprecated with message: Will be renamed to AbstractFilter. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...

ongr-io / FilterManagerBundle

Pull Request — master (#203)

DynamicAggregate::addViewDataItem() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like