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

use Couchbase\Utilities\Deprecations;
use DateTimeInterface;

class UpsertOptions
{
    private Transcoder $transcoder;
    private ?int $timeoutMilliseconds = null;
    private ?int $expirySeconds = null;
    private ?int $expiryTimestamp = null;
    private ?bool $preserveExpiry = null;
    private ?string $durabilityLevel = null;
    private ?RequestSpan $parentSpan = null;

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

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

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

    /**
     * Sets the expiry time for the document.
     *
     * @param int|DateTimeInterface $seconds the relative expiry time in seconds or DateTimeInterface object for
     *     absolute point in time
     *
     * @return UpsertOptions
     * @since 4.0.0
     */
    public function expiry($seconds): UpsertOptions
    {
        if ($seconds instanceof DateTimeInterface) {
            $this->expirySeconds = null;
            $this->expiryTimestamp = $seconds->getTimestamp();
        } else {
            $this->expiryTimestamp = null;
            $this->expirySeconds = (int)$seconds;
        }
        return $this;
    }

    /**
     * Sets whether the original expiration should be preserved (by default Replace operation updates expiration).
     *
     * @param bool $shouldPreserve if true, the expiration time will not be updated
     *
     * @return UpsertOptions
     * @since 4.0.0
     */
    public function preserveExpiry(bool $shouldPreserve): UpsertOptions
    {
        $this->preserveExpiry = $shouldPreserve;
        return $this;
    }

    /**
     * Sets the durability level to enforce when writing the document.
     *
     * @param string|int $level the durability level to enforce
     *
     * @return UpsertOptions
     * @throws Exception\InvalidArgumentException
     * @see DurabilityLevel
     * @since 4.0.0
     */
    public function durabilityLevel($level): UpsertOptions
    {
        if (gettype($level) == "integer") {
            $level = Deprecations::convertDeprecatedDurabilityLevel(__METHOD__, $level);
        }
        $this->durabilityLevel = $level;
        return $this;
    }

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

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

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

    /**
     * Delegates encoding of the document to associated transcoder
     *
     * @param UpsertOptions|null $options
     * @param                    $document
     *
     * @return array
     * @since 4.0.0
     */
    public static function encodeDocument(?UpsertOptions $options, $document): array
    {
        if ($options == null) {
            return JsonTranscoder::getInstance()->encode($document);
        }
        return $options->transcoder->encode($document);
    }

    /**
     * @internal
     */
    public static function getDurabilityLevel(?UpsertOptions $options): ?string
    {
        return $options?->durabilityLevel;
    }

    /**
     * @internal
     *
     * @param UpsertOptions|null $options
     *
     * @return array
     * @since 4.0.0
     */
    public static function export(?UpsertOptions $options): array
    {
        if ($options == null) {
            return [];
        }
        return [
            'timeoutMilliseconds' => $options->timeoutMilliseconds,
            'expirySeconds' => $options->expirySeconds,
            'expiryTimestamp' => $options->expiryTimestamp,
            'preserveExpiry' => $options->preserveExpiry,
            'durabilityLevel' => $options->durabilityLevel,
        ];
    }
}
