Dynamic::createViewData() - Code Metrics - Inspection of "[WIP] Dynamic filter" - ongr-io/FilterManagerBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#185)

unknown

created 2016-08-02 11:29 UTC

Dynamic::createViewData() A

↳ Parent: Dynamic

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	3
eloc	6
nc	2
nop	0

<?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\DocumentIterator;
use ONGR\ElasticsearchDSL\Search;
use ONGR\FilterManagerBundle\Filter\FilterInterface;
use ONGR\FilterManagerBundle\Filter\FilterState;
use ONGR\FilterManagerBundle\Filter\Helper\ViewDataFactoryInterface;
use ONGR\FilterManagerBundle\Filter\Relation\RelationAwareTrait;
use ONGR\FilterManagerBundle\Filter\ViewData;
use ONGR\FilterManagerBundle\Filter\ViewData\ChoicesAwareViewData;
use ONGR\FilterManagerBundle\Search\SearchRequest;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;

/**
 * This class a dynamic filter that can change the filter, field and value per request
 */
class Dynamic implements FilterInterface, ViewDataFactoryInterface
{
    use RelationAwareTrait;

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

    /**
     * @var FilterInterface
     */
    private $filter;

    /**
     * @var FilterInterface[]
     */
    private $filters;

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

    /**
     * @var array
     */
    private $tags = [];

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

        if (isset($value) && is_array($value)) {
            if (!isset($value['field']) || !isset($value['filter'])) {
                throw new BadRequestHttpException(
                    '`field` and `filter` values must be provided to the dynamic filter'
                );
            }

            if (isset($this->filters[$value['filter']])) {
                $this->filter = clone $this->filters[$value['filter']];
            } else {
                throw new InvalidConfigurationException(
                    sprintf('Filter `%s`, requested in dynamic filter is not defined', $value['filter'])
                );
            }

            $this->filter->setRequestField($this->getRequestField());
            $this->filter->setField($value['field']);
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.
    }
}
            $requestValue = [];

            if (isset($value['value'])) {
                $requestValue = [
                    $this->getRequestField() => $this->urlParameters[$this->getRequestField()]['value']
                ];
            }

            $request = new Request($requestValue);
            $state = $this->filter->getState($request);
        }

        return $state;
    }

    /**
     * {@inheritdoc}
     */
    public function modifySearch(Search $search, FilterState $state = null, SearchRequest $request = null)
    {
        if ($state && $state->isActive()) {
            $this->filter->modifySearch($search, $state, $request);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function preProcessSearch(Search $search, Search $relatedSearch, FilterState $state = null)
    {
        $out = null;

        if ($this->filter) {
            $out = $this->filter->preProcessSearch($search, $relatedSearch, $state);
            $state->setUrlParameters($this->urlParameters);
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
        }

        return $out;
    }

    /**
     * {@inheritdoc}
     */
    public function getViewData(DocumentIterator $result, ViewData $data)
    {
        if ($this->filter) {
            $data = $this->filter->getViewData($result, $data);

            if ($data instanceof ChoicesAwareViewData) {
                $choices = [];
                $resetUrlParameters = $data->getResetUrlParameters();
                $resetUrlParameters[$this->getRequestField()] = $this->urlParameters[$this->getRequestField()];
                unset($resetUrlParameters[$this->getRequestField()]['value']);
                $data->setResetUrlParameters($resetUrlParameters);

                foreach ($data->getChoices() as $choice) {

                    if (isset($choice->getUrlParameters()[$this->getRequestField()])) {
                        $choiceParameters = $choice->getUrlParameters();
                        $choiceParameters[$this->getRequestField()] = $this->urlParameters[$this->getRequestField()];
                        $choiceParameters[$this->getRequestField()]['value'] =
                            $choice->getUrlParameters()[$this->getRequestField()];
                        $choice->setUrlParameters($choiceParameters);
                    }

                    $choices[] = $choice;
                }

                $data->setChoices($choices);
            }
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function createViewData()
    {
        if ($this->filter and $this->filter instanceof ViewDataFactoryInterface) {
// Logical operators have lower precedence:
$f = false or true;

// is executed like this:
($f = false) or true;


// Boolean operators have higher precedence:
$f = false || true;

// is executed like this:
$f = (false || true);
            $data = $this->filter->createViewData();
        } else {
            $data = new ViewData();
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function getTags()
    {
        return $this->tags;
    }

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

    /**
     * @return mixed
     */
    public function getRequestField()
    {
        return $this->requestField;
    }

    /**
     * @param mixed $requestField
     */
    public function setRequestField($requestField)
    {
        $this->requestField = $requestField;
    }

    /**
     * @return FilterInterface[]
     */
    public function getFilters()
    {
        return $this->filters;
    }

    /**
     * @param FilterInterface[] $filters
     */
    public function setFilters($filters)
    {
        $this->filters = $filters;
    }
}


Pull Request — master (#185)

Dynamic::createViewData() A

Complexity

Size

Duplication

Importance

Available Fixes

Logical Operators are used for Control-Flow

ongr-io / FilterManagerBundle

Pull Request — master (#185)

Dynamic::createViewData() A

Complexity

Size

Duplication

Importance

Available Fixes

Logical Operators are used for Control-Flow

Duplication Side-by-Side

Filter issues like