Bdf\Form\Leaf\BooleanElementBuilder

Complexity

Total Complexity

3

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	httpValue()	0	9	2
A	createElement()	0	3	1

<?php

namespace Bdf\Form\Leaf;

use Bdf\Form\AbstractElementBuilder;
use Bdf\Form\Aggregate\FormBuilderInterface;
use Bdf\Form\ElementInterface;
use Bdf\Form\Transformer\TransformerInterface;
use Bdf\Form\Validator\ValueValidatorInterface;
use InvalidArgumentException;

/**
 * Builder for a boolean element
 *
 * Note: `default()` method should not be used, because a "false" value is an absent value, which will use the default value, and force the value to "true"
 *       To define a default value for the view, use `value()` instead
 *
 * <code>
 * $builder->boolean('enable')->value(true);
 * </code>
 *
 * @see BooleanElement
 * @see FormBuilderInterface::boolean()
 *
 * @extends AbstractElementBuilder<BooleanElement>
 */
class BooleanElementBuilder extends AbstractElementBuilder
{
    /**
     * @var string
     */
    private $httpValue = '1';

    /**
     * Define the HTTP value used for represent the true value
     *
     * @param string $httpValue A non-empty string value. The default value is "1"
     *
     * @return $this
     *
     * @see ElementInterface::httpValue()
     */
    public function httpValue(string $httpValue): self
    {
        if (empty($httpValue)) {
            throw new InvalidArgumentException('The httpValue must be a non-empty string');
        }

        $this->httpValue = $httpValue;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    protected function createElement(ValueValidatorInterface $validator, TransformerInterface $transformer): ElementInterface
    {
        return new BooleanElement($validator, $transformer, $this->httpValue);
    }
}