Spiral\Queue\Options

Complexity

Total Complexity

23

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Test Coverage

Coverage

52.17%

Importance

Changes	1
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	getQueue()	0	3	1
A	getHeaderLine()	0	3	1
A	getPriority()	0	3	1
A	onQueue()	0	6	1
A	isAutoAck()	0	3	1
A	autoAck()	0	6	1
A	getDelay()	0	3	1
A	withoutHeader()	0	9	2
A	jsonSerialize()	0	8	1
A	withQueue()	0	6	1
A	getHeader()	0	3	1
A	withHeader()	0	10	2
A	withDelay()	0	6	1
A	withAddedHeader()	0	13	3
A	hasHeader()	0	3	2
A	delayed()	0	6	1
A	withPriority()	0	6	1
A	getHeaders()	0	3	1

<?php

declare(strict_types=1);

namespace Spiral\Queue;

class Options implements OptionsInterface, \JsonSerializable
{
    /**
     * @var 0|positive-int

The doc comment 0|positive-int at position 0 could not be parsed: Unknown type name '0' at position 0 in 0|positive-int.

     */
    private int $priority = 0;
    private ?int $delay = null;
    private ?string $queue = null;
    private bool $autoAck = false;
    /**
     * @var array<non-empty-string, array<string>>

The doc comment array<non-empty-string, array<string>> at position 2 could not be parsed: Unknown type name 'non-empty-string' at position 2 in array<non-empty-string, array<string>>.

     */
    private array $headers = [];

    public function withQueue(?string $queue): self
    {
        $options = clone $this;
        $options->queue = $queue;

        return $options;
    }

    public function getQueue(): ?string
    {
        return $this->queue;
    }

    public function withDelay(?int $delay): self
    {
        $options = clone $this;
        $options->delay = $delay;

        return $options;
    }

    public function getDelay(): ?int
    {
        return $this->delay;
    }

    public function withPriority(int $priority): self
    {
        $options = clone $this;
        $options->priority = $priority;

        return $options;
    }

    public function getPriority(): int
    {
        return $this->priority;
    }

    public function autoAck(bool $autoAck = true): self
    {
        $options = clone $this;
        $options->autoAck = $autoAck;

        return $options;
    }

    public function isAutoAck(): bool
    {
        return $this->autoAck;
    }

    /**
     * @return array<non-empty-string, array<string>>

The doc comment array<non-empty-string, array<string>> at position 2 could not be parsed: Unknown type name 'non-empty-string' at position 2 in array<non-empty-string, array<string>>.

     */
    public function getHeaders(): array
    {
        return $this->headers;
    }

    /**
     * @param non-empty-string $name Header field name.

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function hasHeader(string $name): bool
    {
        return isset($this->headers[$name]) && \count($this->headers[$name]) > 0;
    }

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @return array<string>
     */
    public function getHeader(string $name): array
    {
        return $this->headers[$name] ?? [];
    }

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function getHeaderLine(string $name): string
    {
        return \implode(',', $this->getHeader($name));
    }

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string|array<non-empty-string> $value
     */
    public function withHeader(string $name, string|array $value): self
    {
        $self = clone $this;
        $self->headers[$name] = [];

        foreach ($value as $item) {
            $self->headers[$name][] = (string)$item;
        }

        return $self;
    }

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string|array<non-empty-string> $value
     */
    public function withAddedHeader(string $name, string|array $value): self
    {
        /** @var iterable<non-empty-string> $value */
        $value = \is_iterable($value) ? $value : [$value];

        /** @var array<non-empty-string> $headers */
        $headers = $this->headers[$name] ?? [];

        foreach ($value as $item) {
            $headers[] = $item;
        }

        return $this->withHeader($name, $headers);
    }

    /**
     * @param non-empty-string $name

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function withoutHeader(string $name): self
    {
        if (!isset($this->headers[$name])) {
            return $this;
        }

        $self = clone $this;
        unset($self->headers[$name]);
        return $self;
    }

    public function jsonSerialize(): array
    {
        return [
            'delay' => $this->delay,
            'queue' => $this->queue,
            'priority' => $this->priority,
            'autoAck' => $this->autoAck,
            'headers' => $this->headers,
        ];
    }

    public static function delayed(int $delay): Options
    {
        $options = new self();
        $options->delay = $delay;

        return $options;
    }

    public static function onQueue(?string $queue): Options
    {
        $options = new self();
        $options->queue = $queue;

        return $options;
    }
}