<?php

/**
 * Copyright 2014-Present Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace Couchbase;

class LookupInAllReplicasOptions
{
    private Transcoder $transcoder;
    private string $readPreference;
    private ?int $timeoutMilliseconds = null;
    private ?bool $withExpiry = null;
    private ?RequestSpan $parentSpan = null;

    /**
     * @since 4.1.6
     */
    public function __construct()
    {
        $this->transcoder = JsonTranscoder::getInstance();
        $this->readPreference = ReadPreference::NO_PREFERENCE;
    }

    /**
     * Static helper to keep code more readable
     *
     * @return LookupInAllReplicasOptions
     * @since 4.1.6
     */
    public static function build(): LookupInAllReplicasOptions
    {
        return new LookupInAllReplicasOptions();
    }

    /**
     * Sets the operation timeout in milliseconds.
     *
     * @param int $milliseconds the operation timeout to apply
     *
     * @return LookupInAllReplicasOptions
     * @since 4.1.6
     */
    public function timeout(int $milliseconds): LookupInAllReplicasOptions
    {
        $this->timeoutMilliseconds = $milliseconds;
        return $this;
    }

    /**
     * Choose how the replica nodes will be selected. By default, it has no
     * preference and will select any available replica, but it is possible to
     * prioritize or restrict to only nodes in local server group
     *
     * @see ReadPreference
     *
     * @param string $readPreference
     *
     * @return LookupInAllReplicasOptions
     * @since 4.2.6
     */
    public function readPreference(string $readPreference): LookupInAllReplicasOptions
    {
        $this->readPreference = $readPreference;
        return $this;
    }

    /**
     * Sets whether to include document expiry with the document content.
     *
     * When used this option will add one extra subdocument path into
     * the LookupIn operation. This can cause the set of subdocument paths
     * to exceed the maximum number (16) of paths allowed in a subdocument
     * operation.
     *
     * @param bool $fetchExpiry whether to include document expiry
     *
     * @return LookupInAllReplicasOptions
     * @since 4.1.6
     */
    public function withExpiry(bool $fetchExpiry): LookupInAllReplicasOptions
    {
        $this->withExpiry = $fetchExpiry;
        return $this;
    }

    /**
     * @internal
     * @return bool
     * @since 4.1.6
     */
    public function needToFetchExpiry(): bool
    {
        if ($this->withExpiry == null) {
            return false;
        }
        return $this->withExpiry;
    }

    /**
     * Associate custom transcoder with the request.
     *
     * @param Transcoder $transcoder
     *
     * @return LookupInAllReplicasOptions
     * @since 4.1.6
     */
    public function transcoder(Transcoder $transcoder): LookupInAllReplicasOptions
    {
        $this->transcoder = $transcoder;
        return $this;
    }

    /**
     * Sets the parent span.
     *
     * @param RequestSpan $parentSpan the parent span
     *
     * @return LookupInAllReplicasOptions
     * @since 4.5.0
     */
    public function parentSpan(RequestSpan $parentSpan): LookupInAllReplicasOptions
    {
        $this->parentSpan = $parentSpan;
        return $this;
    }

    /**
     * @internal
     */
    public static function getParentSpan(?LookupInAllReplicasOptions $options): ?RequestSpan
    {
        return $options?->parentSpan;
    }

    /**
     * Returns associated transcoder.
     *
     * @param LookupInAllReplicasOptions|null $options
     *
     * @return Transcoder
     * @since 4.1.6
     */
    public static function getTranscoder(?LookupInAllReplicasOptions $options): Transcoder
    {
        if ($options == null) {
            return JsonTranscoder::getInstance();
        }
        return $options->transcoder;
    }

    /**
     * @internal
     *
     * @param LookupInAllReplicasOptions|null $options
     *
     * @return array
     * @since 4.1.6
     */
    public static function export(?LookupInAllReplicasOptions $options): array
    {
        if ($options == null) {
            return [];
        }
        return [
            'timeoutMilliseconds' => $options->timeoutMilliseconds,
            'readPreference' => $options->readPreference,
        ];
    }
}
