b2pweb / bdf-form

src/Phone/PhoneChildBuilder.php

<?php

namespace Bdf\Form\Phone;

use Bdf\Form\Child\ChildBuilder;
use Bdf\Form\ElementBuilderInterface;
use Bdf\Form\Phone\Transformer\PhoneNumberToStringTransformer;
use Bdf\Form\Registry\RegistryInterface;
use libphonenumber\PhoneNumberFormat;

/**
 * @extends ChildBuilder<PhoneElementBuilder>
 */
class PhoneChildBuilder extends ChildBuilder
{
    /**
     * @var PhoneNumberFormat::*|null
     */
    private $saveFormat;

    /**
     * @var bool
     */
    private $formatIfInvalid = false;

    /**
     * {@inheritdoc}
     *
     * @param PhoneElementBuilder $elementBuilder
     */
    public function __construct(string $name, ElementBuilderInterface $elementBuilder, RegistryInterface $registry = null)
    {
        parent::__construct($name, $elementBuilder, $registry);

        $this->addTransformerProvider([$this, 'provideModelTransformer']);
    }

    /**
     * Format the phone number even if it's invalid
     * If not, the raw input value will be used instead of the formatted one
     *
     * Note: Works only if `saveAsString()` is called
     *
     * @param bool $formatIfInvalid
     *
     * @return $this
     *
     * @see PhoneChildBuilder::saveAsString() To enable string formating when filling the entity
     */
    public function formatIfInvalid(bool $formatIfInvalid = true): self
    {
        $this->formatIfInvalid = $formatIfInvalid;

        return $this;
    }

    /**
     * The model value of the input will be transformer to a formatted string
     *
     * <code>
     * // The entity : the phone is a simple string
     * class MyEntity {
     *     public string $phone;
     * }
     *
     * // Build the element
     * $builder->phone('phone')->saveAsString()->getter()->setter();
     *
     * $form->import(MyEntity::get($id));
     * $form['phone']->element()->value(); // Value is an instance of PhoneNumber
     *
     * $entity = $form->value();
     * $entity->phone; // phone is a string
     * </code>
     *
     * @param PhoneNumberFormat::*|null $format The phone number format. Must be one of the constant of PhoneNumberFormat. Set null to disable

The doc comment $format at position 0 could not be parsed: Unknown type name '$format' at position 0 in $format.

     *
     * @return $this
     *
     * @see PhoneNumberToStringTransformer
     */
    public function saveAsString(?int $format = PhoneNumberFormat::E164): self
    {
        $this->saveFormat = $format;

It seems like $format can also be of type integer. However, the property $saveFormat is declared as type libphonenumber\PhoneNumberFormat. Maybe add an additional type check?

        return $this;
    }

    /**
     * @return PhoneNumberToStringTransformer[]
     */
    protected function provideModelTransformer(): array
    {
        if ($this->saveFormat === null) {
            return [];
        }

        return [new PhoneNumberToStringTransformer($this->saveFormat, $this->formatIfInvalid)];

$this->saveFormat of type libphonenumber\PhoneNumberFormat is incompatible with the type integer expected by parameter $format of Bdf\Form\Phone\Transformer\PhoneNumberToStringTransformer::__construct().

    }
}