<?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\Management;

use Couchbase\RequestSpan;

class CreateQueryPrimaryIndexOptions
{
    private ?int $timeoutMilliseconds = null;
    private ?string $scopeName = null;
    private ?string $collectionName = null;
    private ?string $indexName = null;
    private ?bool $ignoreIfExists = null;
    private ?int $numberOfReplicas = null;
    private ?bool $deferred = null;
    private ?RequestSpan $parentSpan = null;

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

    /**
     * @param string $scopeName
     *
     * @deprecated 'Collection.queryIndexes()' should now be used for collection-related query index operations
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function scopeName(string $scopeName): CreateQueryPrimaryIndexOptions
    {
        $this->scopeName = $scopeName;
        return $this;
    }

    /**
     * @param string $collectionName
     *
     * @deprecated 'Collection.queryIndexes()' should now be used for collection-related query index operations
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function collectionName(string $collectionName): CreateQueryPrimaryIndexOptions
    {
        $this->collectionName = $collectionName;
        return $this;
    }

    /**
     * @param string $name
     *
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function indexName(string $name): CreateQueryPrimaryIndexOptions
    {
        $this->indexName = $name;
        return $this;
    }

    /**
     * @param bool $shouldIgnore
     *
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function ignoreIfExists(bool $shouldIgnore): CreateQueryPrimaryIndexOptions
    {
        $this->ignoreIfExists = $shouldIgnore;
        return $this;
    }

    /**
     * @param int $numberOfReplicas
     *
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function numReplicas(int $numberOfReplicas): CreateQueryPrimaryIndexOptions
    {
        $this->numberOfReplicas = $numberOfReplicas;
        return $this;
    }

    /**
     * @param bool $isDeferred
     *
     * @return CreateQueryPrimaryIndexOptions
     * @since 4.0.0
     */
    public function deferred(bool $isDeferred): CreateQueryPrimaryIndexOptions
    {
        $this->deferred = $isDeferred;
        return $this;
    }

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

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

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

    /**
     * @param CreateQueryPrimaryIndexOptions|null $options
     *
     * @return array
     * @internal
     * @since 4.0.0
     */
    public static function export(?CreateQueryPrimaryIndexOptions $options): array
    {
        if ($options == null) {
            return [];
        }
        return [
            'timeoutMilliseconds' => $options->timeoutMilliseconds,
            'scopeName' => $options->scopeName,
            'collectionName' => $options->collectionName,
            'indexName' => $options->indexName,
            'ignoreIfExists' => $options->ignoreIfExists,
            'numberOfReplicas' => $options->numberOfReplicas,
            'deferred' => $options->deferred,
        ];
    }
}
