FilterableQueryTrait.php

<?php

/**
 * Copyright (C) GrizzIT, Inc. All rights reserved.
 * See LICENSE for license details.
 */

namespace Ulrack\Dbal\Sql\Component;

use Ulrack\Dbal\Common\QueryFilterGroupInterface;
use Ulrack\Dbal\Common\ParameterizedQueryComponentInterface;

trait FilterableQueryTrait
{
    /**
     * Contains the filter groups for the query.
     *
     * @var array
     */
    private $filterGroups;

    /**
     * Adds a filter group to the query.
     *
     * @param QueryFilterGroupInterface $filter
     *
     * @return void
     */
    public function addFilterGroup(QueryFilterGroupInterface $filterGroup): void
    {
        $this->filterGroups[] = $filterGroup;
    }

    /**
     * Retrieves the filter part of a query.
     *
     * @return string
     */
    public function getFilter(): string
    {
        if (empty($this->filterGroups)) {
            return '';
        }

        $filters = [];
        foreach ($this->filterGroups as $filterGroup) {
            $filters[] = $filterGroup->getFilterGroup();
        }

        return sprintf('WHERE (%s)', implode(') OR (', $filters));
    }

    /**
     * Retrieves the parameters for the filter part of a query.
     *
     * @return array
     */
    public function getFilterParameters(): array
    {
        if (empty($this->filterGroups)) {
            return [];
        }

        $parameters = [];
        foreach ($this->filterGroups as $filterGroup) {
            if ($filterGroup instanceof ParameterizedQueryComponentInterface) {
                $parameters = array_merge(
                    $parameters,
                    $filterGroup->getParameters()
                );
            }
        }

        return $parameters;
    }
}