netdudes / DataSourceryBundle

Query/Filter.php

<?php
namespace Netdudes\DataSourceryBundle\Query;

use Netdudes\DataSourceryBundle\Util\AbstractArrayAccessibleCollection;

/**
 * Group of filters bundled with a condition type
 */
class Filter extends AbstractArrayAccessibleCollection implements \JsonSerializable
{
    /**
     * The filters are concatenated AND-wise
     */
    const CONDITION_TYPE_AND = 'AND';

    /**
     * The filters are concatenated OR-wise
     */
    const CONDITION_TYPE_OR = 'OR';

    /**
     * The filters are concatenated XOR-wise
     * Note: This is not currently supported by Doctrine, but left in for completeness
     */
    const CONDITION_TYPE_XOR = 'XOR';

    /**
     * Condition concatenation type, by default OR
     *
     * @var int
     */
    private $conditionType = self::CONDITION_TYPE_AND;

    /**
     * Create a FilterDefinition from a deserialized compact exchange JSON filters.
     * This wil recursively call itself to unpack the whole filter tree.
     *
     * @param $jsonSerializable
     *
     * @return array|Filter|FilterCondition
     * @throws \Exception
     * @deprecated Deprecated to be removed in 1.0.0. It seems to be unused.
     */
    public static function createFromJsonSerializable($jsonSerializable)
    {
        @trigger_error('createFromJsonSerializable() is deprecated and will be removed in 1.0.0. It seems to be unused.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        if (!count((array) $jsonSerializable)) {
            // Edge case: empty filter
            return new Filter();
        }

        if (count($jsonSerializable) == 2 && is_array($jsonSerializable[1])) {
            // Complex Filter
            $logic = $jsonSerializable[0];
            $elements = $jsonSerializable[1];
            $filter = new Filter();
            $filter->setConditionType($logic);
            foreach ($elements as $element) {
                $filter[] = static::createFromJsonSerializable($element);

The method Netdudes\DataSourceryBundle\Query\Filter::createFromJsonSerializable() has been deprecated with message: Deprecated to be removed in 1.0.0. It seems to be unused.

            }

            return $filter;
        } elseif (count($jsonSerializable) == 3) {
            // Simple element
            return new FilterCondition($jsonSerializable[0], $jsonSerializable[1], $jsonSerializable[2], $jsonSerializable[2]);
        }

        throw new \Exception('Unable to parse JSON-serializable filter structure');
    }

    public function toUQL()
    {
        $parts = [];
        foreach ($this as $filter) {
            $subFilterUql = $filter->toUQL();
            if ($filter instanceof Filter) {
                $subFilterUql = '(' . $subFilterUql . ')';
            }
            $parts[] = $subFilterUql;
        }

        return implode(" " . strtolower($this->conditionType) . " ", $parts);
    }

    /**
     * (PHP 5 &gt;= 5.4.0)<br/>
     * Specify data which should be serialized to JSON
     *
     * @link http://php.net/manual/en/jsonserializable.jsonserialize.php
     * @return mixed data which can be serialized by <b>json_encode</b>,
     *               which is a value of any type other than a resource.
     */
    public function jsonSerialize()
    {
        $serializableArray = [
            'logic' => $this->getConditionType(),
            'elements' => [],
        ];
        foreach ($this as $filter) {
            $serializableArray['elements'][] = $filter->toJsonSerializable();
        }

        return $serializableArray;
    }

    /**
     * Recursively compact into a easily JSON-serializable array
     * representation
     * @deprecated Deprecated to be removed in 1.0.0. It seems to be unused.
     */
    public function toJsonSerializable()
    {
        @trigger_error('toJsonSerializable() is deprecated and will be removed in 1.0.0. It seems to be unused.', E_USER_DEPRECATED);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        return $this->jsonSerialize();
    }

    /**
     * @return int
     */
    public function getConditionType()
    {
        return $this->conditionType;
    }

    /**
     * @param int $conditionType
     */
    public function setConditionType($conditionType)
    {
        $this->conditionType = $conditionType;
    }

    public function getAllFirstLevelFilteredDataSourceUniqueNames()
    {
        $filteredDataSourceIds = [];
        foreach ($this as $element) {
            if ($element instanceof FilterCondition) {
                $filteredDataSourceIds[] = $element->getFieldName();
            }
        }

        return $filteredDataSourceIds;
    }

    /**
     * Flatten the tree of Filters into a one-dimensional array
     * or FilterConditions.
     *
     * @return FilterCondition[]
     */
    public function getAllFilterConditionsFlat()
    {
        $flatConditionsList = [];
        $flatten = function (Filter $filterDefinition) use (&$flatConditionsList, &$flatten) {
            foreach ($filterDefinition as $filter) {
                if ($filter instanceof Filter) {
                    $flatten($filter);
                } elseif ($filter instanceof FilterCondition) {
                    $flatConditionsList[] = $filter;
                }
            }
        };
        $flatten($this);

        return $flatConditionsList;
    }
}