FacetSet.php

<?php

/*
 * 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;

use Solarium\Component\Facet\Field;
use Solarium\Component\Facet\FieldValueParametersInterface;
use Solarium\Component\Facet\FieldValueParametersTrait;
use Solarium\Component\Facet\Interval;
use Solarium\Component\Facet\JsonAggregation;
use Solarium\Component\Facet\JsonQuery;
use Solarium\Component\Facet\JsonRange;
use Solarium\Component\Facet\JsonTerms;
use Solarium\Component\Facet\MultiQuery;
use Solarium\Component\Facet\Pivot;
use Solarium\Component\Facet\PivotMinCountTrait;
use Solarium\Component\Facet\Query;
use Solarium\Component\Facet\Range;
use Solarium\Component\RequestBuilder\ComponentRequestBuilderInterface;
use Solarium\Component\RequestBuilder\FacetSet as RequestBuilder;
use Solarium\Component\ResponseParser\ComponentParserInterface;
use Solarium\Component\ResponseParser\FacetSet as ResponseParser;

/**
 * FacetSet component.
 */
class FacetSet extends AbstractComponent implements FacetSetInterface, FieldValueParametersInterface
{
    use FacetSetTrait;
    use FieldValueParametersTrait;
    use PivotMinCountTrait;

    /**
     * Facet type mapping.
     */
    protected array $facetTypes = [
        FacetSetInterface::FACET_FIELD => Field::class,
        FacetSetInterface::FACET_QUERY => Query::class,
        FacetSetInterface::FACET_MULTIQUERY => MultiQuery::class,
        FacetSetInterface::FACET_RANGE => Range::class,
        FacetSetInterface::FACET_PIVOT => Pivot::class,
        FacetSetInterface::FACET_INTERVAL => Interval::class,
        FacetSetInterface::JSON_FACET_AGGREGATION => JsonAggregation::class,
        FacetSetInterface::JSON_FACET_TERMS => JsonTerms::class,
        FacetSetInterface::JSON_FACET_QUERY => JsonQuery::class,
        FacetSetInterface::JSON_FACET_RANGE => JsonRange::class,
    ];

    /**
     * Get component type.
     *
     * @return string
     */
    public function getType(): string
    {
        return ComponentAwareQueryInterface::COMPONENT_FACETSET;
    }

    /**
     * Get a requestbuilder for this query.
     *
     * @return RequestBuilder
     */
    public function getRequestBuilder(): ComponentRequestBuilderInterface
    {
        return new RequestBuilder();
    }

    /**
     * Get a response parser for this query.
     *
     * @return ResponseParser
     */
    public function getResponseParser(): ?ComponentParserInterface
    {
        return new ResponseParser();
    }

    /**
     * Allow extraction of facets without having to define
     * them on the query.
     *
     * @param bool $extract
     *
     * @return self Provides fluent interface
     */
    public function setExtractFromResponse(bool $extract): self
    {
        $this->setOption('extractfromresponse', $extract);

        return $this;
    }

    /**
     * Get the extractfromresponse option value.
     *
     * @return bool|null
     */
    public function getExtractFromResponse(): ?bool
    {
        return $this->getOption('extractfromresponse');
    }

    /**
     * Get a facet field instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return Field
     */
    public function createFacetField(string|array|null $options = null, bool $add = true): Field
    {
        return $this->createFacet(FacetSetInterface::FACET_FIELD, $options, $add);
    }

    /**
     * Get a facet query instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return Query
     */
    public function createFacetQuery(string|array|null $options = null, bool $add = true): Query
    {
        return $this->createFacet(FacetSetInterface::FACET_QUERY, $options, $add);
    }

    /**
     * Get a facet multiquery instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return MultiQuery
     */
    public function createFacetMultiQuery(string|array|null $options = null, bool $add = true): MultiQuery
    {
        return $this->createFacet(FacetSetInterface::FACET_MULTIQUERY, $options, $add);
    }

    /**
     * Get a facet range instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return Range
     */
    public function createFacetRange(string|array|null $options = null, bool $add = true): Range
    {
        return $this->createFacet(FacetSetInterface::FACET_RANGE, $options, $add);
    }

    /**
     * Get a facet pivot instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return Pivot
     */
    public function createFacetPivot(string|array|null $options = null, bool $add = true): Pivot
    {
        return $this->createFacet(FacetSetInterface::FACET_PIVOT, $options, $add);
    }

    /**
     * Get a facet interval instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return Interval
     */
    public function createFacetInterval(string|array|null $options = null, bool $add = true): Interval
    {
        return $this->createFacet(FacetSetInterface::FACET_INTERVAL, $options, $add);
    }

    /**
     * Get a json facet aggregation instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return JsonAggregation
     */
    public function createJsonFacetAggregation(string|array|null $options = null, bool $add = true): JsonAggregation
    {
        return $this->createFacet(FacetSetInterface::JSON_FACET_AGGREGATION, $options, $add);
    }

    /**
     * Get a json facet terms instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return JsonTerms
     */
    public function createJsonFacetTerms(string|array|null $options = null, bool $add = true): JsonTerms
    {
        return $this->createFacet(FacetSetInterface::JSON_FACET_TERMS, $options, $add);
    }

    /**
     * Get a json facet query instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return JsonQuery
     */
    public function createJsonFacetQuery(string|array|null $options = null, bool $add = true): JsonQuery
    {
        return $this->createFacet(FacetSetInterface::JSON_FACET_QUERY, $options, $add);
    }

    /**
     * Get a json facet range instance.
     *
     * @see FacetSetTrait::createFacet for more information on $options
     *
     * @param string|array|null $options
     * @param bool              $add
     *
     * @return JsonRange
     */
    public function createJsonFacetRange(string|array|null $options = null, bool $add = true): JsonRange
    {
        return $this->createFacet(FacetSetInterface::JSON_FACET_RANGE, $options, $add);
    }
}