PhoneChildBuilder::__construct() - Code Metrics - Inspection of "Add PhoneChildBuilder::formatIfInvalid() for allow..." - b2pweb/bdf-form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 14d684...edc244 )

by Vincent

created 2021-02-26 13:52 UTC

PhoneChildBuilder::__construct() A

↳ Parent: PhoneChildBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
eloc	2
c	1
b	0
f	1
dl	0
loc	5
ccs	3
cts	3
cp	1
rs	10
cc	1
nc	1
nop	3
crap	1

<?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

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

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

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

        return [new PhoneNumberToStringTransformer($this->saveFormat, $this->formatIfInvalid)];
        return [new PhoneNumberToStringTransformer(/** @scrutinizer ignore-type */ $this->saveFormat, $this->formatIfInvalid)];
    }
}


b2pweb / bdf-form

Push — master ( 14d684...edc244 )

PhoneChildBuilder::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like