alps-asd / app-state-diagram

src/Option.php

<?php

declare(strict_types=1);

namespace Koriym\AppStateDiagram;

use SimpleXMLElement;

use function array_values;
use function explode;
use function filter_var;
use function is_string;
use function property_exists;

use const FILTER_VALIDATE_INT;

/** @psalm-immutable */
final class Option
{
    /** @var bool */
    public $watch;

    /** @var list<string> */
    public $and;

    /** @var list<string> */
    public $or;

    /** @var string */
    public $color;

    /** @var string */
    public $mode;

    /** @var int */
    public $port;

    /** @param array<string, string|bool> $options */
    public function __construct(array $options, ?SimpleXMLElement $filter, ?int $port)
    {
        $this->watch = isset($options['w']) || isset($options['watch']);
        $this->and = $this->parseAndTag($options, $filter);
        $this->or = $this->parseOrTag($options, $filter);
        $this->color = $this->parseColor($options, $filter);
        $this->mode = $this->getMode($options);
        $this->port = $this->getPort($options, $port);
    }

    /**
     * @param array<string, string|bool> $options
     *
     * @return list<string>
     */
    private function parseAndTag(array $options, ?SimpleXMLElement $filter): array
    {
        if (isset($options['and-tag']) && is_string($options['and-tag'])) {
            return explode(',', $options['and-tag']);

The expression return explode(',', $options['and-tag']) returns the type string[] which is incompatible with the documented return type Koriym\AppStateDiagram\list.

        }

        /** @var list<string> */ // phpcs:ignore SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.InvalidFormat

        return $filter instanceof SimpleXMLElement && property_exists($filter, 'and') ? array_values((array) $filter->and) : [];

The expression return $filter instanceof SimpleXMLElement && property_exists($filter, 'and') ? array_values((array)$filter->and) : array() returns the type array which is incompatible with the documented return type Koriym\AppStateDiagram\list.

    }

    /**
     * @param array<string, string|bool> $options
     *
     * @return list<string>
     */
    private function parseOrTag(array $options, ?SimpleXMLElement $filter): array
    {
        if (isset($options['or-tag']) && is_string($options['or-tag'])) {
            return explode(',', $options['or-tag']);

The expression return explode(',', $options['or-tag']) returns the type string[] which is incompatible with the documented return type Koriym\AppStateDiagram\list.

        }

        /** @var list<string> */ // phpcs:ignore SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration.InvalidFormat

        return $filter instanceof SimpleXMLElement && property_exists($filter, 'or') ? array_values((array) $filter->or) : [];

The expression return $filter instanceof SimpleXMLElement && property_exists($filter, 'or') ? array_values((array)$filter->or) : array() returns the type array which is incompatible with the documented return type Koriym\AppStateDiagram\list.

    }

    /** @param array<string, string|bool> $options */
    private function parseColor(array $options, ?SimpleXMLElement $filter): string
    {
        if (isset($options['color']) && is_string($options['color'])) {
            return $options['color'];
        }

        return $filter instanceof SimpleXMLElement && property_exists($filter, 'color') ? (string) $filter->color : '';
    }

    /** @param array<string, string|bool> $options */
    private function getMode(array $options): string
    {
        $isMarkdown = isset($options['mode']) && $options['mode'] === DumpDocs::MODE_MARKDOWN;

        return $isMarkdown ? DumpDocs::MODE_MARKDOWN : DumpDocs::MODE_HTML;
    }

    /** @param array<string, string|bool> $options */
    private function getPort(array $options, ?int $port): int
    {
        $value = $options['port'] ?? $port;
        if ($value === null) {
            return 3000;
        }

        return filter_var(
            $value,
            FILTER_VALIDATE_INT,
            [
                'options' => [
                    'default' => 3000,
                    'min_range' => 1024,
                    'max_range' => 49151,
                ],
            ]
        );
    }
}