nepada/email-address-input

Email address form input for Nette forms.

v1.6.0 2020-06-05 12:55 UTC

This package is auto-updated.

Last update: 2020-06-11 11:23:25 UTC


README

Build Status Coverage Status Downloads this Month Latest stable

Installation

Via Composer:

$ composer require nepada/email-address-input

Option A: install form container extension method via DI extension

extensions:
    - Nepada\Bridges\EmailAddressInputDI\EmailAddressInputExtension

It will register extension method addEmailAddress($name, $label, $caseSensitive = false) to Nette\Forms\Container.

Option B: use trait in your base form/container class

You can also use EmailAddressInputMixin trait in your base form/container class to add method addEmailAddress($name, $label, $caseSensitive = false).

Example:

trait FormControls
{

    use Nepada\Bridges\EmailAddressInputForms\EmailAddressInputMixin;

    public function addContainer($name)
    {
        $control = new Container;
        $control->setCurrentGroup($this->getCurrentGroup());
        if ($this->currentGroup !== null) {
            $this->currentGroup->add($control);
        }
        return $this[$name] = $control;
    }

}

class Container extends Nette\Forms\Container
{

    use FormControls;

}

class Form extends Nette\Forms\Form
{

    use FormControls;

}

Usage

EmailAddressInput is form control that uses email address value object to represent its value (see nepada/email-address for further details). It automatically validates the user input and getValue() method always returns EmailAddress instance, or null if the input is not filled.

$emailAddressInput = $form->addEmailAddress('E-mail');

// set value using EmailAddress value object
$emailAddressInput->setValue(CaseInsensitiveEmailAddress::fromString('example@example.com'));

// set value using string with a valid email address (it is internally converted to EmailAddress value object)
$emailAddressInput->setValue('example@example.com');

// Get EmailAddress instance for example@example.com
$emailAddressInput->getValue();

// InvalidEmailAddressException is thrown
$emailAddressInput->setValue('42');

Case sensitivity

By default the input returns instance of CaseInsensitiveEmailAddress, i.e. the value object that treats the whole email address as case insensitive.

You can change this behaviour by calling EmailAddressInput::setCaseSensitive(true), or by passing $caseSensitive = true when creating the input. With enabled case sensitivity the input's value will be represented as RfcEmailAddress instance.

For further details see the readme of nepada/email-address.