Zenstruck\Browser\Dom\Field\ChoiceFormField

Complexity

Total Complexity

28

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	isDisabled()	0	3	1
A	isMultiple()	0	3	1
A	hasValue()	0	3	1
B	setValue()	0	28	10
A	availableOptionValues()	0	3	1
A	getType()	0	3	1
A	select()	0	3	1
A	getLabel()	0	3	1
A	attr()	0	3	1
A	getValue()	0	3	1
A	is()	0	3	1
A	__construct()	0	5	1
A	untick()	0	7	2
A	containsOption()	0	3	1
A	tick()	0	9	2
A	getName()	0	3	1
A	disableValidation()	0	5	1

<?php

namespace Zenstruck\Browser\Dom\Field;

use Facebook\WebDriver\Exception\NoSuchElementException;
use Facebook\WebDriver\WebDriverSelect;
use Symfony\Component\DomCrawler\Field\ChoiceFormField as BaseChoiceFormField;
use Symfony\Component\Panther\DomCrawler\Crawler as PantherCrawler;
use Zenstruck\Browser\Dom;

/**
 * @author Kevin Bond <kevinbond@gmail.com>
 */
final class ChoiceFormField extends BaseChoiceFormField
{
    private BaseChoiceFormField $inner;
    private Dom $dom;

    public function __construct(BaseChoiceFormField $inner, Dom $dom)
    {
        $this->inner = $inner;
        // todo avoid need to inject crawler?
        $this->dom = $dom;
    }

    public function hasValue(): bool
    {
        return $this->inner->hasValue();
    }

    public function isDisabled(): bool
    {
        return $this->inner->isDisabled();
    }

    public function select($value): void
    {
        $this->inner->select($value);
    }

    public function tick(): void
    {
        if ($this->is('radio')) {
            $this->setValue(null);

            return;
        }

        $this->inner->tick();
    }

    public function untick(): void
    {
        if ($this->is('radio')) {
            throw new \InvalidArgumentException('Radio fields cannot be unchecked.');
        }

        $this->inner->untick();
    }

    public function setValue($value): void
    {
        if ($this->is('radio')) {
            $value = $value ?? $this->attr('value');
        }

        if (null === $value) {
            throw new \InvalidArgumentException('Value required for select form fields.');
        }

        if (\is_array($value) && !$this->isMultiple()) {
            throw new \InvalidArgumentException('Value for a single select form field cannot be an array.');
        }

        if (\is_array($value) && $this->isMultiple() && $this->dom->crawler() instanceof PantherCrawler) {
            // todo have a separate PantherCrawler to avoid the "inner" check above
            // with panther, unselect all before setting (otherwise existing selections will remain)
            (new WebDriverSelect($this->dom->getElement(0)))->deselectAll();

It seems like $this->dom->getElement(0) can also be of type Zenstruck\Browser\Dom; however, parameter $element of Facebook\WebDriver\WebDriverSelect::__construct() does only seem to accept Facebook\WebDriver\WebDriverElement, maybe add an additional type check?

The method getElement() does not exist on Zenstruck\Browser\Dom. Since you implemented __call, consider adding a @method annotation.

        }

        try {
            $this->inner->setValue($value);
        } catch (NoSuchElementException $e) {
            // try selecting by visible text
            $select = new WebDriverSelect($this->dom->getElement(0));

            foreach ((array) $value as $item) {
                $select->selectByVisibleText($item);
            }
        }
    }

    /**
     * @param array|string $type
     */
    public function is($type): bool
    {
        return \in_array($this->getType(), (array) $type, true);
    }

    public function attr(string $name): ?string
    {
        return $this->dom->attr($name);

The method attr() does not exist on Zenstruck\Browser\Dom. Since you implemented __call, consider adding a @method annotation.

The expression return $this->dom->attr($name) could return the type Zenstruck\Browser\Dom which is incompatible with the type-hinted return null|string. Consider adding an additional type-check to rule them out.

    }

    public function getType(): string
    {
        return $this->inner->getType();
    }

    public function isMultiple(): bool
    {
        return $this->inner->isMultiple();
    }

    public function containsOption($optionValue, $options): bool
    {
        return $this->inner->containsOption($optionValue, $options);
    }

    public function availableOptionValues(): array
    {
        return $this->inner->availableOptionValues();
    }

    public function disableValidation(): self
    {
        $this->inner->disableValidation();

        return $this;
    }

    public function getLabel(): ?\DOMElement
    {
        return $this->inner->getLabel();
    }

    public function getName(): string
    {
        return $this->inner->getName();
    }

    public function getValue()
    {
        return $this->inner->getValue();
    }
}