ValueFacet.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Solarium package.
 *
 * For the full copyright and license information, please view the COPYING
 * file that was distributed with this source code.
 */

namespace Solarium\Component\Analytics\Facet;

use Solarium\Component\Analytics\Facet\Sort\Sort;

/**
 * Value Facet.
 *
 * @author wicliff <wicliff.wolda@gmail.com>
 */
class ValueFacet extends AbstractFacet
{
    use ObjectTrait;

    private string $expression;

    private ?Sort $sort;

    /**
     * {@inheritdoc}
     */
    public function getType(): string
    {
        return AbstractFacet::TYPE_VALUE;
    }

    /**
     * @return string
     */
    public function getExpression(): string
    {
        return $this->expression;
    }

    /**
     * @param string $expression
     *
     * @return self Provides fluent interface
     */
    public function setExpression(string $expression): self
    {
        $this->expression = $expression;

        return $this;
    }

    /**
     * @return Sort|null
     */
    public function getSort(): ?Sort
    {
        return $this->sort;
    }

    /**
     * @param Sort|array|null $sort
     *
     * @return self Provides fluent interface
     */
    public function setSort(Sort|array|null $sort): self
    {
        $this->sort = $this->ensureObject(Sort::class, $sort);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function jsonSerialize(): mixed
    {
        return array_filter([
            'type' => $this->getType(),
            'expression' => $this->expression,
            'sort' => $this->sort,
        ]);
    }
}