algolia / scout-extended

src/Builder.php

<?php

declare(strict_types=1);

/**
 * This file is part of Scout Extended.
 *
 * (c) Algolia Team <contact@algolia.com>
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 */

namespace Algolia\ScoutExtended;

use function func_num_args;
use function is_callable;
use Laravel\Scout\Builder as BaseBuilder;

final class Builder extends BaseBuilder
{
    /**
     * {@inheritdoc}
     *
     * @see https://github.com/algolia/scout-extended/issues/98
     */
    public function __construct($model, $query, $callback = null, $softDelete = false)
    {
        parent::__construct($model, (string) $query, $callback, $softDelete);
    }

    /**
     * Customize the search to be around a given location.
     *
     * @link https://www.algolia.com/doc/guides/geo-search/geo-search-overview
     *
     * @param float $lat Latitude of the center
     * @param float $lng Longitude of the center
     *
     * @return $this
     */
    public function aroundLatLng(float $lat, float $lng): self
    {
        return $this->with([
            'aroundLatLng' => $lat.','.$lng,
        ]);
    }

    /**
     * Count the number of items in the search results.
     *
     * @return int
     */
    public function count(): int
    {
        $raw = $this->raw();

        return array_key_exists('nbHits', $raw) ? (int) $raw['nbHits'] : 0;
    }

    /**
     * Customize the search adding a where clause.
     *
     * @param  string $field
     * @param  mixed $operator
     * @param  mixed $value
     *
     * @return $this
     */
    public function where($field, $operator, $value = null): self
    {
        // Here we will make some assumptions about the operator. If only 2 values are
        // passed to the method, we will assume that the operator is an equals sign
        // and keep going. Otherwise, we'll require the operator to be passed in.
        if (func_num_args() === 2) {
            return parent::where($field, $this->transform($operator));

The expression return parent::where($field, $this->transform($operator)) returns the type Laravel\Scout\Builder which includes types incompatible with the type-hinted return Algolia\ScoutExtended\Builder.

        }

        return parent::where($field, "$operator {$this->transform($value)}");

The expression return parent::where($field, $operator.' '.$this->transform($value)) returns the type Laravel\Scout\Builder which includes types incompatible with the type-hinted return Algolia\ScoutExtended\Builder.

    }

    /**
     * Customize the search adding a where between clause.
     *
     * @param  string $field
     * @param  array $values
     *
     * @return $this
     */
    public function whereBetween($field, array $values): self
    {
        return $this->where("$field:", "{$this->transform($values[0])} TO {$this->transform($values[1])}");
    }

    /**
     * Customize the search adding a where in clause.
     *
     * @param  string $field
     * @param  array $values
     *
     * @return $this
     */
    public function whereIn($field, array $values): self
    {
        $wheres = array_map(function ($value) use ($field) {
            return "$field={$this->transform($value)}";
        }, array_values($values));

        $this->wheres[] = $wheres;

        return $this;
    }

    /**
     * Customize the search with the provided search parameters.
     *
     * @link https://www.algolia.com/doc/api-reference/search-api-parameters
     *
     * @param array $parameters The search parameters.
     *
     * @return $this
     */
    public function with(array $parameters): self
    {
        $callback = $this->callback;

        $this->callback = function ($algolia, $query, $baseParameters) use ($parameters, $callback) {
            $parameters = array_merge($parameters, $baseParameters);

            if (is_callable($callback)) {
                return $callback($algolia, $query, $parameters);
            }

            return $algolia->search($query, $parameters);
        };

        return $this;
    }

    /**
     * Transform the given where value.
     *
     * @param  mixed $value
     *
     * @return mixed
     */
    private function transform($value)
    {
        /*
         * Casts carbon instances to timestamp.
         */
        if ($value instanceof \Illuminate\Support\Carbon) {
            $value = $value->getTimestamp();
        }

        return $value;
    }
}