SearchPrimaryCondition.php

<?php

declare(strict_types=1);

/*
 * This file is part of the RollerworksSearch package.
 *
 * (c) Sebastiaan Stok <s.stok@rollerscapes.net>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Rollerworks\Component\Search;

use Rollerworks\Component\Search\Value\ValuesGroup;

/**
 * SearchPrimaryCondition contains a condition that must be fulfilled at all times.
 *
 * A SearchPrimaryCondition is applied as `(SearchPrimaryCondition) AND (SearchCondition)`.
 *
 * Caution: It's important for a QueryGenerator to always apply
 * the primary-condition even if the search-condition itself is empty!
 *
 * @author Sebastiaan Stok <s.stok@rollerscapes.net>
 */
final class SearchPrimaryCondition
{
    private $values;
    private $order;

    public function __construct(ValuesGroup $valuesGroup)
    {
        $this->values = $valuesGroup;
    }

    public function getValuesGroup(): ValuesGroup
    {
        return $this->values;
    }

    public function setOrder(?SearchOrder $order): void
    {
        $this->order = $order;
    }

    public function getOrder(): ?SearchOrder
    {
        return $this->order;
    }
}