JClaveau\LogicalFilter\Rule\NotInRule

Complexity

Total Complexity

24

Size/Duplication

Total Lines	163
Duplicated Lines	12.88 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

65.66%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isNormalizationAllowed()	0	9	2
A	getField()	0	12	2
A	setField()	0	12	2
A	getPossibilities()	0	9	2
B	setPossibilities()	6	27	6
A	getValues()	0	4	1
A	hasSolution()	0	4	1
A	toArray()	0	22	5
A	toString()	15	15	2

<?php
namespace JClaveau\LogicalFilter\Rule;

/**
 * a ! in x
 */
class NotInRule extends NotRule
{
    /** @var string operator */
    const operator = '!in';

    /**
     * @param string $field The field to apply the rule on.
     * @param array  $value The value the field can equal to.

There is no parameter named $value. Was it maybe removed?

     */
    public function __construct( $field, $possibilities )
    {
        $this->addOperand(new InRule($field, $possibilities));
    }

    /**
     */
    public function isNormalizationAllowed(array $contextual_options=[])
    {
        $operand = $this->getOperandAt(0);
        if ( ! $operand->getPossibilities()) {
            return false;
        }

        return $operand->isNormalizationAllowed($contextual_options);
    }

    /**
     */
    public function getField()
    {
        if ( ! $this->getOperandAt(0)) {
            // TODO a NotRule with no operand should be simplified as
            //      a TrueRule
            throw new \LogicException(
                "Trying to get the field of a negation missing its operand"
            );
        }

        return $this->getOperandAt(0)->getField();

It seems like you code against a specific sub-type and not the parent class JClaveau\LogicalFilter\Rule\AbstractRule as the method getField() does only exist in the following sub-classes of JClaveau\LogicalFilter\Rule\AbstractRule: JClaveau\LogicalFilter\Rule\AboveOrEqualRule, JClaveau\LogicalFilter\Rule\AboveRule, JClaveau\LogicalFilter\Rule\AbstractAtomicRule, JClaveau\LogicalFilter\Rule\BelowOrEqualRule, JClaveau\LogicalFilter\Rule\BelowRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualBothRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualLowerRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualUpperRule, JClaveau\LogicalFilter\Rule\BetweenRule, JClaveau\LogicalFilter\Rule\EqualRule, JClaveau\LogicalFilter\Rule\InRule, JClaveau\LogicalFilter\Rule\NotEqualRule, JClaveau\LogicalFilter\Rule\NotInRule, JClaveau\LogicalFilter\Rule\RegexpRule. Maybe you want to instanceof check for one of these explicitly?

    }

    /**
     */
    public function setField($field)
    {
        if ( ! $this->getOperandAt(0)) {
            // TODO a NotRule with no operand should be simplified as
            //      a TrueRule
            throw new \LogicException(
                "Trying to get the field of a negation missing its operand"
            );
        }

        return $this->getOperandAt(0)->getField($field);

It seems like you code against a specific sub-type and not the parent class JClaveau\LogicalFilter\Rule\AbstractRule as the method getField() does only exist in the following sub-classes of JClaveau\LogicalFilter\Rule\AbstractRule: JClaveau\LogicalFilter\Rule\AboveOrEqualRule, JClaveau\LogicalFilter\Rule\AboveRule, JClaveau\LogicalFilter\Rule\AbstractAtomicRule, JClaveau\LogicalFilter\Rule\BelowOrEqualRule, JClaveau\LogicalFilter\Rule\BelowRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualBothRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualLowerRule, JClaveau\LogicalFilter\Rule\BetweenOrEqualUpperRule, JClaveau\LogicalFilter\Rule\BetweenRule, JClaveau\LogicalFilter\Rule\EqualRule, JClaveau\LogicalFilter\Rule\InRule, JClaveau\LogicalFilter\Rule\NotEqualRule, JClaveau\LogicalFilter\Rule\NotInRule, JClaveau\LogicalFilter\Rule\RegexpRule. Maybe you want to instanceof check for one of these explicitly?

    }

    /**
     * @return array
     */
    public function getPossibilities()
    {
        if ($this->getOperandAt(0) instanceof EqualRule) {
            // In can be simplified in =
            return [$this->getOperandAt(0)->getValue()];
        }

        return $this->getOperandAt(0)->getPossibilities();

It seems like you code against a specific sub-type and not the parent class JClaveau\LogicalFilter\Rule\AbstractRule as the method getPossibilities() does only exist in the following sub-classes of JClaveau\LogicalFilter\Rule\AbstractRule: JClaveau\LogicalFilter\Rule\InRule, JClaveau\LogicalFilter\Rule\NotInRule. Maybe you want to instanceof check for one of these explicitly?

    }

    /**
     * @return $this
     */
    public function setPossibilities($possibilities)
    {
        if (    is_object($possibilities)

This code seems to be duplicated across your project.

            && $possibilities instanceof \IteratorAggregate
            && method_exists($possibilities, 'toArray')
        ) {
            $possibilities = $possibilities->toArray();
        }

        if ($this->getOperandAt(0) instanceof EqualRule) {
            // TODO this case should occure anymore while a NotInRule
            // may not have the same class once simplified
            $possibilities[] = $this->getOperandAt(0)->getValue();

            $operands = [
                new InRule(
                    $this->getOperandAt(0)->getField(),
                    array_unique($possibilities)
                ),
            ];

            $this->setOperands($operands);
        }
        elseif ($this->getOperandAt(0) instanceof InRule) {
            return $this->getOperandAt(0)->setPossibilities($possibilities);
        }
    }

    /**
     */
    public function getValues()
    {
        return $this->getPossibilities();
    }

    /**
     */
    public function hasSolution(array $contextual_options=[])
    {
        return true;
    }

    /**
     * @param array $options   + show_instance=false Display the operator of the rule or its instance id
     *
     * @return array
     */
    public function toArray(array $options=[])
    {
        $default_options = [
            'show_instance' => false,
        ];
        foreach ($default_options as $default_option => &$default_value) {
            if ( ! isset($options[ $default_option ])) {
                $options[ $default_option ] = $default_value;
            }
        }

        try {
            return [
                $this->getField(),
                $options['show_instance'] ? $this->getInstanceId() : self::operator,
                $this->getPossibilities(),
            ];
        }
        catch (\LogicException $e) {
            return parent::toArray();
        }
    }

    /**
     * @todo cache support
     */
    public function toString(array $options=[])

This method seems to be duplicated in your project.

    {
        try {
            $operator = self::operator;

            $stringified_possibilities = '[' . implode(', ', array_map(function($possibility) {
                return var_export($possibility, true);
            }, $this->getPossibilities()) ) .']';

            return "['{$this->getField()}', '$operator', $stringified_possibilities]";
        }
        catch (\LogicException $e) {
            return parent::toString();
        }
    }

    /**/
}