olvlvl / elasticsearch-dsl

lib/Query/Compound/BoolQuery.php

<?php

namespace olvlvl\ElasticsearchDSL\Query\Compound;

use ICanBoogie\Accessor\AccessorTrait;
use olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery\FilterQuery;
use olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery\MustNotQuery;
use olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery\MustQuery;
use olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery\ShouldQuery;
use olvlvl\ElasticsearchDSL\Query\Option\BoostOption;
use olvlvl\ElasticsearchDSL\Query\Option\HasBoostOption;
use olvlvl\ElasticsearchDSL\Query\QueryAbstract;

/**
 * @property-read FilterQuery $filter
 * @property-read MustQuery $must
 * @property-read ShouldQuery $should
 * @property-read MustNotQuery $must_not
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-bool-query.html
 */
class BoolQuery extends QueryAbstract implements HasBoostOption
{
	use AccessorTrait;
	use BoostOption;

	const NAME = 'bool';

	/**
	 * @var MustQuery
	 */
	private $must;

	/**
	 * @return MustQuery
	 */
	protected function get_must(): MustQuery
	{
		return $this->must;
	}

	/**
	 * @var FilterQuery
	 */
	private $filter;

	/**
	 * @return FilterQuery
	 */
	protected function get_filter(): FilterQuery
	{
		return $this->filter;
	}

	/**
	 * @var ShouldQuery
	 */
	private $should;

	/**
	 * @return ShouldQuery
	 */
	protected function get_should(): ShouldQuery
	{
		return $this->should;
	}

	/**
	 * @var MustNotQuery
	 */
	private $must_not;

	/**
	 * @return MustNotQuery
	 */
	protected function get_must_not(): MustNotQuery
	{
		return $this->must_not;
	}

	public function __construct()
	{
		$this->must = new MustQuery();

The property must is declared read-only in olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery.

		$this->filter = new FilterQuery();

The property filter is declared read-only in olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery.

		$this->should = new ShouldQuery();

The property should is declared read-only in olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery.

		$this->must_not = new MustNotQuery();

The property must_not is declared read-only in olvlvl\ElasticsearchDSL\Query\Compound\BoolQuery.

	}

	/**
	 * @param int|null $minimum_should_match
	 *
	 * @return $this
	 */
	public function minimum_should_match(?int $minimum_should_match)
	{
		$this->options[__FUNCTION__] = $minimum_should_match;

		return $this;
	}

	/**
	 * @inheritdoc
	 */
	public function jsonSerialize()
	{
		return [ static::NAME => array_filter(

			$this->must->jsonSerialize() +
			$this->filter->jsonSerialize() +
			$this->should->jsonSerialize() +
			$this->must_not->jsonSerialize()

		) + parent::jsonSerialize() ];
	}
}